Skip to content

Commit d88cb8b

Browse files
Merge pull request #79 from TheDragonCode/1.x
Update advanced-usage.topic
2 parents 903b2e9 + 3c46858 commit d88cb8b

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/topics/advanced-usage.topic

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<note>
1616
<p>
17-
<format style="bold">Reserved words:</format>
17+
<format style="bold">Reserved directives:</format>
1818
</p>
1919
<list>
2020
<li><a href="#_attributes" /></li>
@@ -27,6 +27,16 @@
2727

2828
<chapter title="Elements" id="elements">
2929
<chapter title="Root element" id="root_element">
30+
<tip>
31+
<p>
32+
By defending, the name of the root element is formed from the basic name of the feed class.
33+
</p>
34+
35+
<p>
36+
For example, for the <code>App\Feeds\FooBarFeed</code> class, the name is <code>foo_bar</code>.
37+
</p>
38+
</tip>
39+
3040
<p>
3141
To add a root element and/or its attributes, override the <code>root</code> method:
3242
</p>
@@ -91,6 +101,8 @@
91101

92102
<chapter title="Directives" id="directives">
93103
<chapter title="@attributes" id="_attributes">
104+
<link-summary>Indicates an array of attributes</link-summary>
105+
94106
<p>
95107
You can use a key named <code>@attributes</code> to add attributes to a node:
96108
</p>
@@ -107,6 +119,8 @@
107119
</chapter>
108120

109121
<chapter title="@value" id="_value">
122+
<link-summary>Indicates the applicable value "as it is"</link-summary>
123+
110124
<tip>
111125
Note, that the value of the <code>@value</code> field must be a string.
112126
</tip>
@@ -125,6 +139,8 @@
125139
</chapter>
126140

127141
<chapter title="@cdata" id="_cdata">
142+
<link-summary>Allows the use of XML marking without transformation</link-summary>
143+
128144
<tip>
129145
It is also possible to wrap the value of a node into a CDATA section.
130146
This allows you to use reserved characters.
@@ -144,6 +160,8 @@
144160
</chapter>
145161

146162
<chapter title="@mixed" id="_mixed">
163+
<link-summary>Allows you to use XML marking directly into the structure of the document</link-summary>
164+
147165
<p>
148166
To insert XML fragments “as is”, use the <code>@mixed</code> directive:
149167
</p>
@@ -158,6 +176,8 @@
158176
</chapter>
159177

160178
<chapter title="Array" id="array">
179+
<link-summary>Describes the possibility of listing an array of elements with the same keys</link-summary>
180+
161181
<p>
162182
In some cases, you need to place an array of elements with the same names.
163183
</p>

0 commit comments

Comments
 (0)