|
14 | 14 |
|
15 | 15 | <note> |
16 | 16 | <p> |
17 | | - <format style="bold">Reserved words:</format> |
| 17 | + <format style="bold">Reserved directives:</format> |
18 | 18 | </p> |
19 | 19 | <list> |
20 | 20 | <li><a href="#_attributes" /></li> |
|
27 | 27 |
|
28 | 28 | <chapter title="Elements" id="elements"> |
29 | 29 | <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 | + |
30 | 40 | <p> |
31 | 41 | To add a root element and/or its attributes, override the <code>root</code> method: |
32 | 42 | </p> |
|
91 | 101 |
|
92 | 102 | <chapter title="Directives" id="directives"> |
93 | 103 | <chapter title="@attributes" id="_attributes"> |
| 104 | + <link-summary>Indicates an array of attributes</link-summary> |
| 105 | + |
94 | 106 | <p> |
95 | 107 | You can use a key named <code>@attributes</code> to add attributes to a node: |
96 | 108 | </p> |
|
107 | 119 | </chapter> |
108 | 120 |
|
109 | 121 | <chapter title="@value" id="_value"> |
| 122 | + <link-summary>Indicates the applicable value "as it is"</link-summary> |
| 123 | + |
110 | 124 | <tip> |
111 | 125 | Note, that the value of the <code>@value</code> field must be a string. |
112 | 126 | </tip> |
|
125 | 139 | </chapter> |
126 | 140 |
|
127 | 141 | <chapter title="@cdata" id="_cdata"> |
| 142 | + <link-summary>Allows the use of XML marking without transformation</link-summary> |
| 143 | + |
128 | 144 | <tip> |
129 | 145 | It is also possible to wrap the value of a node into a CDATA section. |
130 | 146 | This allows you to use reserved characters. |
|
144 | 160 | </chapter> |
145 | 161 |
|
146 | 162 | <chapter title="@mixed" id="_mixed"> |
| 163 | + <link-summary>Allows you to use XML marking directly into the structure of the document</link-summary> |
| 164 | + |
147 | 165 | <p> |
148 | 166 | To insert XML fragments “as is”, use the <code>@mixed</code> directive: |
149 | 167 | </p> |
|
158 | 176 | </chapter> |
159 | 177 |
|
160 | 178 | <chapter title="Array" id="array"> |
| 179 | + <link-summary>Describes the possibility of listing an array of elements with the same keys</link-summary> |
| 180 | + |
161 | 181 | <p> |
162 | 182 | In some cases, you need to place an array of elements with the same names. |
163 | 183 | </p> |
|
0 commit comments