ServiceGrid Article - Dialog Wiki Syntax

From DocWiki

Jump to: navigation, search

Contents

Overview

Some editing basics are required in case of the dialog wiki syntax.

Basic Text Formatting

  • You can italicize text by putting 2 apostrophes on each side. 3 apostrophes will bold the text. 5 apostrophes will bold and italicize the text. (4 apostrophes do not do anything special. there is just one left over.)
  • A single newline has no effect on the layout. But an empty line starts a new paragraph.
  • You can break lines without a new paragraph. Please use this sparingly.
  • You should "sign" your comments on talk pages:

- Three tildes gives your user name: Karl Wick
- Four tildes give your user name plus date/time:Karl Wick 07:46, 27 November 2005 (UTC)
- Five tildes gives the date/time alone: 07:46, 27 November 2005 (UTC)

  • You can use HTML tags also. Some useful ways to use HTML:
    - Put text in a typewriter font. 
    - Strike out or underline text, or write it in small caps.
    - Superscripts and subscripts - X2 and H2O
    - Invisible comments to editors ( ) only appear while editing the page. If you wish to make comments to the public, you should usually go on the talk page.

NOTE: In general, you should avoid HTML in favor of Wiki markup whenever possible.

Organizing your writing

  • Section headings - Headingsorganize your writing into sections. The Wiki software can automatically generate a table of contents from them.
  • Subsection - Using more equals signs creates a subsection.
  • A smaller subsection - Do not skip levels, such as in using two to four equals signs. Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title.
  • Unordered lists are easy to do. Start every line with a star. More stars indicate a deeper level.
  • A newline in a list marks the end of the list.
  • Numbered lists are very organized and easy to follow.
  • New numbering starts with 1.
  • Mixed lists are also possible.
  • A newline after that starts a new paragraph. This is often used for discussion on talk pages.
  • You can make horizontal dividing lines (----) to separate text. But you should usually use sections instead, so that they go in the table of contents.
  • You can add footnotes to sentences using the reftag (--) this is especially good for citing a source.

Links

  • Here is a link to a page named SD.Logistics. You can even say official positions and the link will show up correctly.
  • You can put formatting around a link.
  • The first letter of articles is automatically capitalized, so wikipedia goes to the same place as Wikipedia. Capitalization matters after the first letter.
  • You can link to a page section by its title: List of cities by country#Morocco. If multiple sections have the same title, add a number. #Example section 3 goes to the third section named "Example section".
  • You can make a link point to a different place with a piped link. Put the link target first, then the pipe character "|", then the link text.
  • You can make an external link just by typing a URL:http://www.nupedia.com. You can give it a title: Nupedia Or leave the title blank: http://www.nupedia.com.
  • One can not only link to HTTP sites but also to the local file system (provided that the browser settings allow it). Example: file:///C:/link/to/some/file/or/folder.
  • Linking to an e-mail address works the same way:mailto:someone@domain.com orsomeone.
  • You can redirect the user to another page. Example: #REDIRECT Official position.
  • The Wiki reformats linked dates to match the reader's date preferences. These three dates will show up the same if you choose a format in your Preferences: July 20, 1969, 20 July 1969, 1969-07-20.

Displaying What is typed

A few different kinds of formatting will tell the Wiki to display things as you typed them.

  • The nowiki tag ignores the Wiki markup. It reformats text by removing newlines and multiple spaces. It still interprets special characters: →
  • The pre tag ignores the Wiki markup. It also doesn't reformat text. It still interprets special characters: →
  • Leading spaces are another way to preserve formatting.
  • Putting a space at the beginning of each line stops the text from being reformatted. It still interprets the WikiWiki markup and special characters: →

Images, tables, video and sounds

After uploading, just enter the filename, highlight it and press the "embedded image" button of the edit toolbar. This will produce the syntax for uploading a file File:Filename.png. Alternately, one can enter the filename with the file type in Capital letters. Example: File:Filename.GIF

  • A picture, including alternate text, "Image:collaboration w text.gif". You can put the image in a frame with a caption and even change its size
  • A link to the page for the image:"Image:collaboration w text.gif"
  • Use media: links to link directly to sounds or videos: A sound file
  • Wikitext for the table:
{|
! This
! is
|-
| a
| table
|-
|}

Templates

Templates are segments of Wiki markup that are meant to be copied automatically ("transcluded") into a page. You add them by putting the template's name in double braces. Some templates take parameters, as well, which you separate with the pipe character.


Category

Categories are used to group pages. The page listing category is auto generated. To bind a page to a category, simply add the tag.

You can also choose the text of the link displayed on the category page using the following syntax:

[[Category:Name of the category|Name of the link on the category page]]

It is also possible to use sub category. To do so, add the tag of the parent category on the child page of the category.

Example

  • Category A > put tag on page Category:AB and Category:AC
  • Category AB > put tag on page Aberation and Abnegation
  • Category AC > put tag on page Accurate
  • Category AC > put tag on page Acote

Here, Category AB and Category AC will be listed on Category A page as sub category. Aberration and Abnegation will be listed on Category AB page as page. Accurate and Acote (with link text Near the end) will be listed on Category AC page as page.


Collapsable Paragraphs

A collapsable paragraph is done with a template:

{{expand|header=Collapsable Text|
content=This is addininal info and could include also Wiki Content.}}

How it looks

Collapsable Text:
This is additional info and could include also Wiki Content.

Minor edits

A logged in user can mark an edit as "minor". Minor edits are generally spelling corrections, formatting, and minor rearrangement of text. Users may choose to hide minor edits when viewing recent changes. Marking a significant change as a minor edit is considered bad Wikiquette. If you have accidentally marked an edit as minor, make a dummy edit, make sure that the "[ ] This is a minor edit" checkbox is unchecked, and explain in the edit summary that the previous edit was not minor.


For a complete list of Cisco ServiceGrid Articles, go to the List of Articles page.

Rating: 0.0/5 (0 votes cast)

Personal tools