| [ Index ] |
PHP Cross Reference of DokuWiki |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 770 lines (20 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Doku_Renderer_metadata:: (44 methods):
getFormat()
document_start()
document_end()
cdata()
toc_additem()
header()
p_open()
p_close()
linebreak()
hr()
footnote_open()
footnote_close()
listu_open()
listo_open()
listitem_open()
listitem_close()
preformatted()
quote_open()
quote_close()
file()
code()
acronym()
smiley()
entity()
multiplyentity()
singlequoteopening()
singlequoteclosing()
apostrophe()
doublequoteopening()
doublequoteclosing()
camelcaselink()
locallink()
internallink()
externallink()
interwikilink()
windowssharelink()
emaillink()
internalmedia()
externalmedia()
rss()
_simpleTitle()
_getLinkTitle()
_firstimage()
_recordMediaUsage()
Class: Doku_Renderer_metadata - X-Ref
The MetaData Renderer| getFormat() X-Ref |
| Returns the format produced by this renderer. return: string always 'metadata' |
| document_start() X-Ref |
| Initialize the document Sets up some of the persistent info about the page if it doesn't exist, yet. |
| document_end() X-Ref |
| Finalize the document Stores collected data in the metadata |
| cdata($text) X-Ref |
| Render plain text data This function takes care of the amount captured data and will stop capturing when enough abstract data is available param: $text |
| toc_additem($id, $text, $level) X-Ref |
| Add an item to the TOC param: string $id the hash link param: string $text the text to display param: int $level the nesting level |
| header($text, $level, $pos) X-Ref |
| Render a heading param: string $text the text to display param: int $level header level param: int $pos byte position in the original source |
| p_open() X-Ref |
| Open a paragraph |
| p_close() X-Ref |
| Close a paragraph |
| linebreak() X-Ref |
| Create a line break |
| hr() X-Ref |
| Create a horizontal line |
| footnote_open() X-Ref |
| Callback for footnote start syntax All following content will go to the footnote instead of the document. To achieve this the previous rendered content is moved to $store and $doc is cleared author: Andreas Gohr <andi@splitbrain.org> |
| footnote_close() X-Ref |
| Callback for footnote end syntax All content rendered whilst within footnote syntax mode is discarded, the previously rendered content is restored and capturing is re-enabled. author: Andreas Gohr |
| listu_open() X-Ref |
| Open an unordered list |
| listo_open() X-Ref |
| Open an ordered list |
| listitem_open($level, $node = false) X-Ref |
| Open a list item param: int $level the nesting level param: bool $node true when a node; false when a leaf |
| listitem_close() X-Ref |
| Close a list item |
| preformatted($text) X-Ref |
| Output preformatted text param: string $text |
| quote_open() X-Ref |
| Start a block quote |
| quote_close() X-Ref |
| Stop a block quote |
| file($text, $lang = null, $file = null) X-Ref |
| Display text as file content, optionally syntax highlighted param: string $text text to show param: string $lang programming language to use for syntax highlighting param: string $file file path label |
| code($text, $language = null, $file = null) X-Ref |
| Display text as code content, optionally syntax highlighted param: string $text text to show param: string $language programming language to use for syntax highlighting param: string $file file path label |
| acronym($acronym) X-Ref |
| Format an acronym Uses $this->acronyms param: string $acronym |
| smiley($smiley) X-Ref |
| Format a smiley Uses $this->smiley param: string $smiley |
| entity($entity) X-Ref |
| Format an entity Entities are basically small text replacements Uses $this->entities param: string $entity |
| multiplyentity($x, $y) X-Ref |
| Typographically format a multiply sign Example: ($x=640, $y=480) should result in "640×480" param: string|int $x first value param: string|int $y second value |
| singlequoteopening() X-Ref |
| Render an opening single quote char (language specific) |
| singlequoteclosing() X-Ref |
| Render a closing single quote char (language specific) |
| apostrophe() X-Ref |
| Render an apostrophe char (language specific) |
| doublequoteopening() X-Ref |
| Render an opening double quote char (language specific) |
| doublequoteclosing() X-Ref |
| Render an closinging double quote char (language specific) |
| camelcaselink($link) X-Ref |
| Render a CamelCase link see: http://en.wikipedia.org/wiki/CamelCase param: string $link The link name |
| locallink($hash, $name = null) X-Ref |
| Render a page local link param: string $hash hash link identifier param: string $name name for the link |
| internallink($id, $name = null) X-Ref |
| keep track of internal links in $this->meta['relation']['references'] param: string $id page ID to link to. eg. 'wiki:syntax' param: string|array|null $name name for the link, array for media file |
| externallink($url, $name = null) X-Ref |
| Render an external link param: string $url full URL with scheme param: string|array|null $name name for the link, array for media file |
| interwikilink($match, $name, $wikiName, $wikiUri) X-Ref |
| Render an interwiki link You may want to use $this->_resolveInterWiki() here param: string $match original link - probably not much use param: string|array $name name for the link, array for media file param: string $wikiName indentifier (shortcut) for the remote wiki param: string $wikiUri the fragment parsed from the original link |
| windowssharelink($url, $name = null) X-Ref |
| Link to windows share param: string $url the link param: string|array $name name for the link, array for media file |
| emaillink($address, $name = null) X-Ref |
| Render a linked E-Mail Address Should honor $conf['mailguard'] setting param: string $address Email-Address param: string|array $name name for the link, array for media file |
| internalmedia($src,$title = null,$align = null,$width = null,$height = null,$cache = null,$linking = null) X-Ref |
| Render an internal media file param: string $src media ID param: string $title descriptive text param: string $align left|center|right param: int $width width of media in pixel param: int $height height of media in pixel param: string $cache cache|recache|nocache param: string $linking linkonly|detail|nolink |
| externalmedia($src,$title = null,$align = null,$width = null,$height = null,$cache = null,$linking = null) X-Ref |
| Render an external media file param: string $src full media URL param: string $title descriptive text param: string $align left|center|right param: int $width width of media in pixel param: int $height height of media in pixel param: string $cache cache|recache|nocache param: string $linking linkonly|detail|nolink |
| rss($url, $params) X-Ref |
| Render the output of an RSS feed param: string $url URL of the feed param: array $params Finetuning of the output |
| _simpleTitle($name) X-Ref |
| Removes any Namespace from the given name but keeps casing and special chars return: mixed|string author: Andreas Gohr <andi@splitbrain.org> param: string $name |
| _getLinkTitle($title, $default, $id = null) X-Ref |
| Construct a title and handle images in titles return: string title text author: Harry Fuecks <hfuecks@gmail.com> param: string|array|null $title either string title or media array param: string $default default title if nothing else is found param: null|string $id linked page id (used to extract title from first heading) |
| _firstimage($src) X-Ref |
| Remember first image param: string $src image URL or ID |
| _recordMediaUsage($src) X-Ref |
| Store list of used media files in metadata param: string $src media ID |