Utilisateur:LMischler/EIG-wiki-syntax-2016

Text formatting markup

Description	You type	You get
Character (inline) formatting – applies anywhere
Italic text	''italic''	italic
Bold text	'''bold'''	bold
Bold and italic	'''''bold & italic'''''	bold & italic
Escape wiki markup	<nowiki>no ''markup''</nowiki>	no ''markup''
Section formatting – only at the beginning of the line
Headings of different levels	=level 1= ==level 2== ===level 3=== ====level 4==== =====level 5===== ======level 6====== An article with 4 or more headings automatically creates a table of contents.	Level 1 Level 2 Level 3 Level 4 Level 5 Level 6
Horizontal rule	----
Bullet list	* one * two * three ** three point one ** three point two Inserting a blank line will end the first list and start another.	one two three three point one three point two
indent text	: Single indent :: Double indent ::::: Multiple indent This workaround may be controversial from the viewpoint of accessibility.	Single indent Double indent Multiple indent

special characters

less than or equal

Replace the GraphSch character used in the book by standard existing character: ≤

You can just paste it in a wiki page (you can copy it from here), or when editing you can use the code ≤

star and delta symbols

• for star I migrated the source from figB20.ai, insert it using [[File:star_symbol.svg]] which gives this result:
• for delta you can paste directly this character: Δ or use the code Δ which gives the same result: Δ

Paragraphs

MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tags <br />.

Titles, sub-titles ...

The wiki page title (defined when creating a page) is using the first title level (h1)

So when the book content to migrate includes "paragraphs", "sub-paragraphs" ... their titles should use wiki syntax for level 2 (== title ==), level 3 (=== sub-paragraph ===) etc

bullet lists - details

This is the revised syntax of Nov 2016, after modification od CSS for bullet and definition lists

Bullet list

* one * two ** two point one ** two point two * three : continued :* three point one (:* syntax rather than **) * four : text paragraph inside bullet four : several continued sentences is possible : can also be used for an image that is part of bullet point :[[File:Blogs icon.png|none]] :* four point one (:* syntax rather than **) Inserting a blank line will end the first list and start another. nota: there is a small bug with wiki CSS, so inside tables following text does not have proper font size ==> not a problem as should never happen in tables

one two two point one two point two three continued three point one (:* syntax rather than **) four text paragraph inside bullet four several continued sentences is possible can also be used for an image that is part of bullet point four point one (:* syntax rather than **)

It is not recommended to have more than 2 nested levels of bullet lists.

If there are more than 2 bullet list levels (maybe sometimes also for 2 levels), it is recommended to change the first level of bullet list to a sub-paragraph level

"Highlight Boxes" (green boxes in the book, grey in wiki)

These are the "boxes" added in the left column of the book, to highlight a point. Most are green in the book, except the "french specifc" ones which are grey

• syntax for "normal" ones:

{{Highlightbox |
This is the text for the highlight box
}}

example:

This is the text for the highlight box

• syntax for "french-specific" ones:

{{Highlightbox-specific |
This is the text for the french specific highlight box
}}

example:

This is the text for the french specific highlight box

Manual TOCs (table of contents)

These small manual TOCs are used in "introductory pages", eg pages with a short text introduction (or not), followed by this small manual TOC = links to pages included in this "section"

syntax:

{{Manual_TOC |
* [[General method for cable sizing]]
* [[Recommended simplified approach for cable sizing]]
* [[Sizing of busbar trunking systems (busways)|Example where visible text is different from page name]]
}}

example:

Sommaire

General method for cable sizing Recommended simplified approach for cable sizing Example where visible text is different from page name

Images

The syntax is now using templates, to facilitate and standardize the formating, as shown below

Image = ONE FIGURE

{{FigImage|<fig-ID>|<fig-extension>|<fig-num>|<fig-title>}}

example:

{{FigImage|DB422002_FR|svg|A11|Application du facteur de simultanéité (ks) à un immeuble de 4 étages + rez-de-chaussée (correspondant à la norme NF C 14-100)}}

