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 4Level 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. |
|
indent text |
: Single indent :: Double indent ::::: Multiple indent This workaround may be controversial from the viewpoint of accessibility. |
|
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
Bullet list |
* one * two ** two point one ** two point two * three<p>continued</p> ** three point one * four<!-- --><p>continued with "nicer" source (visually closer to actual page result)</p><!-- --><p>several continued sentences is possible</p><!-- --><p>can also be used for an image that is part of bullet point</p><!-- --><p>[[File:Blogs icon.png|none]]</p> ** four point one 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 |
|
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
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|General method for cable sizing]] * [[Recommended simplified approach for cable sizing|Recommended simplified approach for cable sizing]] * [[Sizing of busbar trunking systems (busways)|Sizing of busbar trunking systems (busways)]] }}
example:
Sommaire |
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>}}
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
Giving:
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>|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 }}
Giving:
Image without frame and title
Syntax is very simple here:
[[File:<image-name-with-extension>]]
Giving for exemple, if integrated in a small table:
table header | header 2 |
---|---|
This icon is a pen icon |
Table
standard table
table header | header | header |
---|---|---|
This is a cell | This is a cell | This is also a cell |
This is a cell | This is a cell | This is also a cell |
tables with table notes [a]
to be completed
Footnotes
to be completed
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