Fileexport Action Documentation

Not included in official Wikka version

This is the documentation page for the Fileexport action.
 

Documentation


Short description
Exports a selection of wiki pages to an HTML or XML file.

Parameters
nametyperequired?defaultdescription
typestringoptionalhtmlAllowed values are 'html', 'rawhtml' and 'xml'
scopestringoptionalmScope of export, i.e. set of pages to be exported. Allowed values are 'm' (mine=all pages owned by current user), 'o' (others=include pages owned by me+others), 'p' (public=include mine, others' and public -i.e. system- pages) and a valid page tag (export only this page)
sortstringoptionaltagSort order of selected pages. Allowed values are 'tag' (sort on page tag), 'title' (sort on page title) and 'time' (sort on timestamp of last update)
optsstringoptionalOptions: any combination of 'e' (embed the CSS stylesheet) and 'r' (remove external hyperlinks)
catsstringoptionalSelect only pages belonging to any of the specified categories, passed as a list of Cat1, Cat2...

Long description
This action displays on the page an hyperlink for downloading a one-file collection of selected wiki pages. The format and the content of the exported file can be controlled as follows:
The XML file format complies with the following DTD:

<!ELEMENT wikka (page*)>
<!ELEMENT page (owner, category*, title, raw_content, rendered_content, structdataitem*)>
<!ATTLIST page tag ID #REQUIRED>
<!ATTLIST page lastchange CDATA #REQUIRED>
<!-- ISO-8601 YYYY-MM-DDThh:mm:ss format-->
<!ELEMENT owner (#PCDATA)>
<!ELEMENT category (#PCDATA)>
<!ELEMENT title (#PCDATA)>
<!ELEMENT raw_content (#PCDATA)>
<!ELEMENT rendered_content (#PCDATA)>
<!ELEMENT structdataitem (#PCDATA)>
<!ATTLIST structdataitem type CDATA #REQUIRED>


Usage

{{fileexport [type="html"] [sort="tag"] [scope="o"] [opts="e"] [cats="CategoryWiki, CategoryUsers"]}}


To-do, bugs and limitations

~- To-do: include structured data items in the XML export format

Author
DomBonj


CategoryDocumentation
There are no comments on this page.
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki