Ticket #2296: WikiFormatting.tex

\documentclass{article}
\usepackage{url}
\usepackage{ulem}
\usepackage[pagebackref, bookmarks, pdfpagelabels,
    citecolor=black, linkcolor=black, anchorcolor=blue, filecolor=black,
    bookmarksopen=true, plainpages=false, colorlinks=true, bookmarksnumbered=true,
    pdftitle={WikiFormatting},
    pdfauthor={userid}]{hyperref}
\newcommand{\anchortext}[1]{\def\ULthickness{.2pt}\underbar{#1}\def\ULthickness{.4pt}} %this does not appear to work properly
\newcommand{\mypercent}{\%{}}
\newcommand{\myamp}{\&{}}
\setlength\parskip{\medskipamount}
\setlength\parindent{0pt}
\begin{document}
\section{\label{sub:WikiFormatting}WikiFormatting}

\subsection{\label{anchor:WikiFormatting}WikiFormatting}



Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.


Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis,
especially \anchortext{MoinMoin}\footnote{\url{http://moinmoin.wikiwikiweb.de/}}. 


This page demonstrates the formatting syntax available anywhere \anchortext{WikiFormatting} (\S\ref{sub:WikiFormatting}) is allowed.


\subsubsection{\label{anchor:Font-Styles}Font Styles}


The Trac wiki supports the following font styles:
\begin{verbatim}
 * '''bold'''
 * ''italic''
 * '''''bold italic'''''
 * __underline__
 * {{{monospace}}} or `monospace`
 * ~~strike-through~~
 * ^superscript^ 
 * ,,subscript,,
\end{verbatim}


Display:

\begin{itemize}
\item \textbf{bold}
\item \textit{italic}
\item \textbf{\bfseries\itshape bold italic}
\item \underbar{underline}
\item \texttt{monospace} or \texttt{monospace}
\item \sout{strike-through}
\item $^{superscript}$ 
\item $_{subscript}$
\end{itemize}

Note that the \texttt{{{{...}}}} and \texttt{`...`} commands not only select a monospace font, but also treat their content as verbatim text, meaning that no further wiki processing is done on this text.


\subsubsection{\label{anchor:Headings}Headings}


You can create heading by starting a line with one up to five \textit{equal} characters (``='')
followed by a single space and the headline text. The line should end with a space 
followed by the same number of \textit{=} characters.


Example:
\begin{verbatim}
= Heading =
== Subheading ==
=== About ''this'' ===
\end{verbatim}


Display:


\subsection{\label{anchor:Heading}Heading}


\subsubsection{\label{anchor:Subheading}Subheading}


\subsubsection*{\label{anchor:About-this}About ''this''}


\subsubsection{\label{anchor:Paragraphs}Paragraphs}


A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.


A forced line break can also be inserted, using:
\begin{verbatim}
Line 1[[BR]]Line 2
\end{verbatim}
Display:


Line 1\\Line 2


\subsubsection{\label{anchor:Lists}Lists}


The wiki supports both ordered/numbered and unordered lists.


Example:
\begin{verbatim}
 * Item 1
   * Item 1.1
 * Item 2

 1. Item 1
   1. Item 1.1
 1. Item 2
\end{verbatim}


Display:

\begin{itemize}
\item Item 1
\begin{itemize}
\item Item 1.1
\end{itemize}
\item Item 2
\end{itemize}
\begin{enumerate}
\item Item 1
\begin{enumerate}
\item Item 1.1
\end{enumerate}
\item Item 2
\end{enumerate}

Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.


\subsubsection{\label{anchor:Definition-Lists}Definition Lists}


The wiki also supports definition lists.


Example:
\begin{verbatim}
 llama::
   some kind of mammal, with hair
 ppython::
   some kind of reptile, without hair
   (can you spot the typo?)
\end{verbatim}


Display:
\begin{description}
\item[llama] 
some kind of mammal, with hair
\item[ppython] 
some kind of reptile, without hair
(can you spot the typo?)

\end{description}

Note that you need a space in front of the defined term.


\subsubsection{\label{anchor:Preformatted-Text}Preformatted Text}


Block containing preformatted text are suitable for source code snippets, notes and examples. Use three \textit{curly braces} wrapped around the text to define a block quote. The curly braces need to be on a separate line.
  
Example:
\begin{verbatim}
 {{{
  def HelloWorld():
      print "Hello World"
 }}}
\end{verbatim}


Display:
\begin{verbatim}
 def HelloWorld():
     print "Hello World"
\end{verbatim}


\subsubsection{\label{anchor:Blockquotes}Blockquotes}


In order to mark a paragraph as blockquote, indent that paragraph with two spaces.


Example:
\begin{verbatim}
  This text is a quote from someone else.
\end{verbatim}


Display:

\begin{quote}

This text is a quote from someone else.

\end{quote}

\subsubsection{\label{anchor:Tables}Tables}


Simple tables can be created like this:
\begin{verbatim}
||Cell 1||Cell 2||Cell 3||
||Cell 4||Cell 5||Cell 6||
\end{verbatim}


Display:

\begin{tabular}{|l|l|l|l|l|l|l|l|l|} \hline

Cell 1 & Cell 2 & Cell 3
~\\ \hline

Cell 4 & Cell 5 & Cell 6
~\\ \hline
\end{tabular}

Note that more complex tables can be created using
\anchortext{reStructuredText} (\S\ref{sub:WikiRestructuredText:BiggerReSTExample})\footnote{\url{wiki:WikiRestructuredText\#{}BiggerReSTExample}}.


\subsubsection{\label{anchor:Links}Links}


Hyperlinks are automatically created for \anchortext{WikiPageNames} (\S\ref{sub:WikiPageNames}) and URLs. WikiPageLinks can be disabled by prepending an exclamation mark ``!'' character, such as \texttt{!WikiPageLink}.


Example:
\begin{verbatim}
 TitleIndex, http://www.edgewall.com/, !NotAlink
\end{verbatim}


Display:

\begin{quote}

\anchortext{TitleIndex} (\S\ref{sub:TitleIndex}), \url{http:http://www.edgewall.com/}, NotAlink

\end{quote}

Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.  If the descriptive title is omitted, then the explicit prefix is disguarded, unless the link is an external link. This can be useful for wiki pages not adhering to the \anchortext{WikiPageNames} (\S\ref{sub:WikiPageNames}) convention.


Example:
\begin{verbatim}
 * [http://www.edgewall.com/ Edgewall Software]
 * [wiki:TitleIndex Title Index]
 * [wiki:ISO9000]
\end{verbatim}


Display:

\begin{itemize}
\item \anchortext{Edgewall Software}\footnote{\url{http://www.edgewall.com/}}
\item \anchortext{Title Index} (\S\ref{sub:TitleIndex})\footnote{\url{wiki:TitleIndex}}
\item \anchortext{ISO9000} (\S\ref{sub:ISO9000})
\end{itemize}

\subsubsection*{\label{anchor:Trac-Links}Trac Links}


Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations:
\begin{verbatim}
 * Tickets: #1 or ticket:1
 * Reports: {1} or report:1
 * Changesets: r1, [1] or changeset:1
 * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3
 * Wiki pages: CamelCase or wiki:CamelCase
 * Milestones: milestone:1.0 or milestone:"End-of-days Release"
 * Files: source:trunk/COPYING
 * Attachments: attachment:"file name.doc"
 * A specific file revision: source:/trunk/COPYING#200
 * A filename with embedded space: source:"/trunk/README FIRST"
\end{verbatim}


Display:

\begin{itemize}
\item \textless Bad Unicode on this line \textgreater
\item \textless Bad Unicode on this line \textgreater
\item Changesets: \anchortext{r1} (\S\ref{sub:r1}), \textless{}a class=``changeset'' title=``Iniitla improt

'' href=``/tracsvn/changeset/1``\textgreater{}[1]\textless{}/a\textgreater{} or \anchortext{changeset:1} (\S\ref{sub:changeset:1})
\item \textless Bad Unicode on this line \textgreater
\item Wiki pages: \anchortext{CamelCase} (\S\ref{sub:CamelCase}) or \anchortext{wiki:CamelCase} (\S\ref{sub:wiki:CamelCase})
\item Milestones: \anchortext{milestone:1.0} (\S\ref{sub:milestone:1.0}) or \anchortext{milestone:``End-of-days Release''} (\S\ref{sub:milestone:End-of-days-Release})
\item Files: \anchortext{source:trunk/COPYING} (\S\ref{sub:source:trunk/COPYING})
\item Attachments: \anchortext{attachment:``file name.doc''} (\S\ref{sub:attachment:file-name.doc})
\item A specific file revision: \anchortext{source:/trunk/COPYING\#{}200} (\S\ref{sub:source:/trunk/COPYING:200})
\item A filename with embedded space: \anchortext{source:``/trunk/README FIRST''} (\S\ref{sub:source:/trunk/README-FIRST})
\end{itemize}

See \anchortext{TracLinks} (\S\ref{sub:TracLinks}) for more in-depth information.


\subsubsection{\label{anchor:Escaping-Links-and-WikiPageNames}Escaping Links and WikiPageNames}


You may avoid making hyperlinks out of \anchortext{TracLinks} (\S\ref{sub:TracLinks}) by preceding an expression with a single ``!'' (exclamation mark).


Example:
\begin{verbatim}
 !NoHyperLink
 !#42 is not a link
\end{verbatim}


Display:

\begin{quote}

NoHyperLink
\#{}42 is not a link

\end{quote}

\subsubsection{\label{anchor:Images}Images}


Urls ending with \texttt{.png}, \texttt{.gif} or \texttt{.jpg} are automatically interpreted as image links, and converted to \texttt{\textless{}img\textgreater{}} tags.


Example:
\begin{verbatim}
http://www.edgewall.com/gfx/trac_example_image.png
\end{verbatim}


Display:


\url{http:http://www.edgewall.com/gfx/trac\_{}example\_{}image.png}


However, this doesn't give much control over the display mode. This way of inserting images is deprecated in favor of the more powerful \texttt{Image} macro (see \anchortext{WikiMacros} (\S\ref{sub:WikiMacros})).


\subsubsection{\label{anchor:Macros}Macros}


Macros are \textit{custom functions} to insert dynamic content in a page.


Example:
\begin{verbatim}
 [[Timestamp]]
\end{verbatim}


Display:

\begin{quote}

\begin{verbatim}
<b>Wed 10 May 2006 15:32:21 EST</b>
\end{verbatim}


\end{quote}

See \anchortext{WikiMacros} (\S\ref{sub:WikiMacros}) for more information, and a list of installed macros.


\subsubsection{\label{anchor:Processors}Processors}


Trac supports alternative markup formats using \anchortext{WikiProcessors} (\S\ref{sub:WikiProcessors}). For example, processors are used to write pages in 
\anchortext{reStructuredText} (\S\ref{sub:WikiRestructuredText})\footnote{\url{wiki:WikiRestructuredText}} or \anchortext{HTML} (\S\ref{sub:WikiHtml})\footnote{\url{wiki:WikiHtml}}. 


Example 1:
\begin{verbatim}
#!html
<pre class="wiki">{{{
#!html
&lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
}}}</pre>
\end{verbatim}


Display:
\begin{verbatim}
#!html
<h1 style="text-align: right; color: blue">HTML Test</h1>
\end{verbatim}


Example:
\begin{verbatim}
#!html
<pre class="wiki">{{{
#!python
class Test:
    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()
}}}</pre>
\end{verbatim}


Display:
\begin{verbatim}
#!python
class Test:
    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()
\end{verbatim}


Perl:
\begin{verbatim}
#!perl
my ($test) = 0;
if ($test > 0) {
echo "hello";
}
\end{verbatim}


See \anchortext{WikiProcessors} (\S\ref{sub:WikiProcessors}) for more information.


\subsubsection{\label{anchor:Miscellaneous}Miscellaneous}


Four or more dashes will be replaced by a horizontal line (\textless{}HR\textgreater{})


Example:
\begin{verbatim}
 ----
\end{verbatim}


Display:

{\normalsize \vspace{1ex} \hrule width \columnwidth \vspace{1ex}}
{\normalsize \vspace{1ex} \hrule width \columnwidth \vspace{1ex}}

See also: \anchortext{TracLinks} (\S\ref{sub:TracLinks}), \anchortext{TracGuide} (\S\ref{sub:TracGuide}), \anchortext{WikiHtml} (\S\ref{sub:WikiHtml}), \anchortext{WikiMacros} (\S\ref{sub:WikiMacros}), \anchortext{WikiProcessors} (\S\ref{sub:WikiProcessors}), \anchortext{TracSyntaxColoring} (\S\ref{sub:TracSyntaxColoring}).

\end{document}