Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
editing-the-wiki [2017/01/25 16:55]
arthur
editing-the-wiki [2018/03/11 00:16] (current)
68.5.1.153 [Editing the Wiki]
Line 3: Line 3:
 This documentation is a [[https://​en.wikipedia.org/​wiki/​Wiki|Wiki]],​ which means anyone can edit it.  This documentation is a [[https://​en.wikipedia.org/​wiki/​Wiki|Wiki]],​ which means anyone can edit it. 
  
-Simply click the {{Edit}} button at the bottom of every page. The first time you will need to create a Wikidot account, which takes just a minute.+Simply click the <kbd>Edit</​kbd> ​button at the bottom of every page. The first time you will need to create a Wikidot account, which takes just a minute.
  
 You are very much encouraged to help us improve this documentation. ​ You are very much encouraged to help us improve this documentation. ​
Line 11: Line 11:
 In order to edit the wiki, you will need to learn a few things, like how to write in Wiki Markup language. ​ In order to edit the wiki, you will need to learn a few things, like how to write in Wiki Markup language. ​
  
-You can just write plain text, and it will be displayed, but there are ways to make it more useful : +You can just write plain text, and it will be displayed, but there are ways to make it more useful :)
  
 It is fairly simple, and you can very easily just copy the way it is done on existing pages. It is fairly simple, and you can very easily just copy the way it is done on existing pages.
Line 25: Line 25:
 To make sure lines are separated, leave an empty line between them, like this : To make sure lines are separated, leave an empty line between them, like this :
  
-[[code]]+<code>
 You can just write text and it will be displayed as-is. ​ You can just write text and it will be displayed as-is. ​
  
 To make sure lines are separated, leave an empty line between them, like this : To make sure lines are separated, leave an empty line between them, like this :
-[[/code]]+</code>
  
 === Headers === Headers
Line 35: Line 35:
 You can add headers to structure your page ( like on this page ), by doing :  You can add headers to structure your page ( like on this page ), by doing : 
  
-[[code]]+<code>
 == Header == Header
-[[/code]]+</code>
  
-The number of {{+}} signs determines how big the header is, the page title has one {{+}} sign, and the rest get more and more as they go deeper.+The number of <kbd>+</​kbd> ​signs determines how big the header is, the page title has one <kbd>+</​kbd> ​sign, and the rest get more and more as they go deeper.
  
-~~~~+~~CLEARFIX~~
  
 <​grid>​ <​grid>​
Line 55: Line 55:
 </​col>​ </​col>​
 </​grid>​ </​grid>​
-~~~~+~~CLEARFIX~~
  
 === Links === Links
Line 61: Line 61:
 To insert a link into a page, simply to :  To insert a link into a page, simply to : 
  
-[[code]]+<code>
 This is a link : [[http://​www.example.com|link name]]. This is a link : [[http://​www.example.com|link name]].
-[[/code]]+</code>
  
 === Page links === Page links
Line 69: Line 69:
 To insert a link to a page on the wiki itself, do :  To insert a link to a page on the wiki itself, do : 
  
-[[code]]+<code>
 This is a link to the [[Editing the wiki]] page. This is a link to the [[Editing the wiki]] page.
-[[/code]]+</code>
  
 === Images === Images
Line 77: Line 77:
 To insert an image, do :  To insert an image, do : 
  
-[[code]]+<code>
 [[image http://​www.example.com/​image.png]] [[image http://​www.example.com/​image.png]]
-[[/code]]+</code>
  
 A nicer way of integrating images is to do the following :  A nicer way of integrating images is to do the following : 
  
-<panel type="default" title="A laser power supply"> +<html> 
-<image shape="​thumbnail"​+<div class='panel panel-default ​wrap_right'​ style='​width:​450px;​padding:​10px '>​ 
-<html><​img ​src="http://​img.alibaba.com/​img/​pb/​960/​762/​268/​1285495147301_hz-cnmyalibaba-web4_68831.jpg"></html>+<div class='​panel-heading'><​h4 class='​panel-title'>​A laser power supply</h4></div
 +<image src='http://​img.alibaba.com/​img/​pb/​960/​762/​268/​1285495147301_hz-cnmyalibaba-web4_68831.jpg' width='​430px'​><br/>
 They use very high voltages and are dangerous They use very high voltages and are dangerous
-</panel>+</div> 
 +</html>
  
-[[code]] + 
-<panel type="default" title="A laser power supply"> +<code> 
-<image shape="​thumbnail"​+<html> 
-<html><​img ​src="http://​img.alibaba.com/​img/​pb/​960/​762/​268/​1285495147301_hz-cnmyalibaba-web4_68831.jpg"></html>+<div class='panel panel-default ​wrap_right'​ style='​width:​450px;​padding:​10px '>​ 
 +<div class='​panel-heading'><​h4 class='​panel-title'>​A laser power supply</h4></div
 +<image src='http://​img.alibaba.com/​img/​pb/​960/​762/​268/​1285495147301_hz-cnmyalibaba-web4_68831.jpg' width='​430px'​><br/>
 They use very high voltages and are dangerous They use very high voltages and are dangerous
-</panel+</div
-[[/code]]+</​html>​ 
 + 
 +</code>
  
 Which gives you a box, labels, and float control. Which gives you a box, labels, and float control.
  
-Note that you can change the floats to {{middle}} to make the image centered, or {{left}} to make it float to the left.+Note that you can change the floats to <kbd>middle</​kbd> ​to make the image centered, or <kbd>left</​kbd> ​to make it float to the left.
  
 === Commands === Commands
  
-If you are mentionning a G-code or a configuration option, we have a special syntax that makes it look {{like this}}, simply do : +If you are mentionning a G-code or a configuration option, we have a special syntax that makes it look <kbd>like this</​kbd>​, simply do : 
  
-[[code]] +<code> 
-The {{G1}} G-code is pretty cool. +The <kbd>G1</​kbd> ​G-code is pretty cool. 
-[[/code]]+</code>
  
 === Code === Code
Line 113: Line 119:
 To insert code into the page, you can use the special code tag :  To insert code into the page, you can use the special code tag : 
  
-[[code]] +<code> 
-[[code]]+<code>
 # This is redundant # This is redundant
 Some code Some code
-[[/code]] +</code> 
-[[/code]]+</code>
  
 It will be formatted as mono-space, and will not be interpreted as Wiki markup. It will be formatted as mono-space, and will not be interpreted as Wiki markup.
Line 132: Line 138:
 The syntax is :  The syntax is : 
  
-[[code]]+<code>
 <callout type="​success"​ icon="​true"​ title="​ Shiny box">​ <callout type="​success"​ icon="​true"​ title="​ Shiny box">​
 With lots of yummy information With lots of yummy information
 </​callout>​ </​callout>​
-[[/code]]+</code>
  
-You can change the color of the box by changing ​{{bs-callout-success}} to other values :  +You can change the color of the box by changing ​<kbd>bs-callout-success</​kbd> ​to other values :  
-{{bs-callout-danger}} : Red +<kbd>bs-callout-danger</​kbd> ​: Red 
-{{bs-callout-warning}} :​ Orange +<kbd>bs-callout-warning</​kbd> ​:​ Orange 
-{{bs-callout-success}} : Green +<kbd>bs-callout-success</​kbd> ​: Green 
-{{bs-callout-primary}} : Blue +<kbd>bs-callout-primary</​kbd> ​: Blue 
-{{bs-callout-info}} : Light blue +<kbd>bs-callout-info</​kbd> ​: Light blue 
-{{bs-callout-default}} : Grey+<kbd>bs-callout-default</​kbd> ​: Grey
  
 === Table of contents === Table of contents
Line 150: Line 156:
 If the page has many headers, you can add a table of contents to it to make it easier to navigate, by doing :  If the page has many headers, you can add a table of contents to it to make it easier to navigate, by doing : 
  
-[[code]]+<code>
 [[toc]] [[toc]]
-[[/code]]+</code>
  
 You can right-justify it by doing :  You can right-justify it by doing : 
  
-[[code]]+<code>
 [[f>​toc]] [[f>​toc]]
-[[/code]]+</code>
  
 Here is what it looks like :  Here is what it looks like : 
Line 168: Line 174:
 You can make nicely formatted lists by doing :  You can make nicely formatted lists by doing : 
  
-[[code]]+<code>
 * Item one * Item one
 * Item two * Item two
 * Item three * Item three
-[[/code]]+</code>
  
 They then look like this :  They then look like this : 
Line 184: Line 190:
 You can insert raw HTML into the page by doing :  You can insert raw HTML into the page by doing : 
  
-[[code]]+<code>
 [[html]] [[html]]
 <​h1>​Custom HTML</​h1>​ <​h1>​Custom HTML</​h1>​
Line 190: Line 196:
 <img src="​anything.png"​ alt="​hello ;​-)"/>​ <img src="​anything.png"​ alt="​hello ;​-)"/>​
 [[/html]] [[/html]]
-[[/code]]+</code>
  
 This is in particular useful to insert Youtube videos and the like. This is in particular useful to insert Youtube videos and the like.
Line 200: Line 206:
 For example you can format your page with two columns :  For example you can format your page with two columns : 
  
-~~~~+~~CLEARFIX~~
  
 <​grid>​ <​grid>​
Line 210: Line 216:
 </​col>​ </​col>​
 </​grid>​ </​grid>​
-~~~~+~~CLEARFIX~~
  
 You do this by writing :  You do this by writing : 
  
-[[code]]+<code>
 <​grid>​ <​grid>​
 <col md="​6">​ <col md="​6">​
Line 222: Line 228:
 Another column Another column
 </​col>​ </​col>​
-[[/code]]+</code>