PodWiki Markup Documentation

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

 

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.

For the impatient: visit the PodWikiSample page which shows most of the features.

Lists

PodWikiMarkup

What you get

Bullet List

 =over
 
 =item *
 
 entry 1 entry 1
 
 =item *
 
 entry 2 entry 2
 
 =back 
  • entry 1 entry 1

  • entry 2 entry 2

Numbered List

 =over
 
 =item 1.
 
 entry 1 entry 1
 
 =item 2.
 
 entry 2 entry 2
 
 =back 
1.

entry 1 entry 1

2.

entry 2 entry 2

Text List (indented text)

 =over 4
 
 =item Term to describe1
 
 Describing text2.
 
 =item Term to describe2
 
 Describing text2.
 
 =back 
Term to describe1

Describing text2.

Term to describe2

Describing text2.

You can also make nested lists and mix list types

 =over
 
 =item *
 
 entry 1
 
 =item *
 
 =over
 
 =item 1.
 
 1. entry
 
 =item 2.
 
 =over 4
 
 =item term1
 
 description1
 
 =item term2
 
 description2
 
 =back
 
 =back
 
 =back 
  • entry 1

  • 1.

    1. entry

    2.
    term1

    description1

    term2

    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)
   abort(); 
 if(blah)
  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> 

Horizontal lines

Insert a horizontal line in a page using a single paragraph (at least one newline before and after it) just consisting of one or more dashes:

 --- 

Hyperlinks

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 pages

Link 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:

Index

Non-existing page:

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

* fileindex - show uploaded files (images with thumbnail)

* login - show the login box

Sample:

 LE<lt>intern:login> 

intern:login

Links to external websites

 L<http://www.daemon.de> 

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> 

Daemon Home

Interwiki Links

PodWiki 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> 

WikiPedia:PodWiki

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 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 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.

Sample:

 PE<lt>intern:edit_bar> 
toc

Show the table of contents (built from all =head tags).

toc_by_attribute

Show table of all pages matching an attribute. Just add the attribute/value as CGI param to the state, e.g.:

 PE<lt>intern:toc_by_attribute?topic=Main> 
comments

Includes the comment feature to a page. The recommended position where to include this state is the end of a page. All posted comments will be displayed. Visitors are able to post new comments and it is possible to reply to a comment.

The root-User is able to remove comments. Just login as root, visit the page where the comment to be removed is posted and click the "remove comment" link.

Comments can be written in PodWikiMarkup or WikiShorthand markup.

cloud

Shows a tag cloud of all indexed words of all pages.

tags_per_page

Lists all tags of current page.

Include External Webpages

PodWiki 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> 
Content-type: text/html

Software error:

Insecure dependency in connect while running with -T switch at /usr/lib/perl5/5.8.0/i386-linux-thread-multi/IO/Socket.pm line 114.

For help, please send mail to the webmaster (support@wiki.diamondcard.us), giving this error message and the time and date of the error.