Guidelines for Writing this Manual: Difference between revisions
Jump to navigation
Jump to search
m →Images |
DrMartinus (talk | contribs) →Tips and Notes Templates: Added the "Important" example |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 11: | Line 11: | ||
== create an account == | == create an account == | ||
{{note|text= | |||
You are a bluefish user? You can help write the Bluefish 2 Manual! | |||
* first step: [[Special:UserLogin|create an account]], | * first step: [[Special:UserLogin|create an account]], | ||
* second step: feel free to edit | * second step: feel free to edit the manual, | ||
* third step: thanks for your help! :) | * 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 == | ||
See: [[Bluefish mediawiki editor]]. | 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'''. However, since their output was scrambled up, they are, for now, disabled. | ||
[[File:Man2 template editing.png|left|frame|Template:Man2top Template:Man2bottom]] | [[File:Man2 template editing.png|left|frame|Template:Man2top Template:Man2bottom]] | ||
Man2top and Man2bottom templates do not usually need to be edited. | 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. | {{note|text=When you read a page, and make any necessary corrections so that this page conforms to Bluefish version 2.2.12, <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 | {{tip|text=After a Bluefish version update, you have to modify the rev parameter.}} | ||
{{clear}} | {{clear}} | ||
=== Tips and Notes Templates === | === Tips and Notes Templates === | ||
Bluefish Wiki Manual | Bluefish Wiki Manual uses templates for: | ||
{| | {| | ||
|align="center"|'''note''': | |align="center"|'''note''': | ||
| Line 52: | Line 55: | ||
|<nowiki>{{warning|</nowiki>text=mytext here, use <nowiki><br /></nowiki> to break lines.<nowiki>}}</nowiki> | |<nowiki>{{warning|</nowiki>text=mytext here, use <nowiki><br /></nowiki> to break lines.<nowiki>}}</nowiki> | ||
|{{warning|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}} | |{{warning|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}} | ||
|- | |||
|<nowiki>{{Tip|</nowiki>text=mytext here, use <nowiki><br /></nowiki> to break lines.<nowiki>}}</nowiki> | |||
|{{Tip|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}} | |||
|- | |||
|<nowiki>{{Important|</nowiki>text=mytext here, use <nowiki><br /></nowiki> to break lines.<nowiki>}}</nowiki> | |||
|{{Important|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}} | |||
|} | |} | ||
{{ | |||
{{Tip|text=use [[Bluefish mediawiki snippets]] to edit this manual...<br />the task will be easier!}} | |||
=== Clear Template === | === Clear Template === | ||
| Line 86: | Line 97: | ||
|}</pre> | |}</pre> | ||
{{top}} | |||
{| | {| | ||
{{Man2bottom | {{Man2bottom | ||
Latest revision as of 11:51, 22 December 2022
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. However, since their output was scrambled up, they are, for now, disabled.
Man2top and Man2bottom templates do not usually need to be edited. Exceptions:
|
|
Tips and Notes Templates
Bluefish Wiki Manual uses 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.}} |
| |||
| {{Tip|text=mytext here, use <br /> to break lines.}} |
| |||
| {{Important|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]]
|}