== Introduction == This is where you should write a bit about what you will be showing in the tutorial. == Prerequisites == Explain what you expect users to know before starting, possibly by linking to other tutorials that explain the prerequisites. == Tutorial == Here you can describe the tutorial steps. You can structure content in sections and sub-sections, like this: === Section === ------ Some fixed size font text: could be source code, command, etc ------ And this is how we highlight a `keyword` in a sentence. Text can be made _italic_, *bold*, or +mono-spaced+. Lists could not be easier, as seen below. .Optional list title: - Item 1 - Another item To quote someone, you can choose between ``double quoted'' or `single-quoted' apostrophes. It is also possible to use bars -- like this. Quotations can be also given in block, including the author and source, as below: [quote, Oscar Wilde, Unknown source] ____ I can believe anything provided it is incredible. ____ === Another Section === We can write superscript and subscript: H~2~O, A^B^. And also use a few symbols: A -> B, A => B. This is how links to tutorials are made: tutorial:Sandbox[Visible text]. Make sure to replace `Sandbox' with the tutorial identifier you need. External links can be added like this: http://tutorialpedia.org[Tutorialpedia] ==== And a Sub-section ==== In this sub-section, we show how to embed PHP Code: [code,php] ------ <?php // Remember to always use the open and closing symbols // for PHP Scripts. print "Hello World!"; ?> ------ == Conclusion == A brief of what was achieved in this tutorial.
New Syntax
We have introduced a new format for writing documents. Until we catch up with the documentation, we will provide a simple tutorial template below. You can also check out the Asciidoc help page for anything we have not included here: Cheat-Sheet, but note that we only support a subset of the syntax shown there.
If you want to try out the editor, use the Sandbox page, where it doesn’t matter what you write.
Example:
Output:
Introduction
This is where you should speak about what you are showing in the tutorial.
Prerequisites
What you expect users to know before starting. Links to other tutorials that explain the prerequisites.
Tutorial
Here you can describe what users have to do. You can structure content in sections and sub-sections, like this:
Section
Some fixed size font text: could be source code, command, etc
And this is how we highlight a keyword in a sentence. Text can be made italic, bold, or mono-spaced. Lists could not be easier, as seen below.
Optional list title:
-
Item 1
-
Another item
To quote someone, you can choose between “double quoted” or ‘single-quoted’ apostrophes. It is also possible to use bars — like this. Quotations can be also given in block, including the author and source, as below:
I can believe anything provided it is incredible.
Unknown source
— Oscar Wilde
— Oscar Wilde
Another Section
We can write superscript and subscript: H2O, AB. And also use a few symbols: A → B, A ⇒ B. This is how links to tutorials are made: Visible text. Make sure to replace ‘Sandbox’ with the tutorial identifier you need. External links can be added like this: Tutorialpedia
And a Sub-section
In this sub-section, we show how to embed PHP Code:
<?php // Remember to always use the open and closing symbols // for PHP Scripts. print "Hello World!"; ?>
Conclusion
A brief of what was achieved in this tutorial.