As well as looking professional, I think we need to consider how people will actually use the manual. I think it will be quite rare that folk will actually read the book from front cover to back cover. More often, they will check the index and skip forward to the chapter most relavent to them.
Because of that, I think that if we have a "code block" or other method of showing the input should be into a terminal (or gui or other interface), then it should be just as obvious in chapter 11 as chapter 4. Maybe we could actually use screenshots of terminal guis where there is a terminal input? -- 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: Confirmed Status in Ubuntu Manual main series: Confirmed 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 _______________________________________________ Mailing list: https://launchpad.net/~ubuntu-manual Post to : ubuntu-manual@lists.launchpad.net Unsubscribe : https://launchpad.net/~ubuntu-manual More help : https://help.launchpad.net/ListHelp
