Chris Dent > PurpleWiki-0.94 > purple

Download:
PurpleWiki/PurpleWiki-0.94.tar.gz

Annotate this POD

CPAN RT

Open  0
Report a bug
Source  

NAME ^

purple - Document authoring system

SYNOPSIS ^

  purple --add_ids [--url=URL] /path/to/wikidb F<inputFile.wiki>

  purple [--add_ids] [--driver=driverName] [--css=stylesheet] [--url=URL] \
    /path/to/wikidb F<inputFile.wiki> F<output.[txt|html]>

OPTIONS ^

--add_ids

Add node IDs to the input file.

--driver=driverName

Use driverName as the View driver.

--css=stylesheet

Use stylesheet as the CSS stylesheet for HTML output.

--url=URL

The URL of the document. This is used to maintain an index of node IDs and URLs, so that PurpleWiki can find the exact URL using only the NID.

DESCRIPTION ^

Add and maintain purple numbers to a WikiText source document, and generate text and HTML output files.

AUTHORING PROCESS ^

1. Write your document using WikiText formatting.

2. When you're ready to add purple numbers, do:

  purple --add_ids inputFile.wiki

where inputFile.wiki is your document.

3. When you're ready to generate a text version, do:

  purple inputFile.wiki outputFile.txt

where outputFile.txt is the name of the output file. For an HTML version, do:

  purple inputFile.wiki outputFile.html

To combine steps 2 and 3, do:

  purple --add_ids inputFile.wiki outputFile.html

4. When you edit inputFile.wiki, don't touch the [nid] metatags. If you add new content, run purple --add_ids again.

AUTHORS ^

Chris Dent, <cdent@blueoxen.org>

Eugene Eric Kim, <eekim@blueoxen.org>