On Sun, 2011-08-07 at 20:12 -0400, Andrew Douglas Pitonyak wrote: > Sorry to be a bother, but I do not know my way around well, and, I could > not find the document that tells me how things should look, and, I do > not want to change things if I am not sure that they should be done. So, > where is the "do it this way" documentation? I am sorry for all the > questions, but, this is my first LO document so I assume that the > documents are as they should be and that everyone knows more than I.
The "Documentation Contributors' Guide" is still being written. The existing chapters are in two places: on the wiki (linked from this page) http://wiki.documentfoundation.org/Documentation/Development#First_steps_with_the_Documentation_team and on Alfresco under English Content > Documentation > Resources, where you will also find the current chapter template (don't get the book template by mistake; there are some differences). Ignore the chapter titled "Using LibreOffice's Alfresco website" as it is very out of date and bears only occasional resemblance to the current website; David will update it when he finished tweaking the current site. > > For example: > > QUESTION: > A newly inserted figure (that is nicely done, by the way), does NOT > contain a caption and is not in a frame. My instinct is to add a caption > and place the figure in a frame, because it looks like this is true for > all other figures. My assumption is that either (1) there is a reason > this does not need to be done like the others, (2) Martin forgot, (3) > Martin did not know better, or, the most likely yet, (4) Martin did > everything perfectly, and Jean pulled it out and removed the caption to > test me :-) Not this time! I haven't touched the file. However, to answer the question, figure captions are not always necessary (this is discussed in one or another of the chapters of the Contributors' Guide) but in the case most likely Martin forgot. > > QUESTION: > With OpenOffice.org, I always wrote OOo. For LibreOffice, should I use > LibO rather than LO? We have been avoiding using an abbreviation, as there has been no real consensus about what abbreviation to use. Some books, such as the Getting Started guide, were done before we had sorted out some of the consistency issues, so you'll find it both internally inconsistent and not consistent with some of the other books. This will get sorted out in time. > QUESTION: > In the document, I found new text that reads similar to: > > click Tools → Options → LibreOffice → General and tick the box > <Italics>Enable experimental (unstable) features</Italics>. > > I expected to see: > > use <OOoMenuPath>Tools → Options → LibreOffice → General</OOoMenuPath> > and tick the box <OOoMenuPath>Enable experimental (unstable) > features<OOoMenuPath>. You are correct. But we don't use "tick the box"; in this case I would say "...and select the <OOoMenuPath>Enable experimental (unstable) > features<OOoMenuPath> option. > If I wanted Italics, I expected to use the <OOoEmphasis> style. That is correct. > > COMMENTS FOR MARTIN: > > Martin, your new figures look great and it seems that you paid good > attention to detail. I will change wording where it is not sufficiently > precise; for example, when you state that the "Writer Library" is > selected, it is really the Writer Module in the Martin Library. Without > checking, my guess is that I introduced this error in the original. Thanks, Andrew! --Jean -- Unsubscribe instructions: E-mail to [email protected] Problems? http://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: http://wiki.documentfoundation.org/Netiquette List archive: http://listarchives.libreoffice.org/global/documentation/ All messages sent to this list will be publicly archived and cannot be deleted
