Difference between revisions of "EditingTips"

From RadiWiki
Jump to: navigation, search
Line 1: Line 1:
__NOTOC__
 
 
This page contains several tips and suggestions when editing pages on this [[RadiWiki]] website.
 
This page contains several tips and suggestions when editing pages on this [[RadiWiki]] website.
 
The RadiWiki site provides a lot of usefull templates. A template can be included by using double-curly-braces.
 
The RadiWiki site provides a lot of usefull templates. A template can be included by using double-curly-braces.
 
See some often used templates below.
 
See some often used templates below.
 +
 +
= Internal MediaWiki links =
 +
When you are referring to another page within the RadiWiki website, it is best to use a short links.
 +
 +
The disadvantages of the long link are:
 +
* The writing of the text is more confusing
 +
* When the link to the website changes, the long links are not working anymore
 +
* An external link icon is shown behind the link
 +
 +
<nowiki>Not: [http://wiki.dare.nl/wiki/index.php/RadiMation_Application_Note_107]
 +
But: [RadiMation Application Note 107]]</nowiki>
 +
 +
will result in:
 +
 +
<nowiki>Not: [http://wiki.dare.nl/wiki/index.php/RadiMation_Application_Note_107]
 +
But: [RadiMation Application Note 107]]</nowiki>
  
 
= RadiWiki Templates =
 
= RadiWiki Templates =
Line 46: Line 61:
 
{{Menu|Configuration|Configuration|Tab-name|Element}}
 
{{Menu|Configuration|Configuration|Tab-name|Element}}
  
== Hide the Table of Contents ==
+
= Hide the Table of Contents =
 
On several pages it is not desired to also have the Table of Contents (TOC) being shown.
 
On several pages it is not desired to also have the Table of Contents (TOC) being shown.
 
The Table of Contents can be hidden on a page, by including the 'Magic keyword': __NOTOC__ on the first line of the Wiki-text.
 
The Table of Contents can be hidden on a page, by including the 'Magic keyword': __NOTOC__ on the first line of the Wiki-text.
Line 52: Line 67:
 
This is a standard MediaWiki template, and not specific to the RadiWiki.
 
This is a standard MediaWiki template, and not specific to the RadiWiki.
  
== No article/page not found text ==
+
= No article/page not found text =
 
When a page is non existent wiki normally offers you to create a new page. We use this page to show general support information so the customer at least gets re-directed to support. There are two pages that are displayed when a article is not found. One for the users that have permission to edit and one fo users that don't.
 
When a page is non existent wiki normally offers you to create a new page. We use this page to show general support information so the customer at least gets re-directed to support. There are two pages that are displayed when a article is not found. One for the users that have permission to edit and one fo users that don't.
  
Line 59: Line 74:
 
When you change this text it will be displayed when a page does not exist.
 
When you change this text it will be displayed when a page does not exist.
  
== Editing formula's ==
+
= Editing formula's =
 
Formula's can be entered in a text notation, where they are rendered into the corresponding graphical notation.
 
Formula's can be entered in a text notation, where they are rendered into the corresponding graphical notation.
 
See [https://en.wikipedia.org/wiki/Help:Displaying_a_formula    displaying a formula] for a detailed description.
 
See [https://en.wikipedia.org/wiki/Help:Displaying_a_formula    displaying a formula] for a detailed description.

Revision as of 20:03, 29 January 2019

This page contains several tips and suggestions when editing pages on this RadiWiki website. The RadiWiki site provides a lot of usefull templates. A template can be included by using double-curly-braces. See some often used templates below.

Internal MediaWiki links

When you are referring to another page within the RadiWiki website, it is best to use a short links.

The disadvantages of the long link are:

  • The writing of the text is more confusing
  • When the link to the website changes, the long links are not working anymore
  • An external link icon is shown behind the link
Not: [http://wiki.dare.nl/wiki/index.php/RadiMation_Application_Note_107]
 But: [RadiMation Application Note 107]]

will result in:

Not: [http://wiki.dare.nl/wiki/index.php/RadiMation_Application_Note_107]
 But: [RadiMation Application Note 107]]

RadiWiki Templates

RadiMation

The 'RadiMation' template will show RadiMation® correctly formatted. For example:

{{RadiMation}}

will result in:

RadiMation®

MailSupport

A linked URL to support@radimation.com can be included using the 'MailSupport' template. The advantage of this Template is that it also will also use the name of the RadiWiki page as the subject of the e-mail. For example:

{{MailSupport}}

will result in:

radimation-support@raditeq.com

Note

A note box with some text can be created using the 'Note' template. For example:

{{Note|Be aware that the 'Note' template is used!}}

will result in:

Information.png
Note: Be aware that the 'Note' template is used!


Menu

The menu-entries can be created using the 'Menu' template. For example:

{{Menu|Configuration|Configuration|Tab-name|Element}}

will result in:


   Menu.png Configuration
      Menu.png Configuration
         Menu.png Tab-name
            Menu.png Element

Hide the Table of Contents

On several pages it is not desired to also have the Table of Contents (TOC) being shown. The Table of Contents can be hidden on a page, by including the 'Magic keyword': on the first line of the Wiki-text.

This is a standard MediaWiki template, and not specific to the RadiWiki.

No article/page not found text

When a page is non existent wiki normally offers you to create a new page. We use this page to show general support information so the customer at least gets re-directed to support. There are two pages that are displayed when a article is not found. One for the users that have permission to edit and one fo users that don't.

Because our users can't edit the pages we need to change http://wiki.dare.nl/wiki/index.php/MediaWiki:Noarticletext-nopermission

When you change this text it will be displayed when a page does not exist.

Editing formula's

Formula's can be entered in a text notation, where they are rendered into the corresponding graphical notation. See displaying a formula for a detailed description.

For example:

<math>Z{t} = \frac{V{p}}{V{in}}</math> 

will result in: