.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Text::WikiCreole 3pm" .TH Text::WikiCreole 3pm "2017-09-07" "perl v5.26.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Text::WikiCreole \- Convert Wiki Creole 1.0 markup to XHTML .SH "VERSION" .IX Header "VERSION" Version 0.07 .SH "DESCRIPTION" .IX Header "DESCRIPTION" Text::WikiCreole implements the Wiki Creole markup language, version 1.0, as described at http://www.wikicreole.org. It reads Creole 1.0 markup and returns \s-1XHTML.\s0 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Text::WikiCreole; \& creole_plugin \e&myplugin; # register custom plugin parser \& \& my $html = creole_parse($creole_text); \& ... .Ve .SH "FUNCTIONS" .IX Header "FUNCTIONS" .SS "creole_parse" .IX Subsection "creole_parse" .Vb 2 \& Self\-explanatory. Takes a Creole markup string argument and \& returns HTML. .Ve .SS "creole_plugin" .IX Subsection "creole_plugin" .Vb 2 \& Creole 1.0 supports two plugin syntaxes: << plugin content >> and \& <<< plugin content >>> \& \& Write a function that receives the text between the <<>> \& delimiters as $_[0] (and not including the delimiters) and \& returns the text to be displayed. For example, here is a \& simple plugin that converts plugin text to uppercase: \& \& sub uppercase_plugin { \& $_[0] =~ s/([a\-z])/\eu$1/gs; \& return $_[0]; \& } \& creole_plugin \e&uppercase_plugin; \& \& If you do not register a plugin function, plugin markup will be left \& as is, including the surrounding << >>. .Ve .SS "creole_link" .IX Subsection "creole_link" .Vb 2 \& You may wish to customize [[ links ]], such as to prefix a hostname, \& port, etc. \& \& Write a function, similar to the plugin function, which receives the \& URL part of the link (with leading and trailing whitespace stripped) \& as $_[0] and returns the customized link. For example, to prepend \& "http://my.domain/" to pagename: \& \& sub mylink { \& return "http://my.domain/$_[0]"; \& } \& creole_link \e&mylink; .Ve .SS "creole_customlinks" .IX Subsection "creole_customlinks" .Vb 5 \& If you want complete control over links, rather than just modifying \& the URL, register your link markup function with creole_link() as above \& and then call creole_customlinks(). Now your function will receive the \& entire link markup chunk, such as [[ some_wiki_page | page description ]] \& and must return HTML. \& \& This has no effect on "bare" link markup, such as http://cpan.org. .Ve .SS "creole_barelink" .IX Subsection "creole_barelink" .Vb 1 \& Same purpose as creole_link, but for "bare" link markup. \& \& sub mybarelink { \& return "$_[0].html"; \& } \& creole_barelink \e&mybarelink; .Ve .SS "creole_custombarelinks" .IX Subsection "creole_custombarelinks" .Vb 1 \& Same purpose as creole_customlinks, but for "bare" link markup. .Ve .SS "creole_img" .IX Subsection "creole_img" .Vb 1 \& Same purpose as creole_link, but for image URLs. \& \& sub myimg { \& return "http://my.comain/$_[0]"; \& } \& creole_img \e&myimg; .Ve .SS "creole_customimgs" .IX Subsection "creole_customimgs" .Vb 1 \& Similar to creole_customlinks, but for images. .Ve .SS "creole_tag" .IX Subsection "creole_tag" .Vb 3 \& You may wish to customize the opening and/or closing tags \& for the various bits of Creole markup. For example, to \& assign a CSS class to list items: \& \& creole_tag("li", "open", "
  • "); \& \& Or to see all current tags: \& \& print creole_tag(); \& \& The tags that may be of interest are: \& \& br dd dl \& dt em h1 \& h2 h3 h4 \& h5 h6 hr \& ilink img inowiki \& ip li link \& mono nowiki ol \& p strong sub \& sup table td \& th tr u \& ul \& \& Those should be self\-explanatory, except for inowiki (inline nowiki), \& ilink (bare links, e.g. http://www.cpan.org), and ip (indented paragraph). .Ve .SH "OFFICIAL MARKUP" .IX Header "OFFICIAL MARKUP" .Vb 3 \& Here is a summary of the official Creole 1.0 markup \& elements. See http://www.wikicreole.org for the full \& details. \& \& Headings: \& = heading 1 \->

    heading 1

    \& == heading 2 \->

    heading 2

    \& ... \& ====== heading 6 \->
    heading 6
    \& \& Various inline markup: \& ** bold ** \-> bold \& // italics // \-> italics \& **// both //** \-> both \& [[ link ]] \-> link \& [[ link | text ]] \-> text \& http://cpan.org \-> http://cpan.org \& line \e\e break \-> line
    break \& {{img.jpg|alt}} \-> alt \& \& Lists: \& * unordered list \& \& Tables: \& |= h1 |= h2 \-> \& | c1 | c2
    h1h2
    c1c2
    \& \& Nowiki (Preformatted): \& {{{ 
    \&      ** not bold **          ** not bold **
\&      escaped HTML:   \->      escaped HTML:
\&       test            <i> test </i>
\&    }}}                     
    \&
\&    {{{ inline\e\ealso }}} \-> inline\e\ealso
\&
\&    Escape Character:
\&    ~** not bold **    \->    ** not bold **
\&    tilde: ~~          \->    tilde: ~
\&
\&    Paragraphs are separated by other blocks and blank lines.  
\&    Inline markup can usually be combined, overlapped, etc.  List
\&    items and plugin text can span lines.
.Ve
.SH "EXTENDED MARKUP"
.IX Header "EXTENDED MARKUP"
.Vb 2
\&    In addition to OFFICIAL MARKUP, Text::WikiCreole also supports
\&    the following markup:
\&
\&    Plugins:
\&    << plugin >>        \->    whatever you want (see creole_plugin above)
\&    <<< plugin >>>      \->    whatever you want (see creole_plugin above)
\&        Triple\-bracket syntax has priority, in order to allow you to embed
\&        double\-brackets in plugins, such as to embed Perl code.
\&
\&    Inline:
\&    ## monospace ##     \->     monospace 
\&    ^^ superscript ^^   \->     superscript 
\&    ,, subscript ,,     \->     subscript 
\&    _\|_ underline _\|_     \->     underline 
\&    (TM)                \->    ™
\&    (R)                 \->    ®
\&    (C)                 \->    ©
\&    ...                 \->    …
\&    \-\-                  \->    –
\&
\&    Indented Paragraphs:
\&    :this               \->    
    this
\&    is indented               is indented
    
\&    :: more indented          
     more
\&                              indented
    
\&
\&    Definition Lists:
\&    ; Title             \->    
    Title
    
\&    : item 1 : item 2         
    item 1
    item 2
    
\&    ; Title 2 : item2a        
    Title 2
    item 2a
    
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Jason Burnett, \f(CW\*(C`\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-text\-wikicreole at rt.cpan.org\*(C'\fR, or through the web interface at
.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Text::WikiCreole
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp

.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp

.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp

.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp

.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
The parsing algorithm is basically the same as (and inspired by)
the one in Document::Parser.  Document::Parser is \s-1OO\s0 and is, 
as such, incompatible with my brain.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2007 Jason Burnett, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.