where:

• <fig-ID> is like: DB422001 (= image file name, without the file extension)
• <fig-extension> is like: svg, jpg ...
• <fig-num> is like: A11, B42a ...
• <fig-title> is like: Application of the diversity factor (ks) to an apartment block of 5 storeys

result:

Fig. A11 – Application du facteur de simultanéité (ks) à un immeuble de 4 étages + rez-de-chaussée (correspondant à la norme NF C 14-100)

nota: <fig-title> normally is just text, and does not include any formatting, unless it is required, like to add a link inside the title. Example:

{{FigImage|<fig-ID>|<fig-extension>|A11|Circuit-breaker type <nowiki>'''[http://www.xxxxxxx Masterpact]''' from Schneider-Electric}}</nowiki>

Image = ONE FIGURE with NOTES

{{FigImage|<fig-ID>|<fig-extension>|<fig-num>|<fig-title>|
 add figure notes here ...<br>
 ... more
 }}

example:
{{ FigImage|DB422002_FR|svg|A11|Application du facteur de simultanéité (ks) à un immeuble de 4 étages + rez-de-chaussée (correspondant à la norme NF C 14-100)|
 add figure notes here ...<br>
 ... more
 }}

Giving:

add figure notes here ...
... more

Fig. A11 – Application du facteur de simultanéité (ks) à un immeuble de 4 étages + rez-de-chaussée (correspondant à la norme NF C 14-100)

Image without frame and title

Syntax is very simple here:

[[File:<image-name-with-extension>]]
 
 example:  |[[File:Pen-icon.png]]

Giving for exemple, if integrated in a small table:

table header	header 2
	This icon is a pen icon

Gallery of images

NEW syntax to use with dedicatedf template

Syntax to use:

• the parameter <widths-px> should be +- 5 px larger than biggest width of all images in the gallery, and expressed like 150px

{{ Gallery | <1=fig-num> | <2=fig-title> |<3=widths>|<4=images-per-row>
|<5=image-filename-1> | <6=image-letter-1> |  <7=image-title-1>
|<8=image-filename-2> | <9=image-letter-2> |  <10=image-title-2>
...
|<17=image-filename-5> | <18=image-letter-5> |  <19=image-title-5> }}

Where the global gallery parameters are:

<fig-num>           is like:   A11, B42a ...
<fig-title>         is like:   Application of the diversity factor (ks) to an apartment block of 5 storeys
<widths>            is like:   220px   (the common width applied to all gallery "cells", should be bigger than the largest image in the gallery)
<4=images-per-row>  is like:   1..4  (default if value not provided = 4)

and then for each image in the gallery :

<image-filename> is like:   DB422001.svg   (= image file name WITH the file extension)
<image-letter>   is like:   a   (it will be enclosed in squared brackets, like [a], and highlighted eg bold)
<image-title>    is like:   this is the title related to this image

maximum number of images taken:

if 1 per row  =   4
if 2 per row  =   8
if 3 per row  =   9
if 4 per row  =   16

Example:

Fig. F78 – Situations augmentant le risque d'incendie

• 

  Cordon d’alimentation trop sollicité (par un meuble ou une position)

• 

  Cordon d’alimentation défectueux suite à manoeuvres inappropriées ou trop nombreuses

• 

  Câble affaibli lors du raccordement

• 

  Endommagement accidentel d’un câble

• 

  Prises en mauvais état

• 

  Vieillissement des protections de câbles

• 

  Connexions desserrées

• 

  Câbles endommagés par leur environnement : UV, vibrations, humidité, rongeurs

Fig. E30 – Tableaux de distribution terminale

• 

  [a] Prisma Plus G Pack and what if the title is really very but really very very long ?

• 

  [b] Kaedra

• 

  [c] Mini-Pragma

FOR MEMORY ONLY - OLD syntax using standard wiki Gallery

It has been replaced by specific template, mainly because the default gallery is resizing images to fill the image "boxes" ==> not OK for the wiki as we want to keep original image size

