Difference between revisions of "HypertWiki:W3tpl/lib/doc"
Jump to navigation
Jump to search
(brief documentation) |
(NoteFoot) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
To make use of functions in this library (in another page), you must first load it: | To make use of functions in this library (in another page), you must first load it: | ||
<load page="{{FULLPAGENAME}}" local /> | <load page="{{FULLPAGENAME}}" local /> | ||
==AName(anchor)== | |||
* '''Function''': AName | * '''Function''': AName | ||
* '''Purpose''': emits an anchor tag -- <a name="..."></a> -- which can be used for footnotes but probably has other uses as well. | * '''Purpose''': emits an anchor tag -- <a name="..."></a> -- which can be used for footnotes but probably has other uses as well. | ||
| Line 10: | Line 10: | ||
</noinclude> | </noinclude> | ||
<func AName anchor> | <func AName anchor> | ||
<let name=tag chr=60 /> | <let name=tag-open chr=60 /> | ||
<let name=tag append>a name="</let> | <let name=tag-open append>a name="</let> | ||
<let name=tag | <let name=tag-shut>" /</let> | ||
<let name=tag append chr=62 /> | <let name=tag-shut append chr=62 /> | ||
<let name=tag append chr=60 /> | <let name=tag-shut append chr=60 /> | ||
<let name=tag append>/a</let> | <let name=tag-shut append>/a</let> | ||
<let name=tag append chr=62 /> | <let name=tag-shut append chr=62 /> | ||
<echo><get name=tag raw /></echo> | <echo><get name=tag-open raw /><get name=anchor /><get name=tag-shut raw /></echo> | ||
</func> | |||
<noinclude> | |||
==NoteFoot(key)== | |||
* '''Function''': NoteFoot | |||
* '''Purpose''': Emits a nicely-formatted footnote with an anchor tag so document text can link to it | |||
* '''Parameters''': | |||
** '''key''' = key to the anchor; this value is displayed as is and prefixed with "note-" for the actual tag, thus: | |||
*** '''<a name="note-<u>key</u>"></a>''' | |||
</noinclude> | |||
<func NoteFoot key> | |||
<let name=anchor>note-</let> | |||
<let name=anchor append copy=key /> | |||
<echo>: '''<get name=key />.'''<call AName anchor=$anchor /> </echo> | |||
</func> | </func> | ||
Latest revision as of 12:11, 1 December 2008
To make use of functions in this library (in another page), you must first load it:
<load page="HypertWiki:W3tpl/lib/doc" local />
AName(anchor)
- Function: AName
- Purpose: emits an anchor tag -- <a name="..."></a> -- which can be used for footnotes but probably has other uses as well.
- Parameters:
- anchor = name of anchor
- How to call: <call AName anchor=name />
> function aname() <= ()
NoteFoot(key)
- Function: NoteFoot
- Purpose: Emits a nicely-formatted footnote with an anchor tag so document text can link to it
- Parameters:
- key = key to the anchor; this value is displayed as is and prefixed with "note-" for the actual tag, thus:
- <a name="note-key"></a>
- key = key to the anchor; this value is displayed as is and prefixed with "note-" for the actual tag, thus:
> function notefoot() <= ()