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