Guidelines for Writing this Manual: Difference between revisions

From Bluefish Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOEDITSECTION__
{{Man2top
{{Man2top
|lang=en
|lang=en
Line 10: Line 8:
|next=Man 2 apd
|next=Man 2 apd
}}
}}
== Appendix C. Guidelines for Writing this Manual ==
{{toc}}
 
== Using Bluefish 2 to edit Bluefish 2 Manual ==
 
[[Bluefish mediawiki]]
=== Templates ===
== Templates ==
=== Navigationals Templates ===
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'''.
Line 20: Line 19:
'''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>.}}
 


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


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 />task will be more easy!}}


{|
{|

Revision as of 15:35, 30 December 2009

 

Using Bluefish 2 to edit Bluefish 2 Manual

Bluefish mediawiki

Templates

Navigationals Templates

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

Template:Man2top Template:Man2bottom

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.

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...
task will be more easy!