GUI for documentation, good or bad?

Little Girl littlergirl at gmail.com
Wed Oct 22 14:33:43 UTC 2008


Hey there,

shirish wrote:

>  I have seen the guides which are there but still couldn't find one
> which is equivalent to the  [CODE] stuff [CODE] which is there in
> the forums. For an e.g. look at this post :-
 
> http://ubuntuforums.org/showpost.php?p=5817554&postcount=32
 
> What I specifically want is to have the code like its shown there,
> it makes it for people who perhaps do not want to read the code as
> well as easy with the scrollbar on the left within the page itself.
 
> If something like that can be done it would be cool.

How about this?

If you do {{{this}}} in your text, the word "this" will be in
monospace font and the rest of the text will be in plain text.

If you do:

{{{
this
}}}

Then the word "this" will be in a colored box on the screen. The box
will be aligned to the left.

If you want to indent the box, add a space before the first set of
brackets, like:

 {{{
this
}}}

Then "this" would be in a box that's indented and not aligned left.
This is useful for when you have a:

 * bulleted
 * list
 {{{
and want to include code that's indented like your list.
}}}

Each space you use will add another level of indentation.

This page uses both methods, so you can see it in action:

https://help.ubuntu.com/community/WikiGuide/Formatting

-- 
Little Girl

There is no spoon.




More information about the ubuntu-doc mailing list