Guidelines for Writing this Manual: Difference between revisions

From Bluefish Wiki
Jump to navigation Jump to search
mNo edit summary
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOEDITSECTION__
{{Man2top
{{Man2top
|lang=en
|lang=en
|rev=2.0.0
|rev=2.0.0
|st=d
|st=v
|Title=Appendix C. Guidelines for Writing this Manual
|Title=Appendix C. Guidelines for Writing this Manual
|prev=Man 2 apb
|prev=Man 2 apb
Line 10: Line 8:
|next=Man 2 apd
|next=Man 2 apd
}}
}}
== Appendix C. Guidelines for Writing this Manual ==
{{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 ==
See: [[Bluefish mediawiki editor]]. [[Mediawiki snippets]] have snippets for Bluefish Manual: note, tip, important, warning, clear, framed image.


=== Templates ===
== Templates ==
=== 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]]
[[File:Man2 template editing.png|none|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>|st=d</tt> by <tt>|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}}


=== Tips and Notes Templates ===
Bluefish Wiki Manual use templates for:
Bluefish Wiki Manual use templates for:
{|
{|
Line 36: Line 46:
|}
|}


example:
==== examples ====
 
{|border=1 cellpadding=5
{|border=1 cellpadding=5
|<nowiki>{{note|</nowiki>text=mytext here, use <nowiki><br /></nowiki> to break lines.<nowiki>}}</nowiki>
|<nowiki>{{note|</nowiki>text=mytext here, use <nowiki><br /></nowiki> to break lines.<nowiki>}}</nowiki>
|{{note|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}}
|{{note|text=mytext here, use <nowiki><br /></nowiki><br />to break lines.}}
|-
|<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.}}
|}
|}
{{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

Man2 note.gif Your are a bluefish user? You can help to write the Bluefish 2 Manual!
  • first step: create an account,
  • second step: feel free to edit te manual,
  • third step: thanks for your help! :)


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

Top and bottom menus

Bluefish Wiki Manual use 2 templates for navigation: Man2top and Man2bottom.
They do not usually need to be edited.

Template:Man2top Template:Man2bottom

Man2top and Man2bottom templates do not usually need to be edited. Exceptions:

Man2 note.gif When you read a page, and make any necessary corrections so that this page conforms to Bluefish version 2.0.0,
thank you for changing the status, from d (draft) to u (update).

ie: |st=d by |st=u.

Man2 tip.gif After a Bluefish version update, you have to modify the rev parameter.


Tips and Notes Templates

Bluefish Wiki Manual use templates for:

note: tip: important: warning:
Man2 note.gif this is a note.
Man2 tip.gif this is a tip.
Man2 important.png this is important!
Man2 warning.png this is a warning!

examples

{{note|text=mytext here, use <br /> to break lines.}}
Man2 note.gif mytext here, use <br />
to break lines.
{{warning|text=mytext here, use <br /> to break lines.}}
Man2 warning.png mytext here, use <br />
to break lines.
Man2 tip.gif use Bluefish mediawiki snippets to edit this manual...
the task will be easier!

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: Top.png

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]]
|}

Top.png