PodWiki uses POD as its markup language. POD is a very simple and easy to learn markup language and it is the standard for perl documentation.
Table of Contents:
PodWiki Markup Documentation
PodWiki Markup Examples/Overview
Lists
Bullet List
Numbered List
Text List (indented text)
You can also make nested lists and mix list types
Headings
Text Formattings
Bold Text
Italic Text
Code
Preformatted Text
Avoid linebreaks
Character Entities
Horizontal lines
Hyperlinks
Links to PodWiki pages
Links to PodWiki interactive STATE pages
Links to external websites
Display Text of Link
Interwiki Links
Include Pages
Include PodWiki Pages
Include PodWiki interactive STATE pages
Include External Webpages
Graphics
Show an image
Specify an ALT text attribute for a graphic
Graphic Links
Thumbnail Graphic Links
External Formatters
Creole Formatter
WikiShorthand formatter
Tiki formatter
TWiki formatter
HTML formatter
TEXT formatter
PERL formatter
COMMENT formatter
OPTIONS formatter
blog formatter
Tables
Attributes
Property Inheritance
Take a look on this table to get an overview of what is possible in PodWiki and how it is done.
For the impatient: visit the PodWikiSample page which shows most of the features.
PodWikiMarkup |
What you get |
---|---|
=head1 Heading 1 |
Heading 1 |
=head2 Heading 2 |
Heading 2 |
=head3 Heading 3 |
Heading 3 |
=head4 Heading 4 |
Heading 4 |
Links are working as in standard POD but PodWiki doesn't know manpages, it considers such links as "WikiWords" or: as internal PodWiki links.
PodWikiMarkup |
What you get |
---|---|
Links to PodWiki pagesLink to an existing page: L<Index> Link to a non-existing page (this is the way you create new pages, btw.): L<YetAnotherPodWikiPage> |
Existing page: Non-existing page: YetAnotherPodWikiPage? |
Links to PodWiki interactive STATE pagesA state page is an internal PodWiki page which is implemented directly by PodWiki itself. Such pages can not be modified by you or your users (unless you want to edit PodWiki's source code). Every state page link must begin with intern: or state:. The following states are avialable at the moment: * search - execute a search * newest - show the newest pages * pageindex - show the page index * fileindex - show uploaded files (images with thumbnail) * login - show the login box Sample: LE<lt>intern:login> |
|
Links to external websitesL<http://www.daemon.de> |
|
Display Text of Link(instead of the link target itself you can choose another text to be displayed): L<Daemon Home|http://www.daemon.de> |
|
Interwiki LinksPodWiki provides interwiki links. Precede a page link with the name of a known wiki (refer to http://usemod.com/intermap.txt for the current list!) delimited by colon. L<WikiPedia:PodWiki> |
PodWikiMarkup |
What you get |
---|---|
Include PodWiki PagesYou can use this feature to load another PodWiki page at this position. PodWiki will render the requested page and print its content at this position. The whole PodWiki is based on this system. PodWiki itself only loads AutoLoad, which includes several further include directives, and so on. Open AutoLoad with the editor and you will get the point. P<PodWikiAbout> |
P<PodWikiAbout?> |
Include PodWiki interactive STATE pagesA state page is an internal PodWiki page which is implemented directly by PodWiki itself. Such pages can not be modified by you or your users (unless you want to edit PodWiki's source code). Every state page inlcude command must begin with intern: or state:. The following states are avialable at the moment:
|
|
Include External WebpagesPodWiki can also load external webpages instead of PodWiki pages. Just replace the page name with an uri which starts with http://: Please note that the complete head tag will be removed to protect the page design of PodWiki. Also body and html tags will be removed. P<http://www.bankleitzahlen.de/ibanrechner.php> |