The syntax to use is shown below.

• Important: you have to choose the "width" and "height" to use for the gallery, according to image sizes = it should correspond to the max width and maw height of all images in the gallery, + 5px
• for the example below, the images are 223×247 pixels and 210×252 pixels respectively, so max width = 223 + 5px = 228 I rounded to 230px, and max height = 252 + 5px = 257 I rounded to 260px
• the title for each image can include some wiki formatting (to put part of the text in bold, like the [a] ...

<gallery widths=230px> heights=260px>
File:<image-file-name>|<title for first image in the gallery>
File:<image-file-name>|<title for 2nd image in the gallery>
...
</gallery>
{{FigTitle|<fignum>|<figtitle>}}

And here is an example

• PB116705.jpg

  [a] TGBT avec une arrivée par canalisation électrique préfabriquée (Prisma P)

• 

  [b] TGBT (Okken)

Fig. E28 – Tableau Général BT (TGBT) - examples

Table

Standard Tables, with a title and without notes

The final syntax to use requires to REPLACE the usual starting and ending syntax of tables by specific templates with proper parameters:

{{TableStart|<table-ID>|<cols-in-book>}}    IMPORTANT: This line is REPLACING the usual table starting syntax: {| class="wikitable"
 ... table syntax as usual here ...
 ... continued ...
 {{TableEnd|<table-ID>|<fig-num>|<table-title>}}     IMPORTANT: This line is REPLACING the usual table ending syntax: |}

where:

<table-ID>      =  table ID  (Tab1001)
<cols-in-book>  =  1col 2col 3col 4col or 5col, according to nr of "book columns" required for the table width in the book 
<fig-num>       =  figure number (A5)

Example:

{{TableStart|Tab1001|2col}}
|-
! header
! header
|-
| the table syntax is as usual
| the rest is as usual I believe
|-
| another cell
{{TableEnd|Tab1001|A5|This is my table title}}

Result:

header	header
the table syntax is as usual	the rest is as usual I believe
another cell

Fig. A5 – This is my table title

Table without TITLE

Similar syntax, just don't put any parameter in TableEnd (TableEnd is always required !)

{{TableStart|<table-ID>|<cols-in-book>}}
... table syntax as usual here ...
... continued ...
{{TableEnd}}

Table with TEXT-ONLY table notes

Syntax: the table start is the same, the table end similar but extended with the table notes

{{TableStart|<table-ID>|<cols-in-book>}}
... table syntax as usual here ...
... continued ...
{{TableEnd|<table-ID>|<fig-num>|<table-title>
|| The text of my note here. It can be long with several sentences. Do not use "br" in this text
|| ... do like this to continue text on a new line}}

Example:

{{TableStart|Tab1002|2col}}
|-
! header
! header
|-
| the table syntax is as usual
| the rest is as usual I believe
|-
| another cell
{{TableEnd|Tab1002|A6|This is my table title
|| The text of my note here. It can be long with several sentences. Do not use "br" in this text
|| ... do like this to continue text on a new line}}

Result:

header	header
the table syntax is as usual	the rest is as usual I believe
another cell

The text of my note here. It can be long with several sentences. Do not use "br" in this text
... do like this to continue text on a new line

Fig. A6 – This is my table title

Table with REFERENCES [a] ... and table notes

This is for reference inside a table, like this in the book: 3.3⁽¹⁾. These references in the book use numbers (1, 2, 3 ...) which have to be changed to small capital letters in the wiki: a, b, c, d ... to differentiate the table notes (added just after the table) from the footnotes (added at the end of the page).

Syntax to add a reference in the content of the table:

{{TabRef|<table-ID>|<ref-letter>}}    Example: {{TabRef|Tab1001|a}}  to add a ref looking like: [a]

Complete example:

{{TableStart|Tab1003|2col}}
|-
! header
! header
|-
| here a cell with a ref{{TabRef|Tab1003|a}}
| the rest is as usual I believe
|-
| another cell
{{TableEnd|Tab1003|A7|This is my table title
|a|this is the text of my note a
|b|this is now the much longer text which is not a problem, for note b
|| I can also mix with text only table notes. Don't forget to put the 2 || at the beginning}}

Result:

header	header
here a cell with a ref	the rest is as usual I believe
and another ref

[a] this is the text of my note a
[b] this is now the much longer text which is not a problem, for note b
I can also mix with text only table notes. Don't forget to put the 2 || at the beginning

Fig. A7 – This is my table title

Footnotes

Syntax to add a footnote (no space before, to be placed just after the last charatcer of the related word)

{{fn|<footnote-number>}}

where:
<footnote-number>  = 1 2 3 4 ...

Syntax to add the Notes at the end of the page:

{{footnotes}}
<references>
{{fn-detail|1|This is text for note 1}}
{{fn-detail|2|This is text for note 2}}
</references>

Example:

This is my text with footnote one. This is some more text, referencing note two

And this is another place referencing nte one.

Math formulas

Use the same syntax as previous wikis (copy / paste formulas). Just see below § "Special characters"

To know more, see Help page about Mathematical formulas

Multiplication sign

In synthesis, the rules to apply for the multiplication sign are:

• for formula written with <math> ... </math> syntax:
  • use \cdot for formulas with variable names (Ib, ka, ...). Example: <math>\sqrt 3\cdot U_0</math> gives [math]\displaystyle{ \sqrt 3\cdot U_0 }[/math]
  • use \times for formulas where you only have figures. Example: <math>X = 0.08 \times 5</math> gives [math]\displaystyle{ X = 0.08 \times 5 }[/math]
• for formula written in normal text:
  • use special character (symbol) • for formulas with variable names. Example: I_n = Σ (Ib • k_s)
  • use standard letter x for formulas where you only have figures. Example: 123 x 8.2

Special characters

Important: the following symbols are reserved characters that either have a special meaning under LaTeX or are unavailable in all the fonts. If you enter them directly in your text, they will normally not render, but rather do things you did not intend.

Important in particular for the % sign, which is used in some formulas (it works in the wiki, but then does not work during PDF exportation)

# $ % ^ & _ { } ~ \

These characters can be entered by adding a prefix backslash:

\# \$ \% \textasciicircum{} \& \_ \{ \} \~{} \textbackslash{}

Syntax to avoid (for export)

While exporting the French wiki, in a few cases a formula that looks OK in the wiki is not rendered properly, due to syntax that is probably "boderline" or not OK in TeX

Here are the problematic syntax cases detected:

• X^'d : pb is that not only the ' is considered as the exponent, but also all following characters (here would result as X^'d)
  • solution: use the syntax X^{'}d
• 65% : % is a special characters, as mentioned in previous paragraphs, and should always be preceded by a \
  • solution: use the syntax 65\%
• \vartriangle : this works in the wiki but not in export (not found in TeX reference doc also)
  • solution: as it is used for a Delta symbol, use the syntax \Delta

Vertical alignment of formulas with text

For vertical alignment of formulas that are included "inline" with text:

• use a syntax like: <math style="vertical-align:-70%;"...> and play with the value in %
• for more details: check here

Specific French contents

Just for a small text

{{FR-specific-text|<this is the specific text>}}

this is the specific text

For a long specific section

{{FR-specific-section-start}}
this is the migrated content wich is french specific ...
... use usual syntax for wiki contents ...
....
....
{{FR-specific-section-end}}

this is the migrated content wich is french specific ...
... use usual syntax for wiki contents ...
....
....

This formatting is not 100% validated, see other tests here: Utilisateur:LMischler/TestFRSpecificFormats NOTA: also need to fully validate the syntax, depending on final format chosen. For math formulas in particular, it will be a problem if we want to use a non-white background color in the FR-specific section

Other points

"parameters" like table note texts, table or figure titles with an = sign in it

Any time there is an = sign in the content of a table title, figure title, table note ... passed using one of my templates, (for example {{TableEnd ...}})
you will need to replace the = sign by {{=}}