EditingTips

From RadiWiki
Revision as of 07:54, 13 April 2021 by Joro (talk | contribs)
Jump to: navigation, search

This page contains several tips and suggestions when editing pages on this RadiWiki website.

General Editing help

A basic help for editing of Wiki pages is present on the Editing Help link which is also included on every editing window.

New line

It is common behavior to type text in paragraphs. The layout of the paragraph is handled by the webbrowser, and is very depending on the width of the screen on which the page is shown. During the editing of a page, one should thus not worry about where line breaks should be included. A new paragraph can be started by including a single whiteline in the page text. Using the <BR /> is strongly discouraged!

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   RadiMation Application Note 107]
But: [[RadiMation Application Note 107]]

will result in:

Not: RadiMation Application Note 107

But: RadiMation Application Note 107

RadiWiki Templates

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.

RadiMation

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

{{RadiMation}}

will result in:

RadiMation®

MailSupport

A linked URL to radimation-support@raditeq.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

ReportGeneratorCode

Showing a report generator code can be challenging in MediaWiki, because the | is also used for template sepeators and table formatting.

The 'ReportGeneratorCode' can be used to simplify this.

Also the 'ReportGeneratorInfo' template can be used to generate a box that indicates that the content is related to the report generator.

For example:

{{ReportGeneratorInfo|The most often used report generate code is: {{ReportGeneratorCode|EUT|NAME}} }}

will result in:

Report generator.png
The most often used report generate code is: ||EUT|NAME||

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': __NOTOC__ 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 of users that do not have editing permissions.

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:

Z{t} = \frac{V{p}}{V{in}}

Numbered lists

A numbered list can be created by placing "#" before each row which must be numbered.

For example:

  1. List entry 1
  2. List entry 2
  3. List entry 3
  4. List entry 4

Images within a numbered list

When for example a numbered list is used to communicate step by step instructions in which also images are used. The tag "< BR >"(without the spaces) can be used to add a new line within the numbered list on which the image can then be inserted.

For example:

  1. List entry 1
  2. List entry 2
  3. List entry 3
    NRX-AdvancedSettingsGPIB.PNG
  4. List entry 4

Hiding automatically generated sections

The 'DeviceDriverInfo' macro generates a generic page with some automatically generated contents. (Also see: Template:DeviceDriverInfo). The automaticly generated section on the page can be hidden from being present by adding "|HideAutoData=1" to the macro.

Nicely formatted tables

The standard table formatting, generates a table with no borders, which results in some floating texts that seem to be space seperated. A better looking table can be generated by specifying the 'wikitable' class style.

 {|class="wikitable"
 ! First header row || Description
 |-
 | Row 1 || An explanation
 |-
 | Row 2 || A second explanation
 |}
 

Will result in:

First header row Description
Row 1 An explanation
Row 2 A second explanation

Using fixed width font to include formatted text

When adding formatted text such as code examples, the first character on a new line must be a whitespace. This shall keep the original formatting of the code from being changed.

For example:

int DeterminePaddingAmount(void) {
    int requiredAmountOfPadding = 0;
    requiredAmountOfPadding = (int)m_PreviousTextString.length() - (int)m_ReplacedTextString.length();
    return requiredAmountOfPadding;

Instead of:

int DeterminePaddingAmount(void) {

   int requiredAmountOfPadding = 0;
   requiredAmountOfPadding = (int)m_PreviousTextString.length() - (int)m_ReplacedTextString.length();
   return requiredAmountOfPadding;