Guidelines for Writing this Manual: Difference between revisions
m (→Templates) |
m (→examples) |
||
(18 intermediate revisions by 2 users not shown) | |||
Line 9: | Line 9: | ||
}} | }} | ||
{{toc}} | {{toc}} | ||
== create an account == | |||
{{note|text= | |||
Your are a bluefish user? You can help to write the Bluefish 2 Manual! | |||
* first step: [[Special:UserLogin|create an account]], | |||
* second step: feel free to edit te manual, | |||
* third step: thanks for your help! :)}} | |||
<br style="clear:both"/> | |||
== Using Bluefish 2 to edit Bluefish 2 Manual == | == Using Bluefish 2 to edit Bluefish 2 Manual == | ||
[[Bluefish mediawiki]] | See: [[Bluefish mediawiki editor]]. [[Mediawiki snippets]] have snippets for Bluefish Manual: note, tip, important, warning, clear, framed image. | ||
== Templates == | == Templates == | ||
=== Top and bottom menus === | === Top and bottom menus === | ||
Bluefish Wiki Manual use 2 templates for navigation: '''Man2top''' and '''Man2bottom'''.<br /> | Bluefish Wiki Manual use 2 templates for navigation: '''Man2top''' and '''Man2bottom'''.<br /> | ||
'''They do not usually need to be edited'''. | '''They do not usually need to be edited'''. | ||
[[File:Man2 template editing.png|left|frame|Template:Man2top Template:Man2bottom]] | |||
Man2top and Man2bottom templates do not usually need to be edited. | |||
'''Exceptions''': | '''Exceptions''': | ||
{{note|text=When you read a page, and make any necessary corrections so that this page conforms to Bluefish version 2.0.0, <br />thank you for changing the status, from '''d''' (draft) to '''u''' (update).<br /> | {{note|text=When you read a page, and make any necessary corrections so that this page conforms to Bluefish version 2.0.0, <br />thank you for changing the status, from '''d''' (draft) to '''u''' (update).<br /> | ||
ie: <tt><nowiki>|</nowiki>st=d</tt> by <tt><nowiki>|</nowiki>st=u</tt>.}} | ie: <tt><nowiki>|</nowiki>st=d</tt> by <tt><nowiki>|</nowiki>st=u</tt>.}} | ||
{{tip|text=After a Bluefish version update, you have to modify the rev parameter.}} | |||
{{clear}} | {{clear}} | ||
Line 45: | Line 54: | ||
|{{warning|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}} | |{{warning|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}} | ||
|} | |} | ||
{{tip|text=use [[Bluefish mediawiki snippets]] to edit this manual...<br />task will be | {{tip|text=use [[Bluefish mediawiki snippets]] to edit this manual...<br />the task will be easier!}} | ||
=== Clear Template === | |||
You can write <nowiki>{{clear}}</nowiki> as a shortcut of <nowiki><br style="clear:both" /></nowiki><br /> | |||
The next element will be moved below all floating boxes of earlier elements. | |||
=== Top Template === | |||
You can write <nowiki>{{top}}</nowiki> to create a link to the top of the page: {{top}} | |||
=== Toc Template === | |||
You can write <nowiki>{{toc}}</nowiki> to create a floating right ToC | |||
=== Images === | |||
see mediawiki manual: [http://www.mediawiki.org/wiki/Help:Images#Syntax Images Syntax]<br /> | |||
<small>note: to add in snippets and bflang2</small> | |||
In the manual images are framed with a title:<br /> | |||
==== One image ==== | |||
For one large image, with text on top and/or bottom:<br /> | |||
<pre>[[File:Man2_snippet_insert_dialog.png|none|frame|snippet insert dialog]]</pre> | |||
For a small image floating left with text on the right: | |||
<pre>[[File:Man2 create snippet4.png|left|frame|lorem ipsum]] | |||
lorem ipsum | |||
{{clear}}</pre> | |||
==== More images ==== | |||
In this case we use a table: | |||
<pre>{| | |||
|valign="bottom" align="center"|[[File:Man2 create snippet.png|none|frame|lorem ipsum]] | |||
|valign="bottom" align="center"|[[File:Man2 create snippet2.png|none|frame|lorem ipsum]] | |||
|valign="bottom" align="center"|[[File:Man2 create snippet3.png|none|frame|lorem ipsum]] | |||
|}</pre> | |||
{{top}} | |||
{| | {| | ||
{{Man2bottom | {{Man2bottom |
Revision as of 20:43, 4 September 2015
create an account
|
Using Bluefish 2 to edit Bluefish 2 Manual
See: Bluefish mediawiki editor. Mediawiki snippets have snippets for Bluefish Manual: note, tip, important, warning, clear, framed image.
Templates
Bluefish Wiki Manual use 2 templates for navigation: Man2top and Man2bottom.
They do not usually need to be edited.
Man2top and Man2bottom templates do not usually need to be edited. Exceptions:
|
|
Tips and Notes Templates
Bluefish Wiki Manual use templates for:
note: | tip: | important: | warning: | ||||||||||||
|
|
|
|
examples
{{note|text=mytext here, use <br /> to break lines.}} |
| |||
{{warning|text=mytext here, use <br /> to break lines.}} |
|
|
Clear Template
You can write {{clear}} as a shortcut of <br style="clear:both" />
The next element will be moved below all floating boxes of earlier elements.
Top Template
You can write {{top}} to create a link to the top of the page:
Toc Template
You can write {{toc}} to create a floating right ToC
Images
see mediawiki manual: Images Syntax
note: to add in snippets and bflang2
In the manual images are framed with a title:
One image
For one large image, with text on top and/or bottom:
[[File:Man2_snippet_insert_dialog.png|none|frame|snippet insert dialog]]
For a small image floating left with text on the right:
[[File:Man2 create snippet4.png|left|frame|lorem ipsum]] lorem ipsum {{clear}}
More images
In this case we use a table:
{| |valign="bottom" align="center"|[[File:Man2 create snippet.png|none|frame|lorem ipsum]] |valign="bottom" align="center"|[[File:Man2 create snippet2.png|none|frame|lorem ipsum]] |valign="bottom" align="center"|[[File:Man2 create snippet3.png|none|frame|lorem ipsum]] |}