ubuntu-manual team mailing list archive

[Kevin Godby <godbyk@xxxxxxxxx>]

I've added some formatting code to handle terminal input/output and
inline code.

The terminal environment can be used for code blocks:

  \begin{terminal}
    \prompt \userinput{sudo apt-get install banshee}
    Password: \userinput{s3krE7}
    Installing banshee...
    Banshee installed!
  \end{terminal}

For inline code, use the \code command:

  Type \code{\userinput{banshee}} to start the Banshee music player.

The \prompt command prints a bash user prompt ($), \rootprompt prints a
bash root prompt (#), and \userinput will set special formatting for the
user's input -- currently set to red for easy editing and debugging.

Let me know if there are other requirements.

-- 
Currently no uniform method of writing code and directives
https://bugs.launchpad.net/bugs/504058
You received this bug notification because you are a member of Ubuntu
Manual Team, which is subscribed to Ubuntu Manual.

Status in Ubuntu Manual: In Progress
Status in Ubuntu Manual main series: In Progress

Bug description:
Not sure if this has been discussed but we need a uniform way of writing/displaying code and directives that will be consistent throughout the manual.

- By code I mean anything we are telling a reader to input into a terminal (i.e. sudo apt-get update)

- By directives I mean anything that directs a user (i.e. click on system->preferences->appearance etc)

I think we need to decide on how we want these to be displayed in the manual, so that we can write them correctly into the latex documents as we go. This should save a heap of time later on.

Things to consider 
- do we want code to sit in a 'code block' (similar to a text box), be written in-line in the paragraph, have a line break before and after, or some other method of identifying "this should be written into a terminal".
- should we use quotation marks around directives? If so should they be single or double?
- should there be arrows between directives (such as above example), or comma's, or something else?

Jamin