Skip to content

Update and clarify documentation for directives and topics #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 5, 2025
Merged

Update and clarify documentation for directives and topics #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0773b2
Added and updated documentation for `directives`, `location`, and `el…
andrey-helldar Sep 5, 2025
62a5731
Updated summaries in documentation topics for clarity and consistency
andrey-helldar Sep 5, 2025
b86ee50
Merge remote-tracking branch 'origin/1.x' into 1.x
andrey-helldar Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/laravel-feeds.tree
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,13 @@
<toc-element topic="create-feeds.topic" />
<toc-element topic="generation.topic">
</toc-element>
<toc-element topic="advanced-usage.topic" />
<toc-element topic="supported-formats.topic" />
</toc-element>
<toc-element toc-title="Digging Deeper">
<toc-element topic="supported-formats.topic" />
<toc-element topic="elements.topic" />
<toc-element topic="directives.topic" />
<toc-element topic="eloquent.topic" />
<toc-element topic="location.topic" />
<toc-element topic="events.topic" />
</toc-element>
<toc-element toc-title="Receipts">
Expand Down
20 changes: 10 additions & 10 deletions docs/snippets/advanced-directive-array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<array_directive>

<user>
<name>Jaiden Gerhold</name>
<avatar>https://via.placeholder.com/640x480.png/0022dd?text=aut</avatar>
<avatar>https://via.placeholder.com/640x480.png/00ddff?text=quia</avatar>
<images name="dolorem deleniti adipisci">https://via.placeholder.com/640x480.png/004400?text=enim</images>
<images name="fugit adipisci consequatur">https://via.placeholder.com/640x480.png/0011ff?text=eveniet</images>
<name>Dr. Domenic Howell III</name>
<avatar>https://via.placeholder.com/640x480.png/00cc77?text=sed</avatar>
<avatar>https://via.placeholder.com/640x480.png/000077?text=aut</avatar>
<images name="nulla qui ipsum">https://via.placeholder.com/640x480.png/005511?text=aut</images>
<images name="ut necessitatibus cupiditate">https://via.placeholder.com/640x480.png/00dd99?text=sint</images>
</user>
<user>
<name>Darien Murazik</name>
<avatar>https://via.placeholder.com/640x480.png/007700?text=vel</avatar>
<avatar>https://via.placeholder.com/640x480.png/00ffcc?text=nulla</avatar>
<images name="labore aspernatur et">https://via.placeholder.com/640x480.png/0022aa?text=dolore</images>
<images name="consequatur ipsa nihil">https://via.placeholder.com/640x480.png/006611?text=dolorum</images>
<name>Dr. Cleveland Ryan</name>
<avatar>https://via.placeholder.com/640x480.png/001177?text=veritatis</avatar>
<avatar>https://via.placeholder.com/640x480.png/0066bb?text=dolorem</avatar>
<images name="consequuntur et veritatis">https://via.placeholder.com/640x480.png/00ffcc?text=quasi</images>
<images name="officia similique voluptatem">https://via.placeholder.com/640x480.png/00dd33?text=officia</images>
</user>

</array_directive>
10 changes: 5 additions & 5 deletions docs/snippets/advanced-directive-attributes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<attributes_directive>

<company since="1983"/>
<company since="2014"/>
<url>https://example.com</url>

<user>
<name>Estell Reinger</name>
<contact email="dorothea02@example.com" phone="555-000-1"/>
<name>Emelia Kessler</name>
<contact email="jocelyn.corwin@example.com" phone="555-000-1"/>
</user>
<user>
<name>Mrs. Marilie O'Connell DDS</name>
<contact email="arno70@example.com" phone="555-000-2"/>
<name>Mr. Gerardo Cruickshank</name>
<contact email="eliseo.hills@example.net" phone="555-000-2"/>
</user>

</attributes_directive>
8 changes: 4 additions & 4 deletions docs/snippets/advanced-directive-cdata.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<cdata_directive>

<user>
<name><![CDATA[<h1>Jay Willms MD</h1>]]></name>
<email>uerdman@example.net</email>
<name><![CDATA[<h1>Alfred Glover</h1>]]></name>
<email>crooks.makayla@example.net</email>
</user>
<user>
<name><![CDATA[<h1>Mrs. Fae Rice</h1>]]></name>
<email>kuhic.tristian@example.com</email>
<name><![CDATA[<h1>Arno Nader</h1>]]></name>
<email>ofarrell@example.org</email>
</user>

</cdata_directive>
8 changes: 4 additions & 4 deletions docs/snippets/advanced-directive-mixed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
<mixed_directive>

<user>
<name>Heath Cummerata</name>
<name>Dr. Tom Schaefer II</name>
<some>
<first>Foo</first>
<second>kasey.sawayn@example.org</second>
<second>brenna44@example.org</second>
</some>
</user>
<user>
<name>Dr. Levi Leannon</name>
<name>Vena Streich</name>
<some>
<first>Foo</first>
<second>melany.runolfsson@example.org</second>
<second>bechtelar.richmond@example.com</second>
</some>
</user>

Expand Down
8 changes: 4 additions & 4 deletions docs/snippets/advanced-directive-value.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<value_directive>

<user>
<name>Mr. Jo Emard DVM</name>
<contact type="email">carolina77@example.net</contact>
<name>Gerda Bogisich</name>
<contact type="email">allie.heidenreich@example.net</contact>
</user>
<user>
<name>Nicola Moore</name>
<contact type="email">lkuhlman@example.com</contact>
<name>Trycia Connelly</name>
<contact type="email">ole.hayes@example.net</contact>
</user>

</value_directive>
8 changes: 4 additions & 4 deletions docs/snippets/advanced-element-attribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<attribute>

<user created_at="2025-09-05T21:10:29+00:00">
<user created_at="2025-09-05T23:28:57+00:00">
<id>1</id>
<name>Candida West</name>
<name>Dr. Colin Thiel</name>
</user>
<user created_at="2025-09-05T21:10:29+00:00">
<user created_at="2025-09-05T23:28:57+00:00">
<id>2</id>
<name>Prof. Hilton Wuckert</name>
<name>Helga Auer</name>
</user>

</attribute>
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-header-footer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

<user>
<id>1</id>
<name>Daija Powlowski</name>
<name>Emmy Dickens</name>
</user>
<user>
<id>2</id>
<name>Lisa Reichel</name>
<name>Abraham Satterfield</name>
</user>

</header_footer>
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-info-before-false.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

<user>
<id>1</id>
<name>Tabitha Jakubowski</name>
<name>Vidal Runte</name>
</user>
<user>
<id>2</id>
<name>Dr. Rachel Goyette</name>
<name>Marlee Breitenberg</name>
</user>

</info_method>
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

<user>
<id>1</id>
<name>Daija Wehner Jr.</name>
<name>Mr. Milan Parker</name>
</user>
<user>
<id>2</id>
<name>Rosella Emard DDS</name>
<name>Prof. Irving Kuvalis</name>
</user>

</info_method>
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-root.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

<user>
<id>1</id>
<name>Baby McDermott DDS</name>
<name>Zechariah Greenholt</name>
</user>
<user>
<id>2</id>
<name>Rachael Jerde</name>
<name>Isaiah Hill I</name>
</user>

</foo>
48 changes: 24 additions & 24 deletions docs/snippets/receipt-instagram-feed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,46 @@

<item>
<g:id>1</g:id>
<g:title><![CDATA[aut nisi officia ut]]></g:title>
<g:description><![CDATA[Molestias et et et et voluptatem. Quisquam occaecati nostrum libero. Qui et tenetur fugiat et sint.]]></g:description>
<g:link>https://example.com/products/illo-fugiat-in-voluptatem-sunt</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/00ff55?text=debitis</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/001111?text=sequi</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00dd22?text=et</g:additional_image_link>
<g:brand>cupiditate</g:brand>
<g:title><![CDATA[quisquam reiciendis quidem ratione]]></g:title>
<g:description><![CDATA[Officia quis assumenda quibusdam ut est. Reiciendis cum nulla earum nobis adipisci. Sed temporibus quia tempore quaerat dicta aperiam.]]></g:description>
<g:link>https://example.com/products/laborum-non-autem-nemo-laboriosam-vel</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/009955?text=doloremque</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00bb00?text=voluptatem</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00bbdd?text=ut</g:additional_image_link>
<g:brand>ex</g:brand>
<g:condition>new</g:condition>
<g:availability>in stock</g:availability>
<g:price>348</g:price>
<g:sale_price>348</g:sale_price>
<g:price>103</g:price>
<g:sale_price>103</g:sale_price>
<g:item_group_id>12345</g:item_group_id>
<g:status>active</g:status>
<g:color><![CDATA[Green]]></g:color>
<g:size>45</g:size>
<g:color><![CDATA[Red]]></g:color>
<g:size>17</g:size>
<g:age_group>adult</g:age_group>
<g:material><![CDATA[non]]></g:material>
<g:material><![CDATA[aut]]></g:material>
<g:pattern><![CDATA[regular]]></g:pattern>
<g:google_product_category>1000</g:google_product_category>
<g:fb_product_category>2000</g:fb_product_category>
</item>
<item>
<g:id>2</g:id>
<g:title><![CDATA[eos sunt dolores nobis]]></g:title>
<g:description><![CDATA[Qui culpa voluptatum ab facere dicta quo. Corporis asperiores dolor inventore omnis provident quod dolor. Eius magnam delectus placeat eaque. Qui sit sed nemo et.]]></g:description>
<g:link>https://example.com/products/laboriosam-hic-facilis-earum-voluptatem-sint-sit</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/00bb77?text=autem</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00aa33?text=est</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/002266?text=et</g:additional_image_link>
<g:brand>expedita</g:brand>
<g:title><![CDATA[et voluptatibus itaque qui]]></g:title>
<g:description><![CDATA[Dolores temporibus doloremque alias nulla provident similique. Ipsa aspernatur eaque excepturi. Consequatur aut possimus iure ut.]]></g:description>
<g:link>https://example.com/products/deserunt-dicta-reiciendis-dolores-neque-mollitia</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/0088dd?text=hic</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/0011cc?text=molestiae</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00bb11?text=eum</g:additional_image_link>
<g:brand>minus</g:brand>
<g:condition>new</g:condition>
<g:availability>in stock</g:availability>
<g:price>331</g:price>
<g:sale_price>331</g:sale_price>
<g:price>990</g:price>
<g:sale_price>990</g:sale_price>
<g:item_group_id>12345</g:item_group_id>
<g:status>active</g:status>
<g:color><![CDATA[LawnGreen]]></g:color>
<g:size>46</g:size>
<g:color><![CDATA[MediumSeaGreen]]></g:color>
<g:size>23</g:size>
<g:age_group>adult</g:age_group>
<g:material><![CDATA[id]]></g:material>
<g:material><![CDATA[amet]]></g:material>
<g:pattern><![CDATA[regular]]></g:pattern>
<g:google_product_category>1000</g:google_product_category>
<g:fb_product_category>2000</g:fb_product_category>
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/receipt-sitemap-feed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9">

<url>
<loc>https://example.com/products/sunt-aut-eum-hic-enim-veritatis-libero</loc>
<loc>https://example.com/products/et-dolor-rerum-maxime-qui</loc>
<lastmod>2025-09-04T04:08:12+00:00</lastmod>
<priority>0.9</priority>
</url>
<url>
<loc>https://example.com/products/rerum-est-ipsum-est-et-alias-commodi-neque-quod</loc>
<loc>https://example.com/products/quibusdam-nisi-minima-facere-nostrum-consequatur-eligendi-natus</loc>
<lastmod>2025-09-04T04:08:12+00:00</lastmod>
<priority>0.9</priority>
</url>
Expand Down
48 changes: 24 additions & 24 deletions docs/snippets/receipt-yandex-feed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,36 +17,36 @@
<offers>

<offer id="1" available="true" type="vendor.model">
<url>https://example.com/products/fugiat-aut-sequi-minima-quia-facere</url>
<barcode>GD-O)N-&gt;X</barcode>
<name>adipisci quis asperiores rem</name>
<description>Cumque necessitatibus quia minima aspernatur et dolor quae. Dignissimos maxime aut rerum velit perspiciatis. Beatae sit a quisquam atque.</description>
<url>https://example.com/products/odit-error-voluptates-blanditiis-saepe-placeat</url>
<barcode>GD-+/ADU|]W</barcode>
<name>nam suscipit dolor dignissimos</name>
<description>Quasi magni consectetur quis. Nulla sunt vero vel quia qui autem. Qui aut quo enim quisquam et laudantium. Eos facilis autem sint asperiores temporibus.</description>
<delivery>true</delivery>
<price>456</price>
<price>708</price>
<currencyId>RUR</currencyId>
<vendor>eos</vendor>
<picture>https://via.placeholder.com/640x480.png/00ff77?text=facere</picture>
<picture>https://via.placeholder.com/640x480.png/006622?text=illo</picture>
<picture>https://via.placeholder.com/640x480.png/00cc77?text=magni</picture>
<param name="Артикул">GD-O)N-&gt;X</param>
<param name="Код цвета">2</param>
<param name="Пол">female</param>
<vendor>animi</vendor>
<picture>https://via.placeholder.com/640x480.png/000099?text=ullam</picture>
<picture>https://via.placeholder.com/640x480.png/003399?text=alias</picture>
<picture>https://via.placeholder.com/640x480.png/009999?text=aut</picture>
<param name="Артикул">GD-+/ADU|]W</param>
<param name="Код цвета">0</param>
<param name="Пол">male</param>
</offer>
<offer id="2" available="true" type="vendor.model">
<url>https://example.com/products/earum-voluptatem-magnam-error-molestiae-odit-consectetur</url>
<barcode>GD-+5T19</barcode>
<name>alias veritatis dignissimos omnis</name>
<description>Sint qui voluptatem quos et. Sint natus beatae ipsum maiores ipsa quas.</description>
<url>https://example.com/products/deleniti-rerum-ratione-voluptas-ut-explicabo-ad-provident</url>
<barcode>GD-0TMMSV"</barcode>
<name>illum sint minima consequatur</name>
<description>Voluptate sed rerum rerum optio asperiores ipsam consequatur. Neque maxime et voluptatibus at id. Sequi praesentium eum dolores non itaque. Eos et ullam veniam ipsam et delectus.</description>
<delivery>true</delivery>
<price>553</price>
<price>756</price>
<currencyId>RUR</currencyId>
<vendor>consequatur</vendor>
<picture>https://via.placeholder.com/640x480.png/00bb99?text=voluptas</picture>
<picture>https://via.placeholder.com/640x480.png/00bb22?text=recusandae</picture>
<picture>https://via.placeholder.com/640x480.png/0088ee?text=fugit</picture>
<param name="Артикул">GD-+5T19</param>
<param name="Код цвета">9</param>
<param name="Пол">male</param>
<vendor>nostrum</vendor>
<picture>https://via.placeholder.com/640x480.png/005511?text=ipsum</picture>
<picture>https://via.placeholder.com/640x480.png/001188?text=cumque</picture>
<picture>https://via.placeholder.com/640x480.png/007777?text=omnis</picture>
<param name="Артикул">GD-0TMMSV"</param>
<param name="Код цвета">6</param>
<param name="Пол">female</param>
</offer>

</offers>
Expand Down
Loading