ASCIIDoc headers can be written in two ways: with differing underlines or with different indentation using = (equals sign). ASCIIDoc supports headings 1-4. The editor will automatically use the = notation. To create a level one header, prefix your line with one =. Level two headers are created with == and so on.
To display text as bold, wrap the text in * (asterisks). To display text as italic, wrap the text in _ (underscores). To create monospace text, wrap the text in + (plus signs).'
+ },
+ {
+ menuName: 'Scripts',
+ data: '
Superscript and subscript is created the same way as other inline formats. To create superscript text, wrap your text in ^ (carats). To create subscript text, wrap your text in ~ (tildes).
ASCIIDoc will automatically convert textual representations of commonly-used special characters. For example, (R) becomes ®, (C) becomes © and (TM) becomes ™.
ASCIIDoc allows paragraphs to have optional titles or icons to denote special sections. To make a normal paragraph, simply add a line between blocks and a new paragraph will start. If you want to title your paragraphs, adda line prefixed by . (full stop). An example paragraph with optional title is displayed below:.Optional Title
This is my paragraph. It is two sentences long.
To create source blocks (long blocks of code), follow the same syntax as above but with an extra line denoting the inline source and lines of four dashes (----) delimiting the source block.. An example of Python source is below:.python.py
[source,python]
----
# i just wrote a comment in python
# and maybe one more
----
Comment blocks are useful if you want to keep notes for yourself inline but do not want them displayed to the public. To create a comment block, simply wrap the paragraph in dividers with four slashes (////). An example comment block is below:////
My comment block is here now
It can be multiple paragraphs. Really.
////
Quote blocks work much like comment blocks — simply create dividers using four underscores (____) around your quote. An example quote block is displayed below:____
This is my quote block. Quote something nice here, otherwise there is no point in quoting.
____
To create links to external pages, you can simply write the URI if you want the URI to link to itself. (i.e., http://github.com/ will automatically be parsed to http://github.com/. If you want different text to be displayed, simply append it to the end of the URI in between [ (brackets.) For example, http://github.com/[GitHub] will be parsed as GitHub, with the URI pointing to http://github.com.
Images in ASCIIDoc work much like hyperlinks, but image URLs are prefixed with image:. For example, to link to an image at images/icons/home.png, write image:images/icons/home.png. Alt text can be added by appending the text to the URI in [ (brackets).
All command paragraphs start with = (equals sign).
To create headings 1 through 4, begin your command paragraph with =headN, where N is the number of the heading 1 through 4. For example, to make a first-order heading (the largest possible,) write =head1, then on the next line begin your paragraph that you want under the heading.
Perl pod blocks should begin with =pod and end with =cut, signifying to Pod parsers that the pod block has begun and ended. These command paragraphs only signal the beginning and end of a pod block.
Formatting text as bold, italic or code works in the S<word> syntax, where S is an abbreviation for the type of text you are trying to create. For example, B<my bold text> becomes my bold text, I<italic text> becomes italic text and C<code here()> becomes code here().
Writing hyperlinks in pod is much like formatting text, using the same S<> syntax. Instead of B, I or C, use L to begin a hyperlink.
pod allows you to hyperlink to a man page, a Perl documentation page, or another web page. To link to a man or Perl documentation page, simply include the page name in the link (e.g. L<perl(1)> or L<Net::Ping>). If you want to link to a web page, separate the URL and the link text with a pipe (e.g. to link to github.com, write L<GitHub|http://github.com/>).'
- }
- ]
- }
+ menuName: 'Formatting',
+ content: [
+ {
+ menuName: 'Text',
+ data: '
Formatting text as bold, italic or code works in the S<word> syntax, where S is an abbreviation for the type of text you are trying to create. For example, B<my bold text> becomes my bold text, I<italic text> becomes italic text and C<code here()> becomes code here().
Writing hyperlinks in pod is much like formatting text, using the same S<> syntax. Instead of B, I or C, use L to begin a hyperlink.
pod allows you to hyperlink to a man page, a Perl documentation page, or another web page. To link to a man or Perl documentation page, simply include the page name in the link (e.g. L<perl(1)> or L<Net::Ping>). If you want to link to a web page, separate the URL and the link text with a pipe (e.g. to link to github.com, write L<GitHub|http://github.com/>).'
+ }
+ ]
}
];