ubuntu-manual team mailing list archive

[Benjamin Humphrey <humphreybc@xxxxxxxxx>]

"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"."

- Definitely not written in-line. It needs to be separate on its own
line. I'm not a huge fan of code blocks - they look ugly. Unless we can
beautify our code blocks, then I don't really want that.

I think a line break before and after, and just have the style set to
monospace, something that's blindingly obvious as code.

"should we use quotation marks around directives? If so should they be
single or double?"

- I don't think we need quotation marks around directives. I'm not sure
about this, anyone else got an idea?

"hould there be arrows between directives (such as above example), or
comma's, or something else?"

- Once again, arrows would be good, but only if we can make them look
nice!

** Changed in: ubuntu-manual
   Importance: Undecided => High

** Also affects: ubuntu-manual/main
   Importance: High
       Status: New

-- 
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: New
Status in Ubuntu Manual main series: New

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