Changesets can be listed by changeset number.
The Git repository is here.
- Revision:
- 373
- Log:
Initial import of Radiant 0.9.1, which is now packaged as a gem. This is an
import of the tagged 0.9.1 source checked out from GitHub, which isn't quite
the same as the gem distribution - but it doesn't seem to be available in an
archived form and the installed gem already has modifications, so this is
the closest I can get.
- Author:
- rool
- Date:
- Mon Mar 21 13:40:05 +0000 2011
- Size:
- 21422 Bytes
1 | |
2 | --- |
3 | en: |
4 | desc: |
5 | aggregate-children-count: "Renders the total count of children of the aggregated pages. Accepts the |
6 | same options as @<r:children:each />@. |
7 | |
8 | *Usage*: |
9 | |
10 | <pre><code><r:aggregate urls=\"/section1; /section2; /section3\"> |
11 | <r:children:count /> |
12 | </r:aggregate></code></pre>" |
13 | aggregate-children-each: "Renders the contained block for each child of the aggregated pages. Accepts the |
14 | same options as the plain @<r:children:each />@. |
15 | |
16 | *Usage*: |
17 | |
18 | <pre><code><r:aggregate urls=\"/section1; /section2; /section3\"> |
19 | <r:children:each> |
20 | ... |
21 | </r:children:each> |
22 | </r:aggregate></code></pre>" |
23 | aggregate-children-first: "Renders the first child of the aggregated pages. Accepts the |
24 | same options as @<r:children:each />@. |
25 | |
26 | *Usage*: |
27 | |
28 | <pre><code><r:aggregate urls=\"/section1; /section2; /section3\"> |
29 | <r:children:first> |
30 | ... |
31 | </r:children:first> |
32 | </r:aggregate></code></pre>" |
33 | aggregate-children-last: "Renders the last child of the aggregated pages. Accepts the |
34 | same options as @<r:children:each />@. |
35 | |
36 | *Usage*: |
37 | |
38 | <pre><code><r:aggregate urls=\"/section1; /section2; /section3\"> |
39 | <r:children:last> |
40 | ... |
41 | </r:children:last> |
42 | </r:aggregate></code></pre>" |
43 | aggregate-each: "Sets the scope to the individual aggregated page allowing you to |
44 | iterate through each of the listed urls. |
45 | |
46 | *Usage*: |
47 | |
48 | <pre><code><r:aggregate:each urls=\"/section1; /section2; /section3\"> ... </r:aggregate:each></code></pre>" |
49 | aggregate: "Aggregates the children of multiple URLs using the @urls@ attribute. |
50 | Useful for combining many different sections/categories into a single |
51 | feed or listing. |
52 | |
53 | *Usage*: |
54 | |
55 | <pre><code><r:aggregate urls=\"/section1; /section2; /section3\"> ... </r:aggregate></code></pre>" |
56 | author: "Renders the name of the author of the current page." |
57 | breadcrumb: "Renders the @breadcrumb@ attribute of the current page." |
58 | breadcrumbs: "Renders a trail of breadcrumbs to the current page. The separator attribute |
59 | specifies the HTML fragment that is inserted between each of the breadcrumbs. By |
60 | default it is set to @>@. The boolean nolinks attribute can be specified to render |
61 | breadcrumbs in plain text, without any links (useful when generating title tag). |
62 | |
63 | *Usage:* |
64 | |
65 | <pre><code><r:breadcrumbs [separator=\"separator_string\"] [nolinks=\"true\"] /></code></pre>" |
66 | children-count: "Renders the total number of children." |
67 | children-each-child: "Page attribute tags inside of this tag refer to the current child. This is occasionally |
68 | useful if you are inside of another tag (like <r:find>) and need to refer back to the |
69 | current child. |
70 | |
71 | *Usage:* |
72 | |
73 | <pre><code><r:children:each> |
74 | <r:child>...</r:child> |
75 | </r:children:each> |
76 | </code></pre>" |
77 | children-each-header: "Renders the tag contents only if the contents do not match the previous header. This |
78 | is extremely useful for rendering date headers for a list of child pages. |
79 | |
80 | If you would like to use several header blocks you may use the @name@ attribute to |
81 | name the header. When a header is named it will not restart until another header of |
82 | the same name is different. |
83 | |
84 | Using the @restart@ attribute you can cause other named headers to restart when the |
85 | present header changes. Simply specify the names of the other headers in a semicolon |
86 | separated list. |
87 | |
88 | *Usage:* |
89 | |
90 | <pre><code><r:children:each> |
91 | <r:header [name=\"header_name\"] [restart=\"name1[;name2;...]\"]> |
92 | ... |
93 | </r:header> |
94 | </r:children:each> |
95 | </code></pre>" |
96 | children-each-if_first: "Renders the tag contents only if the current page is the first child in the context of |
97 | a children:each tag |
98 | |
99 | *Usage:* |
100 | |
101 | <pre><code><r:children:each> |
102 | <r:if_first > |
103 | ... |
104 | </r:if_first> |
105 | </r:children:each> |
106 | </code></pre>" |
107 | children-each-if_last: "Renders the tag contents only if the current page is the last child in the context of |
108 | a children:each tag |
109 | |
110 | *Usage:* |
111 | |
112 | <pre><code><r:children:each> |
113 | <r:if_last > |
114 | ... |
115 | </r:if_last> |
116 | </r:children:each> |
117 | </code></pre>" |
118 | children-each-unless_first: "Renders the tag contents unless the current page is the first child in the context of |
119 | a children:each tag |
120 | |
121 | *Usage:* |
122 | |
123 | <pre><code><r:children:each> |
124 | <r:unless_first > |
125 | ... |
126 | </r:unless_first> |
127 | </r:children:each> |
128 | </code></pre>" |
129 | children-each-unless_last: "Renders the tag contents unless the current page is the last child in the context of |
130 | a children:each tag |
131 | |
132 | *Usage:* |
133 | |
134 | <pre><code><r:children:each> |
135 | <r:unless_last > |
136 | ... |
137 | </r:unless_last> |
138 | </r:children:each> |
139 | </code></pre>" |
140 | children-each: "Cycles through each of the children. Inside this tag all page attribute tags |
141 | are mapped to the current child page. |
142 | |
143 | Supply @paginated=\"true\"@ to paginate the displayed list. will_paginate view helper |
144 | options can also be specified, including @per_page@, @previous_label@, @next_label@, |
145 | @class@, @separator@, @inner_window@ and @outer_window@. |
146 | |
147 | *Usage:* |
148 | |
149 | <pre><code><r:children:each [offset=\"number\"] [limit=\"number\"] |
150 | [by=\"published_at|updated_at|created_at|slug|title|keywords|description\"] |
151 | [order=\"asc|desc\"] |
152 | [status=\"draft|reviewed|published|hidden|all\"] |
153 | [paginated=\"true\"] |
154 | [per_page=\"number\"] |
155 | > |
156 | ... |
157 | </r:children:each> |
158 | </code></pre>" |
159 | children-first: "Returns the first child. Inside this tag all page attribute tags are mapped to |
160 | the first child. Takes the same ordering options as @<r:children:each>@. |
161 | |
162 | *Usage:* |
163 | |
164 | <pre><code><r:children:first>...</r:children:first></code></pre>" |
165 | children-last: "Returns the last child. Inside this tag all page attribute tags are mapped to |
166 | the last child. Takes the same ordering options as @<r:children:each>@. |
167 | |
168 | *Usage:* |
169 | |
170 | <pre><code><r:children:last>...</r:children:last></code></pre>" |
171 | children: "Gives access to a page's children. |
172 | |
173 | *Usage:* |
174 | |
175 | <pre><code><r:children>...</r:children></code></pre>" |
176 | comment: "Nothing inside a set of comment tags is rendered. |
177 | |
178 | *Usage:* |
179 | |
180 | <pre><code><r:comment>...</r:comment></code></pre>" |
181 | content: "Renders the main content of a page. Use the @part@ attribute to select a specific |
182 | page part. By default the @part@ attribute is set to body. Use the @inherit@ |
183 | attribute to specify that if a page does not have a content part by that name that |
184 | the tag should render the parent's content part. By default @inherit@ is set to |
185 | @false@. Use the @contextual@ attribute to force a part inherited from a parent |
186 | part to be evaluated in the context of the child page. By default 'contextual' |
187 | is set to true. |
188 | |
189 | *Usage:* |
190 | |
191 | <pre><code><r:content [part=\"part_name\"] [inherit=\"true|false\"] [contextual=\"true|false\"] /></code></pre>" |
192 | cycle: "Renders one of the passed values based on a global cycle counter. Use the @reset@ |
193 | attribute to reset the cycle to the beginning. Use the @name@ attribute to track |
194 | multiple cycles; the default is @cycle@. |
195 | |
196 | *Usage:* |
197 | |
198 | <pre><code><r:cycle values=\"first, second, third\" [reset=\"true|false\"] [name=\"cycle\"] /></code></pre>" |
199 | date: "Renders the date based on the current page (by default when it was published or created). |
200 | The format attribute uses the same formating codes used by the Ruby @strftime@ function. By |
201 | default it's set to @%A, %B %d, %Y@. The @for@ attribute selects which date to render. Valid |
202 | options are @published_at@, @created_at@, @updated_at@, and @now@. @now@ will render the |
203 | current date/time, regardless of the page. |
204 | |
205 | *Usage:* |
206 | |
207 | <pre><code><r:date [format=\"%A, %B %d, %Y\"] [for=\"published_at\"]/></code></pre>" |
208 | escape_html: "Escapes angle brackets, etc. for rendering in an HTML document. |
209 | |
210 | *Usage:* |
211 | |
212 | <pre><code><r:escape_html>...</r:escape_html></code></pre>" |
213 | find: "Inside this tag all page related tags refer to the page found at the @url@ attribute. |
214 | @url@s may be relative or absolute paths. |
215 | |
216 | *Usage:* |
217 | |
218 | <pre><code><r:find url=\"value_to_find\">...</r:find></code></pre>" |
219 | gravatar: "Renders the Gravatar of the author of the current page or the named user. |
220 | |
221 | *Usage:* |
222 | |
223 | <pre><code><r:gravatar /></code></pre> |
224 | |
225 | or |
226 | |
227 | <pre><code><r:gravatar [name=\"User Name\"] |
228 | [rating=\"G | PG | R | X\"] |
229 | [size=\"32px\"] /></code></pre>" |
230 | if_ancestor_or_self: "Renders the contained elements if the current contextual page is either the actual page or one of its parents. |
231 | |
232 | This is typically used inside another tag (like <r:children:each>) to add conditional mark-up if the child element is or descends from the current page. |
233 | |
234 | *Usage:* |
235 | |
236 | <pre><code><r:if_ancestor_or_self>...</r:if_ancestor_or_self></code></pre>" |
237 | if_children: "Renders the contained elements only if the current contextual page has one or |
238 | more child pages. The @status@ attribute limits the status of found child pages |
239 | to the given status, the default is @\"published\"@. @status=\"all\"@ includes all |
240 | non-virtual pages regardless of status. |
241 | |
242 | *Usage:* |
243 | |
244 | <pre><code><r:if_children [status=\"published\"]>...</r:if_children></code></pre>" |
245 | if_content: "Renders the containing elements if all of the listed parts exist on a page. |
246 | By default the @part@ attribute is set to @body@, but you may list more than one |
247 | part by separating them with a comma. Setting the optional @inherit@ to true will |
248 | search ancestors independently for each part. By default @inherit@ is set to @false@. |
249 | |
250 | When listing more than one part, you may optionally set the @find@ attribute to @any@ |
251 | so that it will render the containing elements if any of the listed parts are found. |
252 | By default the @find@ attribute is set to @all@. |
253 | |
254 | *Usage:* |
255 | |
256 | <pre><code><r:if_content [part=\"part_name, other_part\"] [inherit=\"true\"] [find=\"any\"]>...</r:if_content></code></pre>" |
257 | if_dev: "Renders the containing elements only if Radiant in is development mode. |
258 | |
259 | *Usage:* |
260 | |
261 | <pre><code><r:if_dev>...</r:if_dev></code></pre>" |
262 | if_parent: "Renders the contained elements only if the current contextual page has a parent, i.e. |
263 | is not the root page. |
264 | |
265 | *Usage:* |
266 | |
267 | <pre><code><r:if_parent>...</r:if_parent></code></pre>" |
268 | if_self: "Renders the contained elements if the current contextual page is also the actual page. |
269 | |
270 | This is typically used inside another tag (like <r:children:each>) to add conditional mark-up if the child element is the current page. |
271 | |
272 | *Usage:* |
273 | |
274 | <pre><code><r:if_self>...</r:if_self></code></pre>" |
275 | if_url: "Renders the containing elements only if the page's url matches the regular expression |
276 | given in the @matches@ attribute. If the @ignore_case@ attribute is set to false, the |
277 | match is case sensitive. By default, @ignore_case@ is set to true. |
278 | |
279 | *Usage:* |
280 | |
281 | <pre><code><r:if_url matches=\"regexp\" [ignore_case=\"true|false\"]>...</r:if_url></code></pre>" |
282 | link: "Renders a link to the page. When used as a single tag it uses the page's title |
283 | for the link name. When used as a double tag the part in between both tags will |
284 | be used as the link text. The link tag passes all attributes over to the HTML |
285 | @a@ tag. This is very useful for passing attributes like the @class@ attribute |
286 | or @id@ attribute. If the @anchor@ attribute is passed to the tag it will |
287 | append a pound sign (<code>#</code>) followed by the value of the attribute to |
288 | the @href@ attribute of the HTML @a@ tag--effectively making an HTML anchor. |
289 | |
290 | *Usage:* |
291 | |
292 | <pre><code><r:link [anchor=\"name\"] [other attributes...] /></code></pre> |
293 | |
294 | or |
295 | |
296 | <pre><code><r:link [anchor=\"name\"] [other attributes...]>link text here</r:link></code></pre>" |
297 | markdown: "Filters its contents with the Markdown filter. |
298 | |
299 | *Usage:* |
300 | |
301 | <pre><code><r:markdown>** bold text **</r:markdown></code></pre> |
302 | |
303 | produces |
304 | |
305 | <pre><code><strong> bold text </strong></code></pre>" |
306 | meta-description: "Emits the page description field in a meta tag, unless attribute |
307 | 'tag' is set to 'false'. |
308 | |
309 | *Usage:* |
310 | |
311 | <pre><code> <r:meta:description [tag=\"false\"] /> </code></pre>" |
312 | meta-keywords: "Emits the page keywords field in a meta tag, unless attribute |
313 | 'tag' is set to 'false'. |
314 | |
315 | *Usage:* |
316 | |
317 | <pre><code> <r:meta:keywords [tag=\"false\"] /> </code></pre>" |
318 | meta: "The namespace for 'meta' attributes. If used as a singleton tag, both the description |
319 | and keywords fields will be output as <meta /> tags unless the attribute 'tag' is set to 'false'. |
320 | |
321 | *Usage:* |
322 | |
323 | <pre><code> <r:meta [tag=\"false\"] /> |
324 | <r:meta> |
325 | <r:description [tag=\"false\"] /> |
326 | <r:keywords [tag=\"false\"] /> |
327 | </r:meta> |
328 | </code></pre>" |
329 | navigation-if_first: "Renders the containing elements if the element is the first |
330 | in the navigation list |
331 | |
332 | *Usage:* |
333 | |
334 | <pre><code><r:normal><r:if_first>...</r:if_first></r:normal></code></pre>" |
335 | navigation-if_last: "Renders the containing elements if the element is the last |
336 | in the navigation list |
337 | |
338 | *Usage:* |
339 | |
340 | <pre><code><r:normal><r:if_last>...</r:if_last></r:normal></code></pre>" |
341 | navigation-unless_first: "Renders the containing elements unless the element is the first |
342 | in the navigation list |
343 | |
344 | *Usage:* |
345 | |
346 | <pre><code><r:normal><r:unless_first>...</r:unless_first></r:normal></code></pre>" |
347 | navigation-unless_last: "Renders the containing elements unless the element is the last |
348 | in the navigation list |
349 | |
350 | *Usage:* |
351 | |
352 | <pre><code><r:normal><r:unless_last>...</r:unless_last></r:normal></code></pre>" |
353 | navigation: "Renders a list of links specified in the @urls@ attribute according to three |
354 | states: |
355 | |
356 | * @normal@ specifies the normal state for the link |
357 | * @here@ specifies the state of the link when the url matches the current |
358 | page's URL |
359 | * @selected@ specifies the state of the link when the current page matches |
360 | is a child of the specified url |
361 | # @if_last@ renders its contents within a @normal@, @here@ or |
362 | @selected@ tag if the item is the last in the navigation elements |
363 | # @if_first@ renders its contents within a @normal@, @here@ or |
364 | @selected@ tag if the item is the first in the navigation elements |
365 | |
366 | The @between@ tag specifies what should be inserted in between each of the links. |
367 | |
368 | *Usage:* |
369 | |
370 | <pre><code><r:navigation urls=\"[Title: url | Title: url | ...]\"> |
371 | <r:normal><a href=\"<r:url />\"><r:title /></a></r:normal> |
372 | <r:here><strong><r:title /></strong></r:here> |
373 | <r:selected><strong><a href=\"<r:url />\"><r:title /></a></strong></r:selected> |
374 | <r:between> | </r:between> |
375 | </r:navigation> |
376 | </code></pre>" |
377 | page: "Causes the tags referring to a page's attributes to refer to the current page. |
378 | |
379 | *Usage:* |
380 | |
381 | <pre><code><r:page>...</r:page></code></pre>" |
382 | pagination: "The pagination tag is not usually called directly. Supply paginated=\"true\" when you display a list and it will |
383 | be automatically display only the current page of results, with pagination controls at the bottom. |
384 | |
385 | *Usage:* |
386 | |
387 | <pre><code><r:children:each paginated=\"true\" per_page=\"50\" container=\"false\" previous_label=\"foo\" next_label=\"bar\"> |
388 | <r:child>...</r:child> |
389 | </r:children:each> |
390 | </code></pre>" |
391 | parent: "Page attribute tags inside this tag refer to the parent of the current page. |
392 | |
393 | *Usage:* |
394 | |
395 | <pre><code><r:parent>...</r:parent></code></pre>" |
396 | random: "Randomly renders one of the options specified by the @option@ tags. |
397 | |
398 | *Usage:* |
399 | |
400 | <pre><code><r:random> |
401 | <r:option>...</r:option> |
402 | <r:option>...</r:option> |
403 | ... |
404 | <r:random> |
405 | </code></pre>" |
406 | rfc1123_date: "Outputs the published date using the format mandated by RFC 1123. (Ideal for RSS feeds.) |
407 | |
408 | *Usage:* |
409 | |
410 | <pre><code><r:rfc1123_date /></code></pre>" |
411 | slug: "Renders the @slug@ attribute of the current page." |
412 | smarty_pants: "Filters its contents with the SmartyPants filter. |
413 | |
414 | *Usage:* |
415 | |
416 | <pre><code><r:smarty_pants>\"A revolutionary quotation.\"</r:smarty_pants></code></pre> |
417 | |
418 | produces |
419 | |
420 | <pre><code>“A revolutionary quotation.”</code></pre>" |
421 | snippet: "Renders the snippet specified in the @name@ attribute within the context of a page. |
422 | |
423 | *Usage:* |
424 | |
425 | <pre><code><r:snippet name=\"snippet_name\" /></code></pre> |
426 | |
427 | When used as a double tag, the part in between both tags may be used within the |
428 | snippet itself, being substituted in place of @<r:yield/>@. |
429 | |
430 | *Usage:* |
431 | |
432 | <pre><code><r:snippet name=\"snippet_name\">Lorem ipsum dolor...</r:snippet></code></pre>" |
433 | status: "Prints the page's status as a string. Optional attribute 'downcase' |
434 | will cause the status to be all lowercase. |
435 | |
436 | *Usage:* |
437 | |
438 | <pre><code><r:status [downcase='true'] /></code></pre>" |
439 | textile: "Filters its contents with the Textile filter. |
440 | |
441 | *Usage*: |
442 | |
443 | <pre><code><r:textile> |
444 | * First |
445 | * Second |
446 | </r:textile></code></pre> |
447 | |
448 | produces: |
449 | |
450 | <pre><code><ul> |
451 | <li>First</li> |
452 | <li>Second</li> |
453 | </ul></code></pre>" |
454 | title: "Renders the @title@ attribute of the current page." |
455 | unless_ancestor_or_self: "Renders the contained elements unless the current contextual page is either the actual page or one of its parents. |
456 | |
457 | This is typically used inside another tag (like <r:children:each>) to add conditional mark-up unless the child element is or descends from the current page. |
458 | |
459 | *Usage:* |
460 | |
461 | <pre><code><r:unless_ancestor_or_self>...</r:unless_ancestor_or_self></code></pre>" |
462 | unless_children: "Renders the contained elements only if the current contextual page has no children. |
463 | The @status@ attribute limits the status of found child pages to the given status, |
464 | the default is @\"published\"@. @status=\"all\"@ includes all non-virtual pages |
465 | regardless of status. |
466 | |
467 | *Usage:* |
468 | |
469 | <pre><code><r:unless_children [status=\"published\"]>...</r:unless_children></code></pre>" |
470 | unless_content: "The opposite of the @if_content@ tag. It renders the contained elements if all of the |
471 | specified parts do not exist. Setting the optional @inherit@ to true will search |
472 | ancestors independently for each part. By default @inherit@ is set to @false@. |
473 | |
474 | When listing more than one part, you may optionally set the @find@ attribute to @any@ |
475 | so that it will not render the containing elements if any of the listed parts are found. |
476 | By default the @find@ attribute is set to @all@. |
477 | |
478 | *Usage:* |
479 | |
480 | <pre><code><r:unless_content [part=\"part_name, other_part\"] [inherit=\"false\"] [find=\"any\"]>...</r:unless_content></code></pre>" |
481 | unless_dev: "The opposite of the @if_dev@ tag. |
482 | |
483 | *Usage:* |
484 | |
485 | <pre><code><r:unless_dev>...</r:unless_dev></code></pre>" |
486 | unless_parent: "Renders the contained elements only if the current contextual page has no parent, i.e. |
487 | is the root page. |
488 | |
489 | *Usage:* |
490 | |
491 | <pre><code><r:unless_parent>...</r:unless_parent></code></pre>" |
492 | unless_self: "Renders the contained elements unless the current contextual page is also the actual page. |
493 | |
494 | This is typically used inside another tag (like <r:children:each>) to add conditional mark-up unless the child element is the current page. |
495 | |
496 | *Usage:* |
497 | |
498 | <pre><code><r:unless_self>...</r:unless_self></code></pre>" |
499 | unless_url: "The opposite of the @if_url@ tag. |
500 | |
501 | *Usage:* |
502 | |
503 | <pre><code><r:unless_url matches=\"regexp\" [ignore_case=\"true|false\"]>...</r:unless_url></code></pre>" |
504 | url: "Renders the @url@ attribute of the current page." |
505 | yield: "Used within a snippet as a placeholder for substitution of child content, when |
506 | the snippet is called as a double tag. |
507 | |
508 | *Usage (within a snippet):* |
509 | |
510 | <pre><code> |
511 | <div id=\"outer\"> |
512 | <p>before</p> |
513 | <r:yield/> |
514 | <p>after</p> |
515 | </div> |
516 | </code></pre> |
517 | |
518 | If the above snippet was named \"yielding\", you could call it from any Page, |
519 | Layout or Snippet as follows: |
520 | |
521 | <pre><code><r:snippet name=\"yielding\">Content within</r:snippet></code></pre> |
522 | |
523 | Which would output the following: |
524 | |
525 | <pre><code> |
526 | <div id=\"outer\"> |
527 | <p>before</p> |
528 | Content within |
529 | <p>after</p> |
530 | </div> |
531 | </code></pre> |
532 | |
533 | When called in the context of a Page or a Layout, @<r:yield/>@ outputs nothing." |