Adjtuant Wiki - Page Editing

Modified on Thu, 23 Jun 2016 13:20 by tpaeglis — Categorized as: Wiki

All information on this page is supplied by the ScrewTurn Wiki



Editing a Wiki Page in the Adjutant Wiki is really simple. You can insert WikiMarkup, standard XHTML or use the integrated Format Helper Toolbar. In all the cases, you can format the text and insert links, images and many other items in a simple and quick fashion.


1 - WikiMarkup

The WikiMarkup is a particular set of prefixes and suffixes that allow to format the text and insert items, such as links and images. In this section you'll learn how to use the WikiMarkup.

1.01 Basic Text Formatting


1.02 - Links

Links are identified with [ and ].
Note: since version 1.0.10, links also work with 2 brackets, for example [[Link]].
You can upload files using the File Management interface.

1.02.1 - Notes

Links and Images share the same general syntax, but the number of fields changes.

1.02.2 - Categories

You can link a Category by using the following syntax:

[c:CategoryName]

For example, you can link the Help category or all the uncategorized Pages ([c:-|uncategorized Pages]).

1.02.3 - Page Attachments

You can attach a file to a Page using the following syntax:

[attachment:File.jpg]

Attachment are listed at the bottom of the Page. Please note that this function is still quite "raw", and the attached files are not real attachments, but just links to some uploaded files.

1.03 - Headings

You can create headings using a sequence of equal (=) signs:
Note: headings must be placed at the beginning of lines.

1.03.1 - Horizontal Line

You can place a horizontal line using four hyphens ----.

1.04 - Images

Images use [ and ] as delimiters.
Note: since version 1.0.10, images also work with 2 brackets, for example [[image|Title|Url]].
There are several types of images:
Note: if the Title field starts with #, the title is not shown in the page but it is still used to populate the alt attribute of the image.

You can upload images and files using the File Management interface.

1.04.1 - Notes

Links and Images share the same general syntax, but the number of fields changes.

1.05 - Lists

A list is made by a sequence of lines starting with one or more asterisks (*) and/or diesis (#). You can create nested list using more than one asterisk or diesis.


* Element 1
* Element 2

produces

  • Element 1
  • Element 2



# Element 1
# Element 2

produces

  1. Element 1
  2. Element 2



# Element 1
# Element 2
#* Element 2.1
#* Element 2.2
# Element 3

produces

  1. Element 1
  2. Element 2
    • Element 2.1
    • Element 2.2
  3. Element 3



# Element 1
# Element 2
#* Element 2.1
#*# Element 2.1.1
#*#* Element 2.1.1.1
# Element 3

produces

  1. Element 1
  2. Element 2
    • Element 2.1
      1. Element 2.1.1
        • Element 2.1.1.1
  3. Element 3



1.06 - Code and the NoWiki Tag

If you want to insert an inline piece of code, wrap it with {{ and }}; for example {{This is code}} produces This is code.
If you want to insert a block of code, for example a C# class, wrap it with {{{{ and }}}}, as in

using System;

namespace MyNamespace {
   public class HelloWorld {
      public static void Main(string[] args) {
         Console.WriteLine("Hello World");
      }
   }
}

If you want to exclude a block of text from the WikiMarkup formatting, wrap it with <nowiki> and </nowiki>, for example <nowiki>[MyPage]</nowiki> produces [MyPage].

1.06.1 - The @@ Tag

If you need to place some code that contains, for example, XML and even WikiMarkup and you want it to be displayed exactly as is, wrap it with two @:

@ @
<xml>
   '''Bold'''
   <bla z="b" />
</xml>
@ @

Removing the space between the @ signs, the result is:

<xml>
   '''Bold'''
   <bla z="b" />
</xml>

1.07 - Line Breaks

Two line breaks are treated as they are. A single line break is ignored. If you want to insert a single line break, you can use the standard XHTML tag <br /> or its WikiMarkup alias {BR} (letter casing is ignored). It's not recommended to abuse single line breaks because they tend to create confusion in the page.

Alternatively, you might want to enable the Process Single Line Breaks options in the Configuration page.

1.08 - Special Tags

The ScrewTurn Wiki engine provides a few special markers that are replaced automatically with specific content. All these tags ignore the letter casing.

1.09 - Boxes

If you want to wrap some content inside a box, use triple brackets ((( and ))). For example, (((My box))) produces
My box

1.10 - Text Indentation

The text can be indented using one or more colons, at the beginning of a line.

: Single indentation
:: Double indentation

results in

Single indentation
Double indentation

Note: if you want to indent multiple lines, you have to add the indentation tag to every line. You cannot use indentation in combination with other tags, such as box or code.

1.11 - Tables

The WikiMarkup also supports tables. Since the tables offer many options, they are described in the dedicated section Tables.

1.12 - User Signature

Users can sign their edits using four tildes: ~~~~. The result is the following: Dario Solera, Thu, 15 Feb 2007 11:39

1.13 - Snippets and Page Transclusion

To use the special features called Snippets and Page Transclusion, please go to the dedicated pages:

1.14 - Page Redirection

You can redirect a user automatically to another Page when he visits a Page. You can just add the following code at the beginning of the Page:

>>> [PageName]

or

>>> PageName

When the user visits a Page containing a Redirection tag, the engine will display the destination Page. At the top of the destination Page Page, a message will be displayed, containing a link for visiting the origin Page without being redirected.

1.15 - XHTML Support and Escaping

ScrewTurn Wiki supports standard XHTML content. You can use any tag, except for <script> that might be disabled by the administrators.
XHTML comments are also supported (<!-- ... -->), but they are removed from the page output.

If you want to insert a block of HTML or XML displaying the tags, you can use the <esc></esc> tag. This tags escapes all the angular brackes making them visible.

<esc><strong>Your tag</strong></esc>

produces

<strong>Your tag</strong>

2 - Format Toolbar

In the editing page there is the toolbar reported in this picture:
Format Toolbar

Format Toolbar

The list of the buttons is reported below.

  1. Bold: sets/unsets selected text as bold
  2. Italic: sets/unsets selected text as italic
  3. Underlined: sets/unsets selected text as underlined
  4. Striked: sets/unsets selected text as striked
  5. H1: sets/unsets selected text as Header Level 1 (unrecommended)
  6. H2: sets/unsets selected text as Header Level 2
  7. H3: sets/unsets selected text as Header Level 3
  8. H4: sets/unsets selected text as Header Level 4 (use sparingly)
  9. Subscript: sets/unsets selected text as subscript
  10. Superscript: sets/unsets selected text as superscript
  11. Page link: allows to insert a link to a Wiki Page using a menu
  12. File link: allows to insert a link to an uploaded file
  13. External: allows to insert a link to an external destination
  14. Image: allows to insert an image using a simple Image Browser
  15. Anchors: shows two items, the first allows to inserts anchors in the text, the second allows to insert links to anchors in the text
  16. Inline Code: sets/unsets selected text as code
  17. Block Code: sets/unsets selected text as a block of code
  18. Box: wraps/unwraps selected text with (((...)))
  19. Line Break: inserts a single line break in the text
  20. Insert Snippet: allows to insert a Snippet using a menu
  21. Special Tags: shows a list of available special tags which, once clicked, insert a specific special tag in the text
    • Note: Providers can add items to this menu using the Host object (see documentation)
  22. NoWiki: wraps/unwraps selected text with <nowiki>...</nowiki> tags
  23. Comment: wraps/unwraps selected text with XHTML comment tags
  24. Escape: wraps/unwraps selected text with escape tags

All information on this page is supplied by the ScrewTurn Wiki