User:WikiWriter/Sandbox/Other

Help:How to add a link to a KnowledgebaseWiki article

edit

Before you can add a link to a KnowledgebaseWiki article - you must know the exact name of the KnowledgebaseWiki article to which you are linking.

What to do

edit

With the article open in edit-mode :

  1. Scroll to the place you want the link
  2. Enter '[[article-name]]'  where 'article-name' is the name of a KnowledgebaseWiki article
  3. Click the Save page button - the link is added to the KnowledgebaseWiki article

Example - article name as link-text

edit

... are implementing Darwin Information Typing Architecture to ensure ...

Created by :

 ... are implementing [[Darwin Information Typing Architecture]] to ensure ... 
edit

... are implementing DITA to ensure ...

Created by :

 ... are implementing [[Darwin Information Typing Architecture|DITA]] to ensure ... 

Help:How to add a link to a section in a KnowledgebaseWiki article

edit

Before you can add a link to a KnowledgebaseWiki article - you must know the exact name of the KnowledgebaseWiki article to which you are linking, and the section-name in it.

What to do

edit

With the article open in edit-mode :

  1. Scroll to the place you want the link
  2. Enter '[[article-name#section-name]]'  where 'article-name' is the name of a KnowledgebaseWiki article, and 'section-name' is the name of the section
  3. Click the Save page button - the link is added to the KnowledgebaseWiki article

Example - showing article-name, and section-name

edit

... might require a table with Help:How to add a table to a KnowledgebaseWiki article#As above (with larger text) text ...

Created by :

[[Help:How to add a table to a KnowledgebaseWiki article#As above (with larger text)]]

Example - showing alternate-text

edit

... might require a table with larger than default text ...

Created by :

[[Help:How to add a table to a KnowledgebaseWiki article#As above (with larger text)|larger than default]]

Help:How to add a link to a category in the KnowledgebaseWiki

edit

Sometimes it just makes sense to use category as if it were a KnowledgebaseWiki article - for example the 'homepage' of the KB Team. The advantage of this is that a category-page automatically displays every KnowledgebaseWiki article in its special (non-editable) Articles in category "..." bottom-section.

The usual way to add a KnowledgebaseWiki article to a category is to - for example - add the following to it :

[[Category:KB_Team]]

To add a category-link to a KnowledgebaseWiki article - for example - add the following to it :

... see [[:Category:KB_Team|KB Team]] for that list ...

Help:Magic words

edit
The most useful magic words, and other built-in MediaWiki markup.

#REDIRECT

edit

This 'tag' in an article automatically redirects from the article it's in, to specified other.

By convention article-names should not be acronyms, but it can be useful to do so with that article redirecting to the article with the 'expanded' name.

Example

edit

The KCS article contains the following redirect 'tag' to the Knowledge-centric Support article.

#REDIRECT [[Knowledge-centric_Support]]

__NOEDITSECTION__

edit

You probably won't use this 'tag' in a general article, but adding it to an article (usually at the top) prevents the automatic addition of section-edit links. Note this 'tag' is created with double-underscores before, and after 'NOEDITSECTION'.

__NOEDITSECTION__

__NOTOC__

edit

You probably won't use this 'tag' in a general article, but adding it to an article (usually at the top) prevents the automatic addition of a table-of-contents. Note this 'tag' is created with double-underscores before, and after the 'NOTOC'.

<nowiki> and </nowiki>

edit

This 'tag-pair' forces wiki-markup to be ignored.

Without

edit
... to the [[Main Page|Main Page]] ...

creates :
... to the Main Page ...

With

edit
... to the <nowiki>[[Main Page|Main Page]]</nowiki> ...

creates :
... to the [[Main Page|Main Page]] ...

Help:How to add an template to a KnowledgebaseWiki article

edit

To put it simply - a 'template' is a way to reuse content in any KnowledgebaseWiki article, and as such the term is misleading since it implies an outline without content.

Adding a template to an article is a simple process - for example - to add the template 'page_under_construction' to the article How to write support documentation :

  1. Open How to write support documentation in edit-mode
  2. Type the following at the top of the article
    {{page_under_construction}}
  3. Click the 'Save page' button

Viewing the list of templates in the KnowledgebaseWiki

edit

In 'toolbox' in the left-hand pane :

  1. Click 'Special pages' - 'Special pages' opens
  2. Click 'All pages' - curiously 'All articles' opens
  3. In the 'Namespace' dropdown - select 'Template'
  4. Click the 'Go' button - 'All pages (Template namespace)' opens showing all the templates in the KnowledgebaseWiki

Help:How to add an image to a KnowledgebaseWiki article

edit

If you know the name of an existing image in the KnowledgebaseWiki, adding it to an article is a simple process. This is done using the [[image]] 'tag'.

What to do

edit

With the article open in edit-mode :

  1. Scroll to the place you want the image to be
  2. Enter '[[image:image-name.jpg]]' where 'image-name.jpg' is the name, and extension of the image you are adding
  3. Click the Save page button - the image is added to the article

Example

edit

The following markup added the image below it :

[[image:homer-simpson.png]]

File:Homer-simpson.png