ubuntu-manual team mailing list archive

[JaminDay <jaminday+ubuntu@xxxxxxxxx>]

Public bug reported:

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

** Affects: ubuntu-manual
     Importance: Undecided
         Status: New


** Tags: editing formatting

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

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