« Utilisateur:LMischler/EIG-wiki-syntax-2016 » : différence entre les versions

De Guide de l'Installation Electrique
Aller à :navigation, rechercher
Aucun résumé des modifications
(page moved to english wiki)
 
(40 versions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
= Text formatting markup =
page has been moved to [[:en:User:LMischler/EIG-wiki-syntax-2016|english wiki]]
 
{| class="wikitable"
! Description !! You type !! You get
|-
| colspan="3" {{Table_HC1}} | '''Character (inline) formatting – ''applies anywhere'''''
|-
|Italic text
| <code><nowiki>''italic''</nowiki></code>
|''italic''
|-
| Bold text
| <code><nowiki>'''bold'''</nowiki></code>
|'''bold'''
|-
| Bold and italic
| <code><nowiki>'''''bold & italic'''''</nowiki></code>
|'''''bold & italic'''''
|-
|Escape wiki markup
| <code><nowiki><nowiki>no ''markup''&lt;/nowiki></nowiki></code>
|<nowiki>no ''markup''</nowiki>
|-
| colspan="3" {{Table_HC1}} | '''Section formatting – ''only at the beginning of the line'''''
|-
|Headings of different levels
| <pre>=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======</pre>
An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].
 
|<!-- hack to prevent TOC viewing for h1 - h6 elements: their style is hardcopied here -->
<div style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa">Level 1</div>
<div style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa">Level 2</div>
<div style="font-size: 132%; font-weight: bold">Level 3</div><!--
--><b>Level 4</b><!--
--><div style="font-size: 86%; font-weight: bold">Level 5</div><!--
--><b style="font-size: 80%">Level 6</b>
|-
|Horizontal rule
| <code>----</code>
|
----
|-
|Bullet list
|
<pre>
* one
* two
* three
** three point one
** three point two
</pre>
Inserting a blank line will end the first list and start another.
|
* one
* two
* three
** three point one
** three point two
|-
| indent text
|
<pre>: Single indent
:: Double indent
::::: Multiple indent</pre>
This workaround may be controversial from the viewpoint of accessibility.
|
: Single indent
:: Double indent
::::: Multiple indent
|}
 
 
= 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 <code>&lt;br /></code>.
 
 
= 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 =
 
{| class="wikitable"
|-
|Bullet list
|
<pre>
* 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
</pre>
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<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
|}
 
'''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:
 
<nowiki>{{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)]]
}}</nowiki>
 
example:
{{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)]]
}}
 
 
= Images =
The syntax is now using templates, to facilitate and standardize the formating, as shown below
 
 
== Image = ONE FIGURE ==
 
<nowiki>{{FigImage|<fig-ID>|<fig-extension>|<fig-num>|<fig-title>}}</nowiki>
example:
<nowiki>{{FigImage|DB422002|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)}}</nowiki>
 
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:
{{FigImage|DB422002|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)}}
 
 
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:
<nowiki>{{FigImage|<fig-ID>|<fig-extension>|A11|Circuit-breaker type <nowiki>'''[http://www.xxxxxxx Masterpact]'''</nowiki> from Schneider-Electric}}</nowiki>
 
 
== Image = ONE FIGURE with NOTES ==
 
<nowiki>{{FigImage|<fig-ID>|<fig-extension>|<fig-num>|<fig-title>|
add figure notes here ...<br>
... more
}}</nowiki>
example:
<nowiki>{{ FigImage|DB422002|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
}}</nowiki>
 
 
Giving:
{{ FigImage|DB422002|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
}}
 
 
== Image without frame and title ==
 
Syntax is very simple here:
<nowiki>[[File:<image-name-with-extension>]]
example:  |[[File:Pen-icon.png]]</nowiki>
 
Giving for exemple, if integrated in a small table:
{| class="wikitable"
|-
! table header
! header 2
|-
|[[File:Pen-icon.png]]
| This icon is a pen icon
|}
 
 
= Gallery of images =
 
 
'''''to be completed'''''
 
 
= Table =
 
 
== standard table ==
 
Syntax to use requires to add a template just before the table, and another one just after the table
 
<nowiki>{{EIG-table|<table-ID>}}
... table syntax as usual here ...
... continued ...
{{EIG-table-end|<table-ID>|<fig-num>|<table-title>}}</nowiki>
 
Example:
<nowiki>{{EIG-table|'''Tab1001'''}}
... table syntax as usual here ... just do not add any specific formatting in the first line, just:  {| class="wikitable"
... continued ...
{{EIG-table-end|Tab1001|A5|This is my table title}}</nowiki>
 
Detailed:
<nowiki>{{EIG-table|Tab1001}}
{| class="wikitable"
|-
! table header
!
|-
| the table syntax is as usual
| the rest is as usual I believe
|-
| just do not add any specific formatting in first line, just {| class="wikitable"
|}
{{EIG-table-end|Tab1001|A5|This is my table title}}</nowiki>
 
Result:
 
{{EIG-table|Tab1001}}
{| class="wikitable"
|-
! table header
!
|-
| the table syntax is as usual
| the rest is as usual I believe
|-
| just do not add any specific formatting in first line, just {| class="wikitable"
|}
{{EIG-table-end|Tab1001|A5|This is my table title}}
 
 
== tables with table notes [a] ==
 
Similar syntax to normal tables, except that you add one parameter = table notes:
 
<nowiki>{{EIG-table|<table-ID>}}
... table syntax as usual here ...
... continued ...
{{EIG-table-end|<table-ID>|<fig-num>|<table-title>|
and these are my table notes<br/>
... and more}}</nowiki>
 
Example:
<nowiki>{{EIG-table|Tab1001}}
{| class="wikitable"
|-
! table header
!
|-
| the table syntax is as usual
| the rest is as usual I believe
|-
| just do not add any specific formatting in first line, just {| class="wikitable"
|}
{{EIG-table-end|Tab1001|A5|This is my table title|
and these are my table notes<br/>
... and more}}</nowiki>
 
Result:
{{EIG-table|Tab1001}}
{| class="wikitable"
|-
! table header
!
|-
| the table syntax is as usual
| the rest is as usual I believe
|-
| just do not add any specific formatting in first line, just <nowiki>{| class="wikitable"</nowiki>
|}
{{EIG-table-end|Tab1001|A5|This is my table title|
and these are my table notes<br/>
... and more}}
 
 
= Footnotes =
 
'''''to be completed'''''
 
 
= Specific French contents =
 
 
== Just for a small text ==
 
<nowiki>{{FR-specific-text|<this is the specific text>}}</nowiki>
 
{{FR-specific-text|this is the specific text}}
 
 
== For a long specific section ==
 
<nowiki>{{FR-specific-section-start}}</nowiki>
this is the migrated content wich is french specific ...
... use usual syntax for wiki contents ...
....
....
<nowiki>{{FR-specific-section-end}}</nowiki>
 
 
{{FR-specific-section-start}}
this is the migrated content wich is french specific ...<br>
... use usual syntax for wiki contents ...<br>
....<br>
....
{{FR-specific-section-end}}
 
 
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
 
 
= Math formulas =

Dernière version du 15 mai 2018 à 07:36

page has been moved to english wiki