WikiSyntax: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
[toc align_right= | [toc align_right="yes" depth="2"] | ||
'''English''' [[WikiSyntax_German|German]] [[WikiSyntax_Italian|Italiano]] [[WikiSyntax Hungarian|Magyar]] [[WikiSyntax_Spanish|Spanish]] [[WikiSyntax_SimplifiedChinese|简体中文]] | |||
= Wiki Syntax Help = | = Wiki Syntax Help = | ||
[[Category:General]] | [[Category:General]] | ||
[[Category:Help]] | |||
ExpressionEngine uses a special wiki syntax to perform a set of actions directly on the wiki. The actual formatting is done by [[TextileSyntax | Textile]]. (have a look on the external page too | ExpressionEngine uses a special wiki syntax to perform a set of actions directly on the wiki. The actual formatting is done by [[TextileSyntax | Textile]]. (have a look on the external page too "Textism: Tools: Textile":http://textism.com/tools/textile/index.php) | ||
This is only a very short introduction. If you want to learn the more advanced textile features, the [[TextileSyntax]] wiki page has all the information for you. | This is only a very short introduction. If you want to learn the more advanced textile features, the [[TextileSyntax]] wiki page has all the information for you. | ||
| Line 21: | Line 23: | ||
== Using Tables == | == Using Tables == | ||
Readability is enhanced if your markup indicates a title row and if you color the title row green and alternate entry rows with a light gray. | Readability is enhanced if your markup indicates a title row and if you color the title row green and alternate entry rows with a light gray. | ||
Note the space before the | designating beginning of a cell. | |||
</code>{background:#009900}. |''. Title 1 |''. Title 2 | | </code>{background:#009900}. |''. Title 1 |''. Title 2 | | ||
| somestuff in clear row| more stuff | | |||
{background:#ddd}. | some stuff in gray row | more stuff |<code> | |||
{background:#009900}. |''. Title 1 |''. Title 2 | | {background:#009900}. |''. Title 1 |''. Title 2 | | ||
| somestuff in clear row| more stuff | | |||
{background:#ddd}. | some stuff in gray row | more stuff | | |||
== Categories == | == Categories == | ||
</code>&#91;&#91;Category:Foo]]</code> will create a category with the title | </code>&#91;&#91;Category:Foo]]</code> will create a category with the title "Foo" along with an automatically populated ''Special Page'' with all pages in this category. If the category already exists it will sort the page into the indicated category. | ||
<code>&#91;&#91;Category:Foo::Bar]]<code> will create a child category | <code>&#91;&#91;Category:Foo::Bar]]<code> will create a child category "Bar" inside the parent category "Foo". | ||
=== Link to a Category Page === | === Link to a Category Page === | ||
| Line 39: | Line 46: | ||
== Add a Table of Contents == | == Add a Table of Contents == | ||
When a page is long, adding a table of contents can help a lot. You can control alignment and depth of the table. | When a page is long, adding a table of contents can help a lot. You can control alignment and depth of the table. | ||
<code> | |||
&#91;toc align_right="yes" depth="2"] | |||
</code> | </code> | ||
| Line 47: | Line 56: | ||
== Right aligned articles == | == Right aligned articles == | ||
For wiki pages you can add | For wiki pages you can add | ||
<code> | |||
&#91;right_aligned] | |||
</code> | |||
to the top of the page and it will be all right aligned on save. | to the top of the page and it will be all right aligned on save. | ||
| Line 53: | Line 65: | ||
== Character Codes, or How to Bypass the Wiki Formatter == | == Character Codes, or How to Bypass the Wiki Formatter == | ||
Sometimes you need a character in your wiki article that the wiki engine thinks is a formatting code. When this happens, replace the character with a code for the character. | Sometimes you need a character in your wiki article that the wiki engine thinks is a formatting code. When this happens, replace the character with a code for the character. "Here is a good list of such codes":http://www.degraeve.com/reference/specialcharacters.php. | ||
For example, in Textile the percent symbol (&#37;) indicates a | For example, in Textile the percent symbol (&#37;) indicates a <span> tag in HTML, but you may need to show a &#37; in a command line example. Use &amp;&#35;37; instead of &#37; in your example: | ||
Show: | Show: | ||
<code>set QTDIR=&#37;DEV&amp;#37;</code> | |||
By entering: | By entering: | ||
<code>set QTDIR=&amp;&#35;37;DEV&amp;amp;&#35;37;</code> | |||
== Embedding Youtube Videos == | == Embedding Youtube Videos == | ||
<code>[YouTubeID: | <code>[YouTubeID:<id>] | ||
</code> | |||
Revision as of 09:57, 25 February 2015
[toc align_right="yes" depth="2"] English German Italiano Magyar Spanish 简体中文
Wiki Syntax Help
ExpressionEngine uses a special wiki syntax to perform a set of actions directly on the wiki. The actual formatting is done by Textile. (have a look on the external page too "Textism: Tools: Textile":http://textism.com/tools/textile/index.php)
This is only a very short introduction. If you want to learn the more advanced textile features, the TextileSyntax wiki page has all the information for you.
Linking Pages
&#91;&#91;PageTitle]]<code> will link to a page with this title. If the page is not there yet you can create it by clicking the link. Please use camel case. This can also be used in the middle of a sentence like <code>This links to my [[AwesomeNewPage]] here.<code>
[[PageTitle | Display Title]] will create a link with an alternative title displayed as in This links to my awesome new page
Linking to Qt Documentation
&#91;&#91;Doc:ClassName]]<code> will link to the class page documentation of the latest Qt version, and show the class description as a tooltip. Example: [[Doc:QAccessible]]
== Using Tables ==
Readability is enhanced if your markup indicates a title row and if you color the title row green and alternate entry rows with a light gray.
Note the space before the | designating beginning of a cell.
{background:#009900}. |. Title 1 |. Title 2 |
| somestuff in clear row| more stuff |
{background:#ddd}. | some stuff in gray row | more stuff |
{background:#009900}. |''. Title 1 |''. Title 2 |
| somestuff in clear row| more stuff |
{background:#ddd}. | some stuff in gray row | more stuff |
== Categories ==
[[Category:Foo]] will create a category with the title "Foo" along with an automatically populated Special Page with all pages in this category. If the category already exists it will sort the page into the indicated category.
&#91;&#91;Category:Foo::Bar]]<code> will create a child category "Bar" inside the parent category "Foo".
=== Link to a Category Page ===
[[:Category:Foo::Bar]] will link to the indicated category (note the colon!) but not create a new one.
Add a Table of Contents
When a page is long, adding a table of contents can help a lot. You can control alignment and depth of the table.
&#91;toc align_right="yes" depth="2"]
The optimal depth corresponds structure and size of the article. For a short article a toc is absolutely unnecessary.
Right aligned articles
For wiki pages you can add
&#91;right_aligned]
to the top of the page and it will be all right aligned on save.
Character Codes, or How to Bypass the Wiki Formatter
Sometimes you need a character in your wiki article that the wiki engine thinks is a formatting code. When this happens, replace the character with a code for the character. "Here is a good list of such codes":http://www.degraeve.com/reference/specialcharacters.php.
For example, in Textile the percent symbol (%) indicates a tag in HTML, but you may need to show a % in a command line example. Use &#37; instead of % in your example:
Show:
set QTDIR=&#37;DEV&amp;#37;
By entering:
set QTDIR=&amp;&#35;37;DEV&amp;amp;&#35;37;
Embedding Youtube Videos
[YouTubeID:<id>]