: Forrest's Wiki Support
Forrest now has partial support for documentation in Wiki format, thanks to the Chaperon parser. Wiki is a simple text format that can be learned in minutes. This page provides an overview of the syntax that Forrest supports, namely a subset of that used by the Cocoon Wiki.
Quick reference
---- = Make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break, \\\=force line break and clear.
[link] = creates a hyperlink to an internal WikiPage called 'Link'.
[this is also a link] = creates a hyperlink to an internal WikiPage called
'ThisIsAlsoALink'.
[click here|link] = creates a hyperlink to an internal WikiPage called
'Link', but displays the text 'click here' to the
user instead of 'Link'.
[1] = Makes a reference to a footnote numbered 1.
[#1] = Marks the footnote number 1.
[[link] = creates text '[link]'.
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
''text'' = prints 'text' in italic.
__text__ = prints 'text' in bold.
{{text}} = prints 'text' in monospaced font.
* text = makes a bulleted list item with 'text'
# text = makes a numbered list item with 'text'
;term:ex = makes a definition for 'term' with the explanation 'ex'
<<<<<<<<<<<<<<<<<<<<<<
to explain it a bit more: i want to be able to use the phpWiki in a environment for rapid prototyping: In a few months i probably want to switch to a Cocoon-wiki, cause
this cocoon publishing engine (wiki) supports XML througout the whole environment! so it is important for me to have a set created texts, which can be portet over...
thanks for the answers...
meta
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Partially. My own PhpWiki installation uses only the old markup (which I think to be better documented and easier than the new one), so the new markup might be different (1.3.3 lacked proper docs on new markup):
---- for horizontal rulers - OK.
\\ for Line breaks - no, that's %%% here.
[link] for Link - no, text in [] is taken verbatim.
[this is a link] for ThisIsALing - no, see above.
[click here|link] - yes, but "link" is taken verbatim (no capitalization).
[1] for foornotes - not quite, PhpWiki makes this into an external reference.
[[link] for text '[link]' - yes.
!, !!, !!! for headings - yes.
''text'' for italics - yes.
__test__ for bold - yes.
{{text}} for monospaced - no, PhpWiki renders text with leading space in monospace.
* for bullet lists - yes.
# for numbered lists - yes.
;term:ex for definition lists - yes.
You have a good overall coverage; with a bit of care you should be able to make a transition later.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
hello all
i want to ask if i can use the phpWiki and am able to convert my data later into another wiki - (e.g. in a Cocoon - Wiki [see http://xml.apache.org/forrest/wiki-sample.html ] )
does the Syntax of phpWiki support the following set:
cit : http://xml.apache.org/forrest/wiki-sample.html
: Forrest's Wiki Support
Forrest now has partial support for documentation in Wiki format, thanks to the Chaperon parser. Wiki is a simple text format that can be learned in minutes. This page provides an overview of the syntax that Forrest supports, namely a subset of that used by the Cocoon Wiki.
Quick reference
---- = Make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break, \\\=force line break and clear.
[link] = creates a hyperlink to an internal WikiPage called 'Link'.
[this is also a link] = creates a hyperlink to an internal WikiPage called
'ThisIsAlsoALink'.
[click here|link] = creates a hyperlink to an internal WikiPage called
'Link', but displays the text 'click here' to the
user instead of 'Link'.
[1] = Makes a reference to a footnote numbered 1.
[#1] = Marks the footnote number 1.
[[link] = creates text '[link]'.
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
''text'' = prints 'text' in italic.
__text__ = prints 'text' in bold.
{{text}} = prints 'text' in monospaced font.
* text = makes a bulleted list item with 'text'
# text = makes a numbered list item with 'text'
;term:ex = makes a definition for 'term' with the explanation 'ex'
<<<<<<<<<<<<<<<<<<<<<<
to explain it a bit more: i want to be able to use the phpWiki in a environment for rapid prototyping: In a few months i probably want to switch to a Cocoon-wiki, cause
this cocoon publishing engine (wiki) supports XML througout the whole environment! so it is important for me to have a set created texts, which can be portet over...
thanks for the answers...
meta
Partially. My own PhpWiki installation uses only the old markup (which I think to be better documented and easier than the new one), so the new markup might be different (1.3.3 lacked proper docs on new markup):
---- for horizontal rulers - OK.
\\ for Line breaks - no, that's %%% here.
[link] for Link - no, text in [] is taken verbatim.
[this is a link] for ThisIsALing - no, see above.
[click here|link] - yes, but "link" is taken verbatim (no capitalization).
[1] for foornotes - not quite, PhpWiki makes this into an external reference.
[[link] for text '[link]' - yes.
!, !!, !!! for headings - yes.
''text'' for italics - yes.
__test__ for bold - yes.
{{text}} for monospaced - no, PhpWiki renders text with leading space in monospace.
* for bullet lists - yes.
# for numbered lists - yes.
;term:ex for definition lists - yes.
You have a good overall coverage; with a bit of care you should be able to make a transition later.