PodWiki Markup Documentation

PodWiki uses [ilink] 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:

Table of contents

    PodWiki Markup Documentation
        PodWiki Markup Examples/Overview
            Lists
                Bullet List
                Numbered List
                Text List (indended 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
            Hyperlinks
                Links to PodWiki pages
                Links to PodWiki interactive STATE pages
                Links to external websites
                Display Text of Link
            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
            External Formatters
                HTML formatter
                TEXT formatter
                PERL formatter
                COMMENT formatter
                OPTIONS formatter
            Variables

 

PodWiki Markup Examples/Overview

Take a look on this table to get an overview of what is possible in PodWiki and
how it is done.

Lists

+-----------------------------------------------------------------------------+
|                  PodWikiMarkup                   |       What you get       |
|--------------------------------------------------+--------------------------|
| Bullet List                                      |                          |
|                                                  |                          |
|  =over                                           |                          |
|                                                  |                          |
|  =item *                                         |                          |
|                                                  |                          |
|  entry 1 entry 1                                 |                          |
|                                                  |                          |
|  =item *                                         |                          |
|                                                  |                          |
|  entry 2 entry 2                                 |   * entry 1 entry 1      |
|                                                  |                          |
|  =back                                           |   * entry 2 entry 2      |
|--------------------------------------------------+--------------------------|
| Numbered List                                    |                          |
|                                                  |                          |
|  =over                                           |                          |
|                                                  |                          |
|  =item 1.                                        |                          |
|                                                  |                          |
|  entry 1 entry 1                                 | 1.                       |
|                                                  |                          |
|  =item 2.                                        |     entry 1 entry 1      |
|                                                  |                          |
|  entry 2 entry 2                                 | 2.                       |
|                                                  |                          |
|  =back                                           |     entry 2 entry 2      |
|--------------------------------------------------+--------------------------|
| Text List (indended text)                        |                          |
|                                                  |                          |
|  =over 4                                         |                          |
|                                                  |                          |
|  =item Term to describe1                         |                          |
|                                                  |                          |
|  Describing text2.                               | Term to describe1        |
|                                                  |                          |
|  =item Term to describe2                         |     Describing text2.    |
|                                                  |                          |
|  Describing text2.                               | Term to describe2        |
|                                                  |                          |
|  =back                                           |     Describing text2.    |
|--------------------------------------------------+--------------------------|
| You can also make nested lists and mix list      |                          |
| types                                            |                          |
|                                                  |                          |
|  =over                                           |                          |
|                                                  |                          |
|  =item *                                         |                          |
|                                                  |                          |
|  entry 1                                         |                          |
|                                                  |                          |
|  =item *                                         |                          |
|                                                  |                          |
|  =over                                           |                          |
|                                                  |                          |
|  =item 1.                                        |                          |
|                                                  |                          |
|  1. entry                                        |                          |
|                                                  |                          |
|  =item 2.                                        |                          |
|                                                  |   * entry 1              |
|  =over 4                                         |                          |
|                                                  |   *                      |
|  =item term1                                     |     1.                   |
|                                                  |                          |
|  description1                                    |         1. entry         |
|                                                  |                          |
|  =item term2                                     |     2.                   |
|                                                  |                          |
|  description2                                    |         term1            |
|                                                  |                          |
|  =back                                           |             description1 |
|                                                  |                          |
|  =back                                           |         term2            |
|                                                  |                          |
|  =back                                           |             description2 |
+-----------------------------------------------------------------------------+

Headings

+-----------------------------------------------------------------------------+
|                PodWikiMarkup                |         What you get          |
|---------------------------------------------+-------------------------------|
|  =head1 Heading 1                           | Heading 1                     |
|---------------------------------------------+-------------------------------|
|  =head2 Heading 2                           | Heading 2                     |
|---------------------------------------------+-------------------------------|
|  =head3 Heading 3                           | Heading 3                     |
|---------------------------------------------+-------------------------------|
|  =head4 Heading 4                           | Heading 4                     |
+-----------------------------------------------------------------------------+

Text Formattings

+------------------------------------------------------------------------------------------+
|                 PodWikiMarkup                 |               What you get               |
|-----------------------------------------------+------------------------------------------|
| Bold Text                                     |                                          |
|                                               |                                          |
|  B<some text>                                 | some text                                |
|-----------------------------------------------+------------------------------------------|
| Italic Text                                   |                                          |
|                                               |                                          |
|  I<some text>                                 | some text                                |
|-----------------------------------------------+------------------------------------------|
| Code                                          |                                          |
|                                               |                                          |
|  C<chmod 751 /etc>                            | chmod 751 /etc                           |
|-----------------------------------------------+------------------------------------------|
| Preformatted Text                             |                                          |
|                                               |                                          |
| (prepend each line with one whitespace)       |                                          |
|                                               |                                          |
|   if(blah)                                    |  if(blah)                                |
|    abort();                                   |   abort();                               |
|-----------------------------------------------+------------------------------------------|
| Avoid linebreaks                              |                                          |
|                                               |                                          |
|  S<This text will appear on one single line>  | This text will appear on one single line |
|-----------------------------------------------+------------------------------------------|
| Character Entities                            |                                          |
|                                               |                                          |
| You can use HTML4.0 specification character   |                                          |
| entity names here.                            |                                          |
|                                               |                                          |
|  E<copy>                                      |                                         |
+------------------------------------------------------------------------------------------+

Hyperlinks

Links are working as in standard POD but PodWiki doesn't know manpages, it
considers such links as "[ilink] WikiWords" or: as internal PodWiki links.

+-----------------------------------------------------------------------------+
|                   PodWikiMarkup                    |      What you get      |
|----------------------------------------------------+------------------------|
| Links to PodWiki pages                             |                        |
|                                                    |                        |
| Link to an existing page:                          |                        |
|                                                    | Existing page:         |
|  L<PodWikiIndex>                                   |                        |
|                                                    | [ilink] PodWikiIndex   |
| Link to a non-existing page (this is the way you   |                        |
| create new pages, btw.):                           | Non-existing page:     |
|                                                    |                        |
|  L<YetAnotherPodWikiPage>                          | YetAnotherPodWikiPage? |
|----------------------------------------------------+------------------------|
| Links to PodWiki interactive STATE pages           |                        |
|                                                    |                        |
| A 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                  |                        |
|                                                    |                        |
| * login - show the login box                       |                        |
|                                                    |                        |
| Sample:                                            |                        |
|                                                    |                        |
|  L<intern:login>                                   | [ilink] intern:login   |
|----------------------------------------------------+------------------------|
| Links to external websites                         |                        |
|                                                    | [elink] http://        |
|  L<http://www.daemon.de>                           | 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>               | [elink] Daemon Home    |
+-----------------------------------------------------------------------------+

Include Pages

+-----------------------------------------------------------------------------+
|                   PodWikiMarkup                   |      What you get       |
|---------------------------------------------------+-------------------------|
| Include PodWiki Pages                             |                         |
|                                                   |                         |
| You can use this feature to load another PodWiki  |                         |
| page at this position. PodWiki will render the    | This site is driven by  |
| requested page and print its content at this      | [elink] PodWiki.        |
| position.                                         |                         |
|                                                   | PodWiki is  2003 by    |
| The whole PodWiki is based on this system.        | [elink] Thomas Linden.  |
| PodWiki itself only loads AutoLoad, which         |                         |
| includes several further include directives, and  | You can download        |
| so on. Open AutoLoad with the editor and you will | PodWiki and see the     |
| get the point.                                    | Changelog here: [elink] |
|                                                   | http://www.daemon.de/   |
|  P<PodWikiAbout>                                  | podwiki/download/.      |
|---------------------------------------------------+-------------------------|
| Include PodWiki interactive STATE pages           |                         |
|                                                   |                         |
| A 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: |                         |
|                                                   |                         |
| * state - the core engine of PodWiki. This state  |                         |
| must be called everytimes. Take a look at the     |                         |
| AutoLoad Page which makes use of this one. If you |                         |
| do not include this, PodWiki will not work at     |                         |
| all!                                              |                         |
|                                                   |                         |
| * edit_bar - display the edit bar which provides  |                         |
| links to edit the current document and to the     |                         |
| revision control info box.                        |                         |
|                                                   |                         |
| * toc - show the table of contents (build from    |                         |
| all =head tags).                                  |  login  Last modified: |
|                                                   |     Mon Oct 13 22:43:52 |
| Sample:                                           |  2003. Revision: 1.1   |
|                                                   |         EditThisPage   |
|  P<intern:edit_bar>                               |           InfoAboutPage |
|---------------------------------------------------+-------------------------|
|                                                   | Bankleitzahlensuche     |
|                                                   | IBAN-Prfer             |
|                                                   |                         |
|                                                   |      IBAN-Rechner       |
|                                                   |                         |
|                                                   | Bankleitzahl [        ] |
|                                                   |       Kontonummer       |
|                                                   |      [          ]       |
|                                                   |       [Berechnen]       |
| Include External Webpages                         |                         |
|                                                   |        Hinweis:         |
| PodWiki can also load external webpages instead   | Nur die jeweilige Bank  |
| of PodWiki pages. Just replace the page name with |  kann offizielle IBANs  |
| an uri which starts with http://:                 |   berechnen, deswegen   |
|                                                   |  wird keinerlei Gewhr  |
| Please note that the complete head tag will be    |       bernommen.       |
| removed to protect the page design of PodWiki.    | Es knnen nur deutsche  |
| Also body and html tags will be removed.          | IBANs berechnet werden. |
|                                                   |                         |
|  P<http://www.bankleitzahlen.de/ibanrechner.php>  |   Was ist eine IBAN ?   |
+-----------------------------------------------------------------------------+

Graphics

+-----------------------------------------------------------------------------+
|                                                                  | What you |
|                          PodWikiMarkup                           |   get    |
|------------------------------------------------------------------+----------|
| Show an image                                                    |          |
|                                                                  |          |
| (you can upload images to PodWiki from the editor form! If you   |          |
| intent to use uploaded graphics do not use path specifications,  |          |
| just the filename.)                                              |          |
|                                                                  |          |
|  G<daemon.png>                                                   | [daemon] |
|------------------------------------------------------------------+----------|
| Specify an ALT text attribute for a graphic                      |          |
|                                                                  | daemon   |
|  G<daemon.png|daemon home>                                       | home     |
|------------------------------------------------------------------+----------|
| Graphic Links                                                    |          |
|                                                                  | [elink]  |
|  L<G<daemon.png>|http://www.daemon.de>                           | [daemon] |
+-----------------------------------------------------------------------------+

External Formatters

In perl POD you can use =begin [formatter] to indicate that the following text
has to be rendered by an external "formatter". A "formatter" is a special
render mode which directly influences PodWiki how it displays the content
inside a special formatter block. PodWiki supports this feature and understands
the following formatters:

+-----------------------------------------------------------------------------+
|                PodWikiMarkup                 |         What you get         |
|----------------------------------------------+------------------------------|
| HTML formatter                               |                              |
|                                              |                              |
| The formatter for 'html' keeps the text 1:1  |                              |
| as you wrote it. You can use it to insert    |                              |
| plain HTML code, a table for instance, which |                              |
| is not directly supported by POD.            |                              |
|                                              |                              |
|  =begin html                                 |                              |
|                                              |                              |
|  <center>centered text</center>              |                              |
|                                              |                              |
|  =end                                        |        centered text         |
|----------------------------------------------+------------------------------|
| TEXT formatter                               |                              |
|                                              |                              |
| This formatter works similar to the 'html'   |                              |
| formatter but it inserts the text between    |                              |
| pre tags. Use this for code snippets or the  |                              |
| like.                                        |                              |
|                                              |                              |
| txt or ascii can also be used as synonyms    |                              |
| for text.                                    |                              |
|                                              |                              |
|  =begin txt                                  |                              |
|  if(online) {                                |                              |
|    inet_fd->disconnect();                    | if(online) {                 |
|  }                                           |   inet_fd->disconnect();     |
|  =end                                        | }                            |
|----------------------------------------------+------------------------------|
| PERL formatter                               |                              |
|                                              |                              |
| The 'perl' formatter allows you to insert    |                              |
| perl code into your WikiPage which gets      |                              |
| evaluated by PodWiki. This feature makes     |                              |
| PodWiki a very powerfull tool. You can use   |                              |
| it for example to add a formular to your     |                              |
| PodWiki site.                                |                              |
|                                              |                              |
| You must print to STDOUT what have to be     |                              |
| displayed on the page.                       |                              |
|                                              |                              |
|  =begin perl                                 |                              |
|  print scalar localtime(time);               |                              |
|  =end                                        | <enable_perl_formatter::OFF> |
|----------------------------------------------+------------------------------|
| COMMENT formatter                            |                              |
|                                              |                              |
| Everything inside a comment block will not   |                              |
| rendered by PodWiki at all.                  |                              |
|                                              |                              |
|  =begin comment                              |                              |
|  This will not be shown.                     |                              |
|  =end                                        |                              |
|----------------------------------------------+------------------------------|
| OPTIONS formatter                            |                              |
|                                              |                              |
| Everything inside an options block will not  |                              |
| rendered by PodWiki but instead used to      |                              |
| control its behavior.                        |                              |
|                                              |                              |
| Currently only [ilink] Authentication        |                              |
| options are supported.                       |                              |
|                                              |                              |
|  =begin options                              |                              |
|  read  = root                                |                              |
|  write = root                                |                              |
|  =end                                        |                              |
+-----------------------------------------------------------------------------+

Variables

You can insert some predefined variables somewhere in your pages. A variable
must begin with the dollar character!

The following variables are supported at the moment:

me - the scriptname of PodWiki, usefull for building uri's.

page - the name of the current PodWikiPage.

