Apache OpenOffice (AOO) Bugzilla – Issue 29679
User Guide 2 task
Last modified: 2008-12-17 10:32:42 UTC
I have decided that my user guide is okay since nobody complained. I am only attaching the pdf as it is not finished but I think it should go on the documentation website.
Created attachment 15568 [details] Draft user guide
I was a bit too quick off the mark and left the last page unformatted. Fixed and attached new pdf
Created attachment 15569 [details] User Guide updated
Changed this to a task so it shows up in the list.
Created attachment 16190 [details] Chapter 3 - Writer completed.
Needs proofing, please.
Added the draft PSF to the www repository. With Jean Hollis Weber taking her pdf off-line, it is needed. Re-assigning to myself.
Changing status to started
Removing from the archive. Seems that people do NOT understand what a draft is and thus the document is NG.
Created attachment 16495 [details] Proof of guide
Created attachment 16499 [details] user_guide revised
Added Calc chapter and put on line. No sources yet. Please review the latest version from the HOW-TO webpage.
Page 137: Individulally > >>138: When numbers are changed in the table, the sum is automatically be > >>updated. Thanks for making this tutorial available!
mmaher: reassigning
My issue.
PDF now includes chapters on: 1. Using help 2. General OOo usage 3. Writer 4. Calc 5. Impress 6. Draw plus table of contents and the PDL and front matter stuff. I am working on the Database chapter and will complete the troubleshooting section and index soon, I hope. Even though it is a work in progress I hope it is useful to our user base. Please tell them about it. Please check that I haven't missed something important. I think that each chapter is complete but then ...
Updated on-line pdf. Chapter list is as follows: 1. Using help 2. Working with OpenOffice.org 3. Writer 4. Calc 5. Impress 6. Draw 7. Databases and DataSources (partial) 8. Advanced Configuration (place holder) 9. Advanced Techniques 10. TroubleShooting some Common Problems (Incomplete and looking for ideas) 11. Index (place holder) 12. PDL Any ideas welcomed
ompleted and added Chapter 7. Databases and DataSources
Updated to include hyperlinked TOC and start of an Index.
User guide is relatively complete. Needs some more proofing and possibly some indexing.
Created attachment 20865 [details] Source of User guide
Created attachment 20866 [details] PDF of User Guide
Following exchanges on users@openoffic.org and because I was told that when this writeup appeared the change in documentation would promptly follow, certain constructs and assumptions for creating formulas for use in tables in Writer are not obvious to a "typical" user, for example the "implied IF". As most current and potential users of OOo are not programmers, the "implied IF" and similar features need to be carefully explained in the Help files and the Users Guide.
That is what you put in the email to the list. This is not the explanation I was expecting. I am working on 2.0 docs and would appreciate something a bit more inclusive and explains the problem in the way you expect.
Start on user guide for 2.0
Created attachment 27835 [details] 2nd editon of 2.0 users guide
updated to 4th edition
Created attachment 29447 [details] 4th edition
Created attachment 29822 [details] 5th edition -- updates
Added Xforms. Please review carefully. icons are still 1.1.x but I do have a complete set of what is in 2.0 and am replacing them bit by bit.
Created attachment 29921 [details] 6th edition. Xfors chapter added
It seems like changes/corrections were wanted on this bug number. Let me know please if I'm not doing the right thing. I'll be reading the document over the next few days while I can. On Page 52, the OASIS file format is described. The specification doesn't display the Thumbnails/thumbnails.png section. This is where a screenshot of the first page of the document is stored. Image is PNG with a transparent background.
Re: Thumbnail. Good call I have/would miss this. Fixed. Aside from graphics of icons, are there any other 1.1.x things I missed?
Created attachment 30054 [details] 7th edition with updated OpenDoc section
Created attachment 30823 [details] Sept 30 with index
In Chapter 2, the section "The OpenOffice.org Writer Window" has a screenshot taken from OOo 1.1.1. In the same chapter, the section starting "The Menu Bar" there is a sentence that reads, "In addition, the menus are context sensitive,." which ends with a comma and then a full stop. I'm not sure whether this is meant to be a run-on into the next sentence. The next sentence has a space before the full stop at the end, "the current work will be available ." The sections starting "The Toolbars" and ending with "Docking windows" still describe the features from OOo 1.1 and could use an overhaul. The behaviour of the toolbars and floating windows/toolbars has changed quite a lot and these sections seem to have a mix of descriptions from OOo 1.1 and 2.0.
In the 2.0 User guide, page 31 of the PDF, is the sentence: CustomShapes are shapes that cannot only change their size but also their appearance. "CustomShapes are shapes that not only can change their size, but also their appearance." is clearer.
I may have caught this one earlier, but on p. 32 of the PDF of the 2.0 User's Guide, the sentence: 'The new embedded Java technology based HSQLDB database engine allows to create "database documents".' is missing a subject.
Thanks Stewart. I will be working on this over the next little while. If you spot glaring differences between 1.1.x and 2.0 feel free to point out page and paragraph locations so I can get new words or screenshots. Currently I am adding new stuff like how to add flat xml file import and export and am ignoring the rest.
On page 32 of the pdf of the User's 2.0 guide, the section on Mail Merge unexpectedly shifts to future tense.
On p. 32 of the pdf on the 2.0 User's Guide, the sentence: 'This increases the overall usability, but also improves the Microsoft Word compatibility.' would be clearer with an 'and' in place of the 'but'
On p. 32, the sentence: 'OpenOffice.org 2.0 now allows to create forms based on the open W3C XForms standard.' is missing its subject.
On page 33, the sentence: 'OpenOffice.org 2.0 supports the native installation mechanisms. For example, .MSI and .CAB files are provided on Microsoft Windows, RPM, and .deb files are available for Linux.' would be clearer with a semi-colon after "Windows", or, better, two sentences.
On p. 36 of the User's Guide, the sentence: 'Tips are defaulted to being on at installation and it is recommended that this feature should' might be clearer if the awkward 'defaulted' were changed to 'Tips are on by default...'
On p. 36, the sentence: 'Switch on the Extended Tips during the first few weeks of OpenOffice.org usage. Enabling this fun gives a brief description of each item on the screen when the mouse pointer is hovered over the item for a moment.' contains the word 'fun'. Did you mean 'item' or 'option'? (Oh, boy...I'm picky tonight, aren't I?)
On p. 36, the sentence: 'If a Help Agent dealing with the same topic is repeatedly ignored or closed instead of being clicked, it does appear again for this topic.' doesn't make logical sense as written. Perhaps 'does not appear'? The sentence: 'Resetting the Help Agent restores it to the way it was when OpenOffice.org was first installed.' introduces a concept, Resetting the Help Agent', not yet explained.
Thanks and keep em coming.
On page 41, the sentence: 'In other words, the commands, used for editing, viewing, sequencing, formatting and printing, et cetera a document or its contents, can only be used when the document is open and active, where active, in this case, means that the document has to be in front of any others on the screen.' has excess commas and is run-on. Suggest: In other words, the commands used for editing, viewing, sequencing, formatting and printing a document can only be used when the document is open and active. Active, in this sense, means that the document is front of any others on the screen.
The menu bar section on p. 41 seems awfully jumbled to me. If I may step out of my copy editor's role, I would suggest that some of the material might be clearer in another location. The paragraph also has a number of punctuation errors. I would suggest consideration of a rewrite.
On page 43 of the pdf, an example is given in regard to long clicking the Insert icon. I cannot find such an icon on my installation, and I thought I had been careful not to disturb the default. Also, the sentence 'If one now clicks the Insert Graphics icon, notice that this icon has replaced the original icon a the top of the main toolbar.' is incorrect.
The section on Docking windows on p. 43 has me baffled. I cannot successfully follow the directions to get the results described. A rewrite might be in order.
Note on p. 48, word 'documents' should be 'document'
p. 49 'The user can change from this directory as follows:' => 'The user can change this directory as follows:'
P.49 'Using this feature is the equivalent to saving the current document as manually pressing Ctrl+S.' => 'Using this feature is the equivalent to saving the current document by manually pressing Ctrl+S.'
p. 51: 'These file name extensions permit reasonable differentiation when searching though a lot of files of different file types in a directory. Since these are compressed XML files ,' => 'These file name extensions permit reasonable differentiation when searching though a lot of files of different file types in a directory. Since these are compressed XML files,'
Since I knew nothing about constructing xforms, I used the guide to walk me through the process for the first time. I'm not a new to OOo but here are my comments about this chapter (chapter 12) from a xform newbie perspective. Overall excellent... walked me through step by step. At the beginning however (just before the bullet points explaining what the guide will do, there should probably be a sentence saying: "The following are the steps required to create an xform:" Bullet #4 - it would be helpful if there were pointers to where documentation could be found about other types of submissions. Only 'putting' to file was walked through, however people would probably be also keen on emailing and 'putting' to a server. Bullet #5 - guide doesn't say what 'usage mode' is. Assume that this is non- design mode? Bullet #5 - guide does say that you can send the form to others for completion, but doesn't say what format you should save it in to do this. I believe you can export to PDF (but this is not mentioned) for users to complete, but are there other formats? Point 6.. currently reads "adf", probably should be something like: "Complete the properties box as shown below for each of the controls on the form." Point 10.. instead of "fAMount" it should be "Amount" Point 10... for me the "A value is required" box did not come up, but that is more likely something I did rather than the guide. Point 12 ... the screen shot shows an incorrect 'action' path. The screen shot in point 13 shows the correct path that should be entered. It would be good if the screen shots match and the correct path is shown in Point 12 (took me 10 minutes to work out what the path should be). It may also be a good idea, at this point, to indicate where the user can read more about other types of submissions, or alternatively short examples of what is required to complete other types of submissions. Point 13 ... "Toggel Design..." should really be "Toggle Design...". There is no mention of how the submission 'button' got on the form. I found out that you can drag them onto the form from the 'submissions tab' but you could also create a new button then place a control on it. Either method should probably be described. Point 14 ... "of the submis as stored..." should really be "of the submission as stored..." Again this is probably more me than the guide, but somehow I found extra characters in my XML like : ... <instanceData>dfvfdgdfg<Name>... There was no mention of what the 'instanceData' is, or how I accidentally set this. Potentially some words around this would be good. You mention it also at the beginning which may be a place to comment on it. Thats it... again, excellent guide – got my xform working (as per the example) in about 20 minutes – congratulations...
P. 56 of the PDF. there's a missing comma before 'et cetera'. in the section displaying print previews.
p. 57 of the PDF, "Printing in black & white" Black & white => Black & White
On p. 30 of the text (why I've been citing to pages on the PDF is anyone's guess. I bet that's made you crazy) we have: '(most printers require that users take out the paper after the first half of the printing process and feed it in again with the blank side of the page facing upward)' On p. 31, we have: 'take the pages from the output tray and put them into the input tray in such a way as to print on the blank side and choose the opposite Page setting as in step 1' This is much clearer, as some printers don't load paper horizontally. I'd suggest p. 30 be edited to be more like p. 31.
On p. 31, in the sentence: 'The automatic spellcheck that works while typing in text' the phrase 'that works while typing in text' is redundant.
On p. 32, the paragraphs: The easiest way to correct a red-underlined word is to right-click it. This opens a context menu that offers several alternative words to choose from. Click one of the alternatives and the red underlined word will be replaced with the alternative. Where a red-underlined word should be included in a user dictionary, because it is correctly typed, use the context menu. When a red underlined word is replaced with a suggestion from the spellcheck via the context menu, working with a document is made much easier to deal with frequent typing errors. Upon clicking the suggestion,OpenOffice.org not only replaces the red-underlined word with the suggestion selected, it also remembers this replacement while the document is open. If the same typing error is made again, Spellcheck automatically replaces the mistyped word with the word that replaced it previously. Might be clearer as: The easiest way to correct a red-underlined word is to right-click it. This opens a context menu that offers suggested corrected spellings, and options to add the word to the dictionary or to ignore it. Simply click the correct suggested spelling to replace the red-underlined word. Spellcheck not only replaces the red-underlined word with the suggestion selected, it also remembers this replacement while the document is open. If the same typing error is made again, Spellcheck automatically replaces the mistyped word with the corrected spelling. If the word is spelled correctly, it may be added to a dictionary by clicking Add and specifying to which dictionary it is to be added. To ignore a correctly spelled, but infrequently used word, click Ignore All.
P. 32 'OpenOffice.org Writer can manage spellchecking (plus thesaurus and hyphenation) in multiple languages (33 at the time of writing). The OpenOffice.org setup program offers this via “Custom Installation†and, after installation via the “Modify†option in setup, where one can choose which language modules to install.' Needs a reference to "setup". This is a new concept, and many users will not know how to apply this information.
p. 33. The information about hyphenation in user dictionaries seems misplaced in the section on "classic" spellcheck.
P. 35 'OpenOffice.org can either format documents while typing or afterwards, plus correct typing errors. AutoFormat and AutoCorrect will work while typing, thereby letting the user draft documents much more efficiently. Here are a couple of examples.' might be clearer as: In addition to catching typing errors, OpenOffice.org can format documents while typing or afterwards. AutoFormat and AutoCorrect permit the user to draft documents much more efficiently by automatically formatting and correcting common errors while the user types. Here are a couple of examples.
Same page, 'Automatic bulleting ends when there is no text is entered in a new paragraph is completed by only pressing Return.' => 'Automatic bulleting ends by two Returns.' or 'Automatic bulleting ends when the user enters a blank paragraph containing only a Return.'
P. 35, the section on Autoformat seems jumbled. I'd suggest: In text documents, toggle AutoFormat on or off by selecting Format >AutoFormat. A submenu with three selections appears. To automatically format while typing, check the While Typing selection. To have Writer automatically format the entire document or the current selection at a later time, check the menu selection Apply. Selecting Apply and Edit Changes lets the user see all document changes made via AutoFormat. The user then may accept or reject all changes or may review each change separately. There was also an incorrect apostrophe.
P 35 'AutoCorrect offers many options that can selectively turned on and off.' => 'AutoCorrect offers many options that can selectively be turned on and off.'
P. 37 'For example, type (C), this is immediately turned into the copyright symbol.' => 'For example, (C) is immediately turned into the copyright symbol'
P. 38 'For example, “ASAP†with the text “as soon as possibleâ€; however, the OpenOffice.org AutoText function is a better choice for doing this' => 'For example, replace “ASAP†with the text “as soon as possibleâ€; however, the OpenOffice.org AutoText function is a better choice for doing this'
P. 39 might be smoother as: Treat this section as a tutorial on the OpenOffice.org template Wizard. Although the Wizard does produce a document that can immediately be filled in, printed, and sent, using the Wizard is really meant to help create customized templates. Customized templates for such things as business letters, faxes and other types of documents for which there is a Wizard ensures that correspondence has a consistent format. While one may, there is no need to go through all the steps of the Wizard each time one wants to write a letter. However, in order to get the most from the following, it is recommended that one accept all the defaults provided without changing them, and then print the result. Click Next on each dialogue page, so that every page is seen at least once during the learning process. Examine each of the Wizard pages while going through the process of creating a letter template. Enter data or modify options on each page as necessary. Each page allows modifications according to each user's preferences including sender and recipient addresses, both of which can also be entered manually. (For example, sender information is automatically taken from the personal details that each user enters at the time of installation. These details may be changed at any time by selecting Tools > Options >OpenOffice.org > User Data and entering new information or editing existing details.) Predefined elements will appear but users always have the final say on what to include in their letter.
P. 40 had some punctuation errors, and an odd voice. I would suggest: Let's say the word “Holland†appears somewhere in a long text and the user wishes to locate it. Activate the Find function with Ctrl+F. Enter the string one wants to find in the Search for field and press Enter. OpenOffice.org starts searching from the current cursor position toward the end of the document. Upon reaching the end of the document, a new dialogue appears asking whether or not to continue the search at the beginning of the document. Tap the Enter key to confirm. If the text string is found, it is highlighted.
Stewart, would it make any sense to have you just edit the file and attach it here? If you have changes record and show on in the file I can simply use this to integrate new stuff and it might be quicker all around. I am finding time hard to come by :-(
p. 40 'One very useful feature is the multi-selection facility Find All. For instance, using Find All, one could set every occurrence of the word “document†in the text to boldface. Enter the search term in the Search for field and then click Find All. All occurrences are now selected. Place the cursor in the Replace field, and click the Bold icon in the text object bar to boldface all occurrences of the search term.' might be smoother.
Ooops. p. 41, I mean
On p. 41 we have, 'If searching using regular expressions or for Styles, do not select this option.' The term 'regular expressions' is a desceptive one in that it means one, very precise, thing to an advanced computer user, and something entirely different to a novice. It should probably be explained in some fashion before moving on.
P. 41. Here's another in that same vein: 'Regular expressions are shown in a form that should be familiar to Unix command line users:' No doubt, but the target audience should be Joe Business and Aunt Tillie, not bearded wearers of Birkenstocks. To the extent it can be done, it would be well, I would think, to eliminate references to *nix cli's and other such things. (Spoken as a true-blue bearded *nix fanatic.)
P. 42, Searching backward: 'When locating a frequently appearing word in a long text, the user might click find once too often by mistake. Select Backward and click again on Find to return to the location of the previously found item.' might be smoother.
p.42 The sections on searching for styles, attributes and special formats do not describe the behavior of v. 2.0
Created attachment 31314 [details] latest edition
Created attachment 31318 [details] Chapters 1 & 2 copy edited
Chapter 3: The OpenOffice Writer window is referencing a graphic that seems to be missing. The elements referred to do not appear in the graphic that is there, at any rate. Also, you have a registered mark following the generic word "Windows". Bill can't quite trademark ever instance of that word ;)
Chapter 3. My copy does not show an Isrt or Over field in the status bar. That space is blank. Is this a v. 2.0 change, a Linux thing, or have I inadvertently turned it off?
Chapter 3 mentions the Hyperlink Bar, viz.: 'Point to the Hyperlink, then click and hold down the mouse button as you drag the Hyperlink to the Hyperlink Bar.' without first describing what the Hyperlink bar is, or how one might work with it.
Created attachment 31389 [details] zipfile of master doc and all chapters
Created attachment 31390 [details] master file
Created attachment 31391 [details] TOC for master
Created attachment 31392 [details] copyright followd TOC
Created attachment 31393 [details] overview follows copyright
Created attachment 31394 [details] new features follows overview
Created attachment 31395 [details] chapter 1
Created attachment 31396 [details] chapter 2
Created attachment 31397 [details] chapter 3
Created attachment 31398 [details] chapter 4
Created attachment 31399 [details] chapter 5
Created attachment 31400 [details] chapter 6
Created attachment 31401 [details] chapter 7
Created attachment 31402 [details] chapter 8
Created attachment 31403 [details] chapter 9
Created attachment 31404 [details] chapter 10
Created attachment 31405 [details] chapter 11
Created attachment 31406 [details] chapter 12
Created attachment 31407 [details] chapter 13
Created attachment 31408 [details] chapter 14
Created attachment 31409 [details] index follows last chapter
Created attachment 31410 [details] pdl
Please be VERY careful with the individual chapters. Use only existing styles. Language of the docs is en_CA but I can fix that easily if your settings are different.
Here is a minor typo - In the OOo2.0 OpenOffice.org User Guide (user_guide2_draft.pdf) on page 71 above the list of regular expressions the sentence: There are may tutorials on their general use on the Internet. "may" should be "many". Regards, Len Fischer
Thanks for spotting the typo. It is now fixed. On-line version will be updated when the index is integrated.
Created attachment 31633 [details] single file version of guide for indexing
Ch. 2, p. 15. the graphic is misplaced/missized.
Created attachment 31827 [details] Chapter 1, copy edited (small changes)
On p. 35, I'm not clear on "The character before this symbol must appear at least once: "AX.+4" finds "AX 4", but not "AX4"" The character before the + is a period?
Created attachment 31828 [details] Chapter 2 copy edited
The graphic on p. 3 of chapter 3 overlaps the l/r margins. The text immediately preceeding the graphic does not appear to reference this graphic, nor the text following, and may be an editing artifact.
P. 5 of Chapter 3 -- arrow graphic misplaced -- points to stndrd instead of INS
P.11 chapter 3. The table duplicates itself on the next page, partially. Very weird.
For those of you that are using the chapters for proofing, please be aware that the formatting is a bit weird. i.e. things may not be where one would expect them. This is corrected when integrated in the master.
I'm probably just tired, but I cannot follow this paragraph, on p. 19 of Chapter 3: Users may apply direct formatting while typing text and later decide to reset all formatting and continue entering text using the default format. Text is entered using direct character formatting, to reset the formatting to default, press the right arrow key once which causes the prior text to revert to the default Paragraph Style. Now, continue entering text at the end of the current paragraph. Apart from the second sentence being run-on, I can't discern what is being told me.
On quickly setting a paragraph to the same style as the preceeding paragraph on p. 20 of Chapter 3, you indicate in the text "Press Enter" and in the note "Press enter twice"
Created attachment 32569 [details] Collected images for 2.0 user guide
The zipfile of images is large (~15Mb) but has all the images I used in both the 1.x.x guide and will use in the 2.0 guide. If you can help by linking the embedded images to the heirarchy in zipfile it will help get the doc out.
In the PDF file of the User Guide 0.8, the page numbers related to the subject items in the "Contents" does not show the correct page number. For example for the Item "Drag and Drop With the Data Source View" the page number shown in the "Contents" sheet is 378 while the page number that is printed on that item's information actual sheet is 407. Therefore it is impossible to find where the physical location is, by looking in the contents sheets.
To smkanen. What are you using to read the darft version of the PDF? Would be nice to know. I do see the problem but it looks okay in the sources. I will investigate.
On page 33, it is incorrectly stated that OpenOffice.org 1.1.x supports 32,768 spreadsheet rows, when in fact it only supports 32,000.
Found problem with PDF directly related to use of master document. New PDF on its way soon.
G. Roderick Singleton wrote on the dev@doc list: > I started to use a master document for the the guide starting with 0.8. > Subsequently, a user pointed out that the page numbering is messed up in > the PDF. Well, this is true and results from using the master document. > I have corrected the root cause but now the page number is all messed > up, I cat get all roman or all arabic but not the mix I could get with > the single doc. > > Any suggestions? > > ... I did have to update each of the files to > the same page template as in the master to get rid of the funny paging > and that is when the numbering became as I described. The issue is 29679 > but has the original master and chapters. So if you can work with these, > please do so. Remember the chapters do not have the correct page style. I looked at the contents of a zip file, dated in the issue on Nov 11; is that the "original master and chapters" that you were referring to? If so, here are some problems I see: 1) The master file is still .svg but all the subdoc files are .odt. It seems to work, but could cause you problems. I recommend saving the master file as .ogm if you haven't already done so. 2) The ToC and copyright info have the page style "OOoPageStyle" but should be "OOoFrontMatter". That will give you the roman numerals on those pages. 3) The word "Contents" on the Contents page should be given a different style so it doesn't show up in the ToC itself. 4) Do you want the arabic page numbering to start on the page with the section heading "Overview", or "New Features" or Chapter 1? 5) While the master document is open, you must remove the "protected" attribute on the filed containing the page where you want the page numbers to change, so you can manually edit the attributes of the first paragraph (probably the Heading 1) on that page. Note: You do NOT want to edit the paragraph style itself at this point, which is the only choice you have if the file remains protected. Right-click on the first paragraph on the page, choose "Paragraph" from the context menu, then on the Text Flow tab of the Paragraph dialog, enable breaks and set the Page Style to OOoPageStyle and the Page Number to 1. You have to do that in the master document, because the MD over-rides the settings in the chapter file itself. 6) Update the TOC to see if all is well. Jean
Uprotect the sections was the key. Thanks.
From 61039: In the User Guide for Writer (pdf file)- From the description just before fig 266, it is not clear when the edited individual entry is actually accepted: (a) when user presses OK, or (b) When the user moves on to the next entry. What if the user deleted the entry? Would it remove it from the index? This should be addressed.
*** Issue 61039 has been marked as a duplicate of this issue. ***
*** Issue 61037 has been marked as a duplicate of this issue. ***
This applies to both the User's Guide and the online help manual. Whatever is entered in a document (format, style, object, text, attribute, etc) would have to follow different phases of its lifecycle: (a) Inserting/creating/setting (b) modifying/editing/updating (c) removing/deleting/clearing/resetting Therefore, any help topic discussing the item MUST describe ALL the phases, or have a cross-reference to other topics that contain this description. In other words, regardless of WHERE the user starts reading, the help file/User guide should be able to describe the entire lifecycle seamlessly. But the OOo documentation leaves many topics incomplete in this regard. Some examples (help file): (a) the "inserting cross-references" topic page of the help file does not have a link to "deleting cross-references". (b) try searching for "removing hyperlink" Desired: Review each topic from this criteria-- "Have we addressed the three essential stages of its lifecycle?"
I had posted two issues but they were closed as duplicates of this issue. I also see that those issues are actually appended here. So am I correct in assuming that- 1. Post new issues related to pdf manuals here. 2. Post issues related to help file as separate issues (not here). Or is this list moderated by GRSingleton; and so we should continue posting new issues as usual?
Raindrops: This is the TASK issue for the 2.0 User guide rather than a mailing list. The best mailing list for documentation issues et cetera is dev@documentation.openoffic.org. Please subscribe. If you can, join the project and help us. As you can see in this issue, the chapters are attached and available for volunteers to edit and when done simply attach them with a new name to the issue for integration. As to your comments on the two issues you made, of course they are added here. The points are valid.
*** Issue 61134 has been marked as a duplicate of this issue. ***
From 61134 Referring the User Guide for Writer: In chapter-2, first introduce all sections of the 'options' dialog. this will allow the user to jump to the desired section. The table could have 3 columns: Section (e.g. "OpenOffice Options"), subsection (e.g. "user data"), what it can do (e.g. "Lets you enter your personal data"). Provide hyperlinks in this table to the relevant sections.
added raindrops to cc list
The guide does not make it clear if we have to select each field and press F9, or just one F9 updates all fields. Also, are Indexes and TOC also considered as "fields" for this purpose?
Added dependency on 61081 in case they get it done first.
Added dependency on 61081 in case they get it done first
Manual should elaborate how anchors can be used: 1. If the anchor of an object lies in the header/footer area (use the View > Text boundaries" option to see these areas), the header/footer will repeat that object on each page (that has the same style). Note that the object, itself need NOT be in the header/footer area. 2. You can't drag an image from a document into a frame. A workaround is to drag its anchor into the frame: The image will follow its anchor into the frame. ***** Operations on frames are not explained in details: 1. Select frame and press enter to edit it. 2. How to insert an image, frame, table etc inside a frame. 3. Writer does not allow you to edita frame by directly clicking inside a frame. A workaround is to click in text area outside the frame; and then click inside the frame to edit it.
User guide for Writer (pdf published on 16th Jan 2006): A typical user (who is not a trained professional writer) will not know the concept of indexes. Therefore, the guide should first explain Index and index entry before describing how the GUI works. (It does explain that, but the explanation of concept and GUI do not go well together.) So, the document should first explain what is index, how does it look (show some variants), what are its different parts called. Then it should explain its relationship with the "index entry". (Put them side by side and show how an Index Entry gets translated into a line in the Index. Show such correlation between different types of index entries (e.g. 1st key) and how they look in the Index. Only after that explain the GUI. **** The lifecycles of index entry and index are intermingled. The topic jumps abruptly to and fro. This would leave a user bewildered. Separate them as follows: 1. Cover the entire lifecycle of index entry first. 2. Then cover the entire lifecycle of the Index itself.
I am writing comments for all kinds of manuals here (hope this task is common for all pdf files; and all authors keep a watch here. If not, I'll have to raise separate issues for each type of manuals). OK here's some fmore for UG for Writer (Jan 16): 1. Most of the pages mentioned in the text are grossly wrong. Apparently these are hard-coded in the text: fields are not used! 2. Hyperlinks could have lightened the reader's work tremendously. (UG tuypically mentions Figure xx on page yy, which is not necessary unless the users are going to use a printed version. Most of the users would be reading the electronic version) 3. The UG attempts to describe screenshots with verbose passages below each figure. A simple figure with a few callouts would have given better idea. Also, encircle areas of interest and if necessary provide numbered small callouts; and then refer to the numbers in the text. This way, the correlation between text and figures is much higher (and faster). 4. In the beginning, provide a screenshot of the whole GUI, identify the major areas and provide a very brief introduction about how they work. Also provide hyperlinks to subsequqnt chapters from here, so that the reader can jump to his area of interest.
I have read your comments. However I have a request. Please provide an example of what you mean. THe source is here in the issue so you should be able to do this. Without the example of THIS manual, we, the people working on the guide, will have problems as the PDF is only the result of work on the source. You also mention other guides. Please note that this issue is for ONE guide only. Comments on other guides should be standalone issues.
Created attachment 33739 [details] New single file master with index. Chapters updated later
Created attachment 33745 [details] update to TOC and other fixes
Sure. I am clear about the purpose of this particular issue now. Thanks. BTW for clarity's sake, the title of this issue should be changed to "User guide for OOo"; as opposed to "User Guide for Writer" which is another document. I will email to you a sample with the corrections.
Raindrops, please attach the sample to the issue. The summary now says User Guide 2 task. I added task to make it clearer whereas the summary said User Guide 2 before. I do not know where you see this writer entry but it isn't here. Please give me the issue number so it can be fixed or closed.
There is an attachment labelled edition 12. Please do not use it as it is 16Mb and contains two versions. I did not realize that the size would change so dramatically. Please use edition 12a
Created attachment 33815 [details] edition12a without versions
Roderick, some minor things relative to Edition 12a: Is the Title page supposed to have Left Page style rather than First Page? Left Page style causes a blank page to be added to the front. (Because it's the backside of a sheet when printed.) On pages 59, 106, 108: the reference to 'Format > Fontwork' should be 'Format > Object > Fontwork'. Throughout the document: 'Numbering/Bullets' should be 'Bullets and Numbering'. Do you need someone to go through systematically checking menu paths against the application?
> Is the Title page supposed to have Left Page style rather than First Page? Left > Page style causes a blank page to be added to the front. (Because it's the > backside of a sheet when printed.) Yes it is deliberate. The template is for delivery to a printer. > n pages 59, 106, 108: the reference to 'Format > Fontwork' should be 'Format > > Object > Fontwork'. Thanks. Missed these. > Throughout the document: 'Numbering/Bullets' should be 'Bullets and > Numbering'. Ah, ha. You have spooted the document's roots. > Do you need someone to go through systematically checking menu paths against > the application? Help is needed. When I did the 1.1.x guide I had no gig and lots of time. Now it is the reverse so yes. If you or any other kind soul could take a chapter and do just that it will help. Another thing you or others could do is see if you can unembed the graphics. WHat has happened and will happen again is that the icon are changing and it would be nice to be able to hunt down the current ones in /opt/openoffice.org2.0/share/config/images.zip and link them in.
When I open the PDF I get an error message that some fonts can't be found and text might not be shown. I'm paraphrasign because it's a Dutch error message. I'm getting this error on a Windows XP SP2 machine with Acrobat Reade 7.0.7. With Ctrl-D you can ask which fonts are used in the PDF. It turns out there a few Type-1 fonts which are not available on my machine. They are: Times-Bold, Times-BoldItalic, Times-Italic and Times-Roman. I've googled a bit for them and I can only find out thet you have to buy those fonts. E.g. http://www.linotype.com/13450/timesroman-font.html Perhaps I'm not looking in the right place, but it seems a bit odd to use a commercial font for (parts of) this document.
Jeroene wrote: > With Ctrl-D you can ask which fonts are used in the PDF. It turns out there a > few Type-1 fonts which are not available on my machine. They are: Times-Bold, > Times-BoldItalic, Times-Italic and Times-Roman. THese should be embedded and looking at the PDF with Arobat Reader 7.0.1 for Linux, they are. > I've googled a bit for them and I can only find out thet you have to buy those > fonts. E.g. http://www.linotype.com/13450/timesroman-font.html You _CAN_ get them by simply using File > Wizard/Autopilot > Install fonts from the web ... on the second page. > Perhaps I'm not looking in the right place, but it seems a bit odd to use a > commercial font for (parts of) this document. You didn't and they are available. Fuether, I expect that you have _NOT_ set up acroead to use the embedded fonts but rather to use local fonts (defautl) hence your problem. I double-checked on my own XP box and have no problems. Please recheck your system given the above information. I would be particularly interested in why your machine is not honouring the embedded fonts.
Took me a bit but if you want the type1 fonts on your box, use ATM or use the method outlined at http://www.squirrel.nl/people/jvromans/OOo/oofonts03.html Fonts can be had at http://oooconv.free.fr/fontooo/packs/AllPostscriptFonts.zip Have fun.
Roderick, I am attaching an edited version of this guide. All edits were done in Change Record mode as I believe you use that yourself, and you can accept/reject individual changes. Main changes are menu path updates, toolbar and other reference updates. WHile there are global changes, detailed work revising procedures, examples etc. are up to start of chapter 4. I need to detour to complete some work, and can resume in a week or two to finish the remainder. This is a great way to learn OOo and the detailed work you've put into this is amazing. I've added change comments if I think the change may not be self-evident. Have not changed icon images yet, but most will need to change, as will all images showing toolbars etc. Changes have been made to some descriptive sections, mostly if program behaviour is different now or to (hopefully) reduce or expand in order to clarify, or to enhance consistency. One or two sections were removed because they duplicated sections elsewhere. Where required, the affected section refers to the remianing section for the procedure. Two or three graphics were removed as a result of this as well. The start of chapter 2 (description of the main OpenOffice.org window, toolbars etc.) still needs updating. I have replaced the first image in chapter 2 with one showing the Writer window as it appears on first run after a new installation. As a rule I think all images of application windows should show uncustomised views, unless the customisation is noted. Let me know if I'm not sticking to conventions etc. There's probably several things I've forgotten to mention here as well.
Created attachment 34326 [details] Revisions to edition 12a - see comment.
Thanks Ross. Changes are being integrated.
Integrated Ross' changes and updated grammar for consistency.
Created attachment 34356 [details] 13th edition for comment as one large file
Browsed over the 13th edition and I have noticed numerous references to "Spelling Check". Shouldn't this be "Spellcheck" as it is referred to within the software? Before I make any changes in regards to this, I wanted to confirm that this is or is not an error. I will be reviewing this throughout the next few days for updates. Thanks R-
I think you are right. I will go through the doc again and change to Spellcheck where necessary. For ease of use, why not grab a chapter? They are smaller and easier to disect. Just a thought.
grsingleton wrote: > THese should be embedded and looking at the PDF with Arobat Reader 7.0.1 for > Linux, they are. I can only say that the Windows version disagrees. > You _CAN_ get them by simply using File > Wizard/Autopilot > Install fonts > from the web ... on the second page. It took me a while to figure out that I was supposed to do this in Openoffice. That wasn't really natural because I was using Acrobat Reader to read your document. Anyway, I've tried this and it didn't help. Note that this was mentioned: "FontOOo only works at OpenOffice.org level and no font is installed at operating system level". > Fuether, I expect that you have _NOT_ set up acroead to use the embedded > fonts but rather to use local fonts (defautl) hence your problem. It is true that the local fonts setting (as per default) was on. It didn't help when I turned it off. > Took me a bit but if you want the type1 fonts on your box, use ATM or > use the method outlined at > http://www.squirrel.nl/people/jvromans/OOo/oofonts03.html > Fonts can be had at > http://oooconv.free.fr/fontooo/packs/AllPostscriptFonts.zip The first website talks about converting Type 1 fonts to Truetype format. I'm not really sure how this would help as the font which gives the error in the PDF is Type 1. Would Acrobat Reader use a Truetype font (with the same name) if it can't find the Type 1 font? Unfortunately the zipfile you linked doesn't contain files named "Times-Roman". I'm not sure if that's supposed to be the case, but the included "fontooo.lst" doesn't mention this font either. The fontforge program from the first website is not available as a Windows binary and requires yet more programs to be installed. I don't want to sound ungrateful, but it seems a bit wierd that I'm expected to jump through hoops to read a "Portable Document Format". Would it be to much to ask if you'd change the Type 1 font "Times-Roman" to the already included Truetype "TimesNewRoman"? As far as I could tell from a bit of googling around these fonts should look very similar. > Have fun. Many thanks for your effort.
> I don't want to sound ungrateful, but it seems a bit wierd that I'm expected to > jump through hoops to read a "Portable Document Format". First things first. I cannot reproduce your problem. Second, this is the first time anyone has contacted me about Times not being rendered in PDF since the first guide was published 2004-12-26 15:51:29-0800. Third, I provided what info I could to help you and, if it is insufficient, well I do not think I can add any more to this. Fourth, you could always try the template itself from http://documentation.openoffice.org/servlets/ProjectDocumentList to see how your system handles it. You will see that the template has served well for the past two years in many documents. Fruthermore, XP is supposed to have its own font handler built-in for Type1 fonts and I find that indeed Times in the PDF is handled therefore I suspect that you have a local problem that you would do well to troubleshoot because, as I said above, this is the first time anyone has reported this. Perhaps updating acroread is in order. I do not know. However, I do know that converting the PDL pages could be a problem and this section is the only one in Times that I could find. I would rather maintain status quo until there is more evidence that this is a universal problem. I would suggest that you grab the odt file and see how your system handles the raw data. This might help you troubleshoot. I will also check about changing the font for the PDL section to see if it can be changed. I also suggest that we discuss this on dev@documentation.openoffice.org where we have many more eyes to help.
I have noticed that there are no standard conventions when certain items are addressed. In the 13th edition, Page 475, I noticed that Courier New is utilized for several conventions such as Keyboard Keys, and other terminology. Can anyone advise if a convention is pending or if it needs work? Thanks R-
> I have noticed that there are no standard conventions when certain items are > addressed. In the 13th edition, Page 475, I noticed that Courier New is utilized > for several conventions such as Keyboard Keys, and other terminology. Can anyone > advise if a convention is pending or if it needs work? What are you really asking? Do you have a problem using the fonts, do not see a need to diffentiate paths, items such as keys or other miscellanea from the text or is it something else such as a challenge to those working on the document. I, for one, would like you to explain so that your contribution can be evaluated with respect to working on the manual.
New layout of document to be more book like.
Created attachment 34551 [details] 14th edition with new layout.
General: Provide hyperlinks to other parts of the manual The main purpose of the manual is to explain the current version, so the changes from the earlier versions should be pushed to the end (as a appendix/annexure). p.50-52 Details such as file types and XML file structure hamper the flow of the narrative. Push these details to the end of the manual. p.57. Provide a figure to show how a brochure looks like (as opposed to a "normal" document) p.70. Include RegEx list as appendix. p.75 In the screenshot, increase the font size of the label (labels can't be read) p. 83 The manual does not mention how the user can click on various parts of the user-defined box and apply the selected line attributes there. In fact, this requires an elaborate description. p.95: The table mentions a lot of terms, but they are not explained in the text. Provide hyperlinks to the pkace where these terms are explained the first time in the manual (but could be to the "glossary" section also, preferably with a screenshot to explain all the concepts.) p.132 The concept of index should be explained first with a screenshot. Explain all terms such as key, 1st level key, etc. Note that the manual refers to the help file for more detail, but the help file itself is not clearly worded about this topic.
The following would be a commonly needed feature: Suppose we add a new bookmark. Now we want to add hyperlinks to all locations that refer to this bookmark. For example, our document has a term in multiple places. Now we want to add a hyperlink to web (or to the glassary section of the document). Explain how this can be done. (In other words, please explain how to add the same hypertext at multiple places of a document, using a "find-and-replace" operation.)
By the way, it was me who changed "SpellCheck" to "Spelling Check" because that's what it is in the UK English interface that I use. I hadn't realised that it was different for the US and assumed that it had simply changed from an earlier OOo version. Also, what is going to be the base icon set for the document? The Default set? Is that what is used for Windows? OOo2.0.2 is changing the default icons to be WM sensitive, but I think so far this only affects Gnome users. I think the comment re the fonts for keys etc. refers to some inconsistency in the document, which I also noticed. A convention for formatting key strokes, menu paths, etc would be useful, and a section at the front to explain the document's conventions. Defined character styles would be useful here, so they can be changed easily for the whole document if necessary. Other conventions would also be useful, such as numbering and bulleting of procedures. These were (in edition 12) fairly inconsistent. Also, extracting procedure descriptions out of paragraphs into lists. Capitalisation of certain words should be checked as well. E.g. use of "Style" where "style" should be used etc.
Well, in hte update to the Overview, I state that the icon set that the doc will use is the older set because the new Crystal icons need localization and are only available for English and German. Since this is the case, using the older set allows us to keep the embedded graphics and lets translators continue without having to replace anything. So it looks like only screenshots need updating along with a lot of words. I will try breaking down the single file into chapters again for those helping bring this beast up-to-date.
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type"> </head> <body bgcolor="#ffffff" text="#000000"> G. Roderick Singleton wrote: <blockquote cite="mid1141488185.23111.53.camel@www.pathtech.org" type="cite"> <pre wrap="">On Sat, 2005-11-19 at 11:16 +0000, Stew Schneider wrote: </pre> <blockquote type="cite"> <pre wrap="">sorry I've been unavailable -- I was in an out-of-county murder trial (I'm the equivalent of Queen's Counsel, recall). I'm finished with it, and should be able to get to it sometime this weekend. </pre> </blockquote> <pre wrap=""><!----> Hi, How are things now. Xmas is over and I'll bet your schedule is still tight. </pre> </blockquote> Hehehe...it is. I'm running for re-election. Last I heard from you, you said I had done enough, and to take a break. I thought perhaps there was something in the works, and you needed me to stop pestering you for a bit.<br> <br> I'm at your disposal. Let me know what you need. BTW...your email return address bounces.<br> <br> s<br> <br> </body> </html>
Stewart, get elected first. I answered the bounce question in private email and can tell you that your message never crossed the border.
Raindrops makes some very good points. The organization of the user guide itself seems counterintuitive for anyone using OOo for the first time with version 2.0. Because the great improvements to 2.0 have really made it a viable product for an even larger audience, this is important to take into consideration. In fact, the user guide will actually be most helpful to those new to OOo rather than those migrating from version 1.1. The advantages of reorganization can actually be emphasized by the intelligent use of hyperlinks. For example, the overview refers to multiple versions of OOo. This would seem like an ideal place to include a link to an appendix entry outlining changes from the previous version. Those who are interested in that information can easily follow the link while newcomers can simply jump right in and start learning about this great productivity suite. Hyperlinks within the body of the text itself can be very helpful in many ways, especially when dealing with such a large document. In the simplest sense they provide the user with improved navigation for the document. Regarding links, I would suggest that links directed within the document (including the table of contents) should use the index link character style rather than the hyperlink character style. There doesn't seem to be any direction given in the style guide regarding this topic. However, in my opinion links to another part of the same document should be colored but not underlined. This is a very subtle visual cue that some type of hyperlink is available without giving any impression that the destination is external to the document. It also allows for all text to appear more consistent when printing since a printed document won't have the functionality of hyperlinks. Finally, please take a look at your document version table. The last line has more than one typo.
Jondoe and Raindrops, Please provide an attachment that illustrates what you want.
I don't know how to mmake attachments for what I have suggested. For ecample, I have suggested a specific part of the text to be shifted to the end of the manual, as an annexure. How do I make an attachment for that? But you can see the private file I have sent you for an example as to how to do it. It contains plenty of appendices. In general, whatever seems to be excessive detail should not be kept inside the main text, because most users would NOT stop and read that. Shift it to an appendic. If anyone is interested, he can always read the appendix. Secondly, I have suggested using hyperlinks. How do I attach anything for that point? Someone could prepare a concordance file, though. Please let me know specific point that requires example for understanding purpose, and I will certainly send an attachment. Thanks...
> I don't know how to mmake attachments for what I have suggested. I must be missing something. In all our communications, both in this issue and off-line, I have asked that you either download the single file or a chapter and edit it and then attach it to the issue when you are done. Now you say you do not know how? The link to attach is about 5 lines above this box in which you type. The dialogue is straight forward. Please take advantage of this as it makes it easier for those working on the document to work in soft copy rather that attempting to decipher page nubmers et cetera that may have changed in the interim. > For ecample, I > have suggested a specific part of the text to be shifted to the end of the > manual, as an annexure. How do I make an attachment for that? Pardon? You edit the document and attach it as described above. > But you can see the private file I have sent you for an example as to how to do > it. It contains plenty of appendices. In general, whatever seems to be excessive > detail should not be kept inside the main text, because most users would NOT > stop and read that. Shift it to an appendic. If anyone is interested, he can > always read the appendix. You message never made it which is why I keep asking you to attach your examples to this issue. There are others working on the doc who may also want to see what you are suggesting. > Secondly, I have suggested using hyperlinks. How do I attach anything for that > point? Someone could prepare a concordance file, though. Again, provide an example by editing the document. In your case I suggest the latest one from http://www.openoffice.org/nonav/issues/showattachment.cgi/34551/user_guide_master1.odt > Please let me know specific point that requires example for understanding > purpose, and I will certainly send an attachment. Everything you have suggested has required the others and myself to sort through multiple copies of the document. The hyperlinks you suggest are eye candy when the content requires updating and will be considered only later unless you can provide a solid soft copy example of what you think needs doing. This applies to all who are trying to work on the manual. Provide attachments or wait for review at sometime in the future.
Attaching Master2 set of master and chapters based upon the March 2 14th edition. For those wishing to contribute content, please use the chapters. The master is generated and the chapter files are labelled during this process so please pay attentio to the comments. Also be very careful with page formatting. Try keeping inserted pages ahead of the last page of any chapter to preserve page breaks.
Created attachment 34761 [details] Master file for edition 14. Included only for completenetss
Created attachment 34762 [details] master2 -- chapter 1 - New Features with 2.x
Created attachment 34763 [details] master2 -- chapter 2 - New Features with 2.x
Created attachment 34764 [details] master2 -- Chapter 1: Using OpenOffice.org Help
Created attachment 34765 [details] master2 -- Chapter 2: Working With OpenOffice.org
Created attachment 34766 [details] master2 -- Chapter 3: Managing Text Documents With Writer
Created attachment 34767 [details] master2 -- Chapter 4: Spreadsheets in Calc
Created attachment 34769 [details] master2 -- Chapter 5: Creating Presentations With Impress
Created attachment 34770 [details] master2 -- Chapter 6: Creating Drawings with Draw
Created attachment 34771 [details] master2 -- Chapter 7: Databases and Data Sources
Created attachment 34772 [details] master2 -- Chapter 8: Customizing OpenOffice.org
Created attachment 34773 [details] master2 -- Chapter 9: Advanced Techniques
Created attachment 34774 [details] master2 -- Chapter 10: Introducing OpenOffice.org Basic and Macros
Created attachment 34775 [details] master2 -- Chapter 11: Using OpenOffice.org Math
Created attachment 34776 [details] master2 -- Chapter 12: Building Forms with Xforms
Created attachment 34777 [details] master2 -- Chapter 13: Xml Enhancements
Created attachment 34778 [details] master2 -- Chapter 14: Troubleshooting Common Problems
Created attachment 34779 [details] master2 -- Index (included only for completeness)
Created attachment 34780 [details] master2 -- Public Documentation License, Version 1.0 (indlcued only for completeness)
Created attachment 34781 [details] master2 -- Overview
NOTE: there are two files labelled Chapter 2. One is new features and the other the real chapter two. Likewise for Chapter 1 there are two, Ignore the first one as it is really the Overview which I attached with its name after discovering this. Helpers, please download a chapter and edit it for 2.0. If you are updating the graphics, use only the default set of icons on Tools > Options > OpenOffice.org > View.
I'm going to start rewriting a few of the first sections of Chapter 7: Databases and Data Sources. Should have it up in a few days. Chris
Tahnks, Chris. You will notice that I have been adding bits and pieces as I could. They are fair game so ...
Gotcha Roderick. Hmm after reviewing the chapter in this guide and Dan Lewis's Getting Started chapter I think I'll leave this alone as his guide seems to cover what I was going to write. The rest of the chapter is out of my depth. I'll find something else I can do to help. Cheers, Chris
Understood. My problem too. I knew the old stuff from StarOffice but HSQLDB is something else. I will see if we can find someone with some chops to do it. May I suggest having a go at the Calc chapter for updating it. More rows et cetera and that there is stuff that gets added when a full install is done like the Analytical functions like BESSELI.
[OT] A request: Please do not respond to each sentence/paragraph separately. Taken independently, some sentences project a totally different meaning than the entire post's central message. That diverts the discussion unnecessarily. Thanks. Of course I know how to post responses. What I meant is, my suggestions are so simple (e.g. moving some text to the end of the document) that it does not need a sample. Anyhow, I will take up your offer and post a modified manual. But there is an immediate problem: In response to my earlier post, you gave the link http://www.openoffice.org/nonav/issues/showattachment.cgi/34551/user_guide_master1.odt but afterwards, you posted separate chapters. I can't use separate chapters (I need a full manual to demonstrate what I suggested). But if I pick the old version and modify it, it will be more work for everyone (merging etc). So is that link still valid or do you have a full manual that uses these latest chapters? Cheers.
From richlv: user guide, page 281; "Using the Navigator Move quickly from slide to slide by opening the Navigator (function key F5). All the slides of the presentation are listed here. Simply double-click the relevant slide title to jump to that slide." as of oo.org 2.0. f5 starts presentation.
OK, let me submit a few files.
Created attachment 35372 [details] Master document with different formatting
Created attachment 35373 [details] Edited overview to match edited master
Created attachment 35374 [details] Edited "what's new" for edited master
Created attachment 35375 [details] Edited "troubleshooting" for edited master
jondoe: WRT the new master you have submitted. I see that you changed Content1 style. Interesting and it looks good. Have integrated it along with hyperlinking in the real master.
Now, let me try to give a brief explanation of the files I just submitted. The master file has a few changes. First, formatting was changed to be more in line with the guidelines for documentation outlined previously. That included the formatting of the table of contents while still allowing for hyperlinks to the content. It also included the addition of headers and footers throughout. Second, the book format that you started to implement was done in a way that seemed quite cumbersome. I manipulated paragraph styles and page styles to allow for more automatic page manipulation. There is no longer any need for manual page breaks to be added at the end of a chapter to make sure that each chapter starts on the right side of a book. Third, I moved the "what's new in 2.0" and "troubleshooting" sections to the end of the document as appendices. Fourth, I felt there was justification to include a couple of intentionally blank pages after the document versioning table and the table of contents. This will ensure that the table of contents and the first chapter will always start on the right page have a blank page on the left. The other files are simply included to better illustrate the changes made. The new document overview has manual formatting to call for page numbering to be restarted at 1. Unfortunately, there is a bug with how pages are numbered with master documents (I filed a bug: 63783). So, until the page numbering is fixed, either the first chapter can't start at page one and have all other chapters continue where the previous one left off, or the page numbering will have to be restarted with each chapter. Personally, I prefer the former until the bug is fixed because it simply makes more sense when using a table of contents. The other two files are named for use as an appendix. Additionally, the Headings 7-10 were made to match the formatting of Headings 1-4 (it is generally beneficial to have appendix headings be distinct from headings in the body of the document).
jondoe: Moving the New features to an appendix is not quite what I had in mind. Could you please explain your reasoning for this?
jondoe: Thanks for the explanation. You are under a bit of a misconception though. Let me explain. I used the master to let others work on smaller bits whilst the real document is a monolith to enable the indexing effort. Our indexer requires this. Yes I noticed the toc problem but because the pdf is generated from the big file and all is okay, I have not bothered to try to fix it. Since you have provided a way, I will very likely use your submission but give me a bit to check it out and make certain everything else is okay. If it is then we are gold. Thanks. About the appendix idea. I am shelving it for the moment to reduce problems getting updated sections and will probably to this just before publication. This manual's revenue will go to OOo directly as I did with the first guide.
Please use user_guide_master2x.odm as the master. Ignore the TOC is produces other than to check page numbering. The reason I have been looking at the font to use. I have tried toga sans and like it but is a sans a good font for this purpose or should times roman be the choice (current default)?
Garry, jondoe has produced the appendix exactly as I had described. When you see the entire document after shifting the non-relevant material to the end (as appedices), the manual will look smashing! Since it only involves a few dragging-and-dropping, why not include that change in the next version? BTW I am not familiar with the concept of master documents. Although you have posted all new chapters and the master, I don't know how to create a seamless document out of these building blocks. The help file should mention this scenario: How to combine chapters and a master document to create a whole document. Thanks..
In the last post, I mentioned "the help file...". That applies to the manual also: It should include instruction about how to recreate a whole document out of master and chapters. The complete list of suggested appendices is in my post with the time stamp "Thu Mar 2 09:44:58". Thanks...
raindrops: Please consider joining us on dev@documentation.openoffice.org to discuss documentation. You did suggest appendices but you negletcted to provide examples. jondoe provided a good working master doc that corrected a number of problems so it is in play. However this appendix thing is an appearence problem that can easily be handled once the content is updated. I recall you were interested in providing content but I have yet to see any. Please attach your examples to this issue so that they can be used. Verbal descriptions are nice but do not get the job done as they depend upon intrepretation and work by someone else. I think that this is not good and thus encourage the contributors to push these descriptions and comments to later. Master doc are decsribed in the document in Chapter 3 and in Help.
Thanks for the invitation. I will join. (am I supposed to send an email there?) Indeed I AM interested in providing the direct edited document. Shall I use user_guide_master1.odt (version 14) for that? Please confirm! For small things, it would be too much uploading if I need to edit the whole document and attach. Can I just attach a small new file instead, with a note attached as to where to insert it? Thanks.
For those wanting to help with content, the easiest way to help is to take one of the chapters and edit it. When the edit is complete use the Create a new attachment link. Please enter a good description so that the new file can be used instead of the it is meant to replace. I do not recommend using the large complete file as it is only useful for our indexing effort and by using jondoe's new master layout becomes easy as does integration.
I am very pleased that the changes I made were met with such welcome. I have since looked back at the master document I created and realized that I didn't update the index after having made some changes. So, the functionality of links within the table of contents was broken. I also added a "hack" to the master document so that the overview (the first section after the table of contents) can start with page 2 or 3 depending on the number of pages comprising the table of contents. I also played with changing the font so that others can see what toga sans would look like in the toc (you might need to install toga sans on your computer to make sure that you see it as intended). So, with that in mind I am submitting a couple of new master documents for everyone's convenience. The only difference between the two is that they have different fonts in the toc. Any other changes are common to both. In my opinion, I prefer Times New Roman in the toc. It is more consistent with the document as a whole that way. One last point, when you are working with an automatically generated toc, it is still necessary to update the toc after any changes are made (this includes changes to subdocuments) in order to be sure that the toc is accurate and behaves predictably with regards to any links.
Created attachment 35396 [details] Fixed toc in master with toga sans font
Created attachment 35397 [details] Fixed toc in master with times new roman font
On p.64, there is a heading: Paragraph styles on p-65, there is another heading: Paragraph style Both are at "heading-3" level. The text needs reorganization. *** The formatting for the heading "Jumping From One Reminder to Another" (p-99) is shifted to a blank line. (the Navigator shows a blank line). *** P.139 is a blank (the navigator shows a blank entry for it.)
raindrops: Please attach the updated chapter to this issue.
updated Chapter 3 with POSTNET info.
Created attachment 35638 [details] Updated envelope handling and POSTNET barcodes
i can help to assist the project
fengchi: Most certainly. What would you like to do? Work on updating the screenshots? Take on a chapter? I suggest that you subscribe to dev@documentation.openoffice.org and ask there so we can co-ordinate with the other participants.
Hi there, I'm not sure this is the place to send my post but I am missing an instruction in your guide on "How to remove Notes in Writer". I mean the Insert->Note... notes. (this is done by placing the marker on the, usually yellow, comment box and pressing the delete button)
Adding myself as CC...
Yes this is as good as any place to leave comments. At least they don't get lost. However, would it be possible for you to download http://www.openoffice.org/nonav/issues/showattachment.cgi/35638/chapter3_master2.odt which is the Writer chapter and add some appropriate words. If you can make sure that Record Changes is enabled. This is the best way to ensure changes get in in a timely manner.
Created attachment 37230 [details] added file recovery method to chapter
The User Guide currently on the documentation page on OOo site lacks links on TOC. Can please someone provide ? I don't know if this is the right issue to comment, but surely the quickest.. CC to myself as well.
beppec56: The document in PDF format is generated by whatever PDF export filter is available in OpenOffice.org. Thus the TOC is presented as boolmarks as the result of using 2.0.2. If this bothers you, please feel free to help by generating the PDF using the latest STABLE release of OOo and if it does not do what you want to file an RFE against the code that does the export.
grsingleton: I can generate it on Win XP, 2.0.2 pristine installation. Can you point me to the right ODT, ODM and OTT documents used ? It appears the documents appended here are not updated to the User Guide I saw on OOo site.
All the necessary files are here. Please read up on master documents and then download what you need or simply wait. I really see no need to go to this trouble as the document is meant for publication and the PDF is offered as a convenience. Regenerating the PDF, as you will see, is not particularly straight forward. But go for it. You may attach your PDF here in this issue.
grsingleton: I generated a new PDF with the TOC items linked to the topics. I wasn't able to attach it because there is a 1Mbyte limit to the attachements whereas the resulting PDF is more than 6Mb. I had to edit a little the master document, since the latest changes needed to be integrated. It was a very useful execise. In my opinion the only reason the PDF on OOo site does not have the linked TOC is because the TOC in the ODM doesn't have the hyperlink enabled. Not a big problem though. IIRC older versions had the TOC linked. I suppose the next time it will need regeneration, it will be corrected. Sorry for the fuss.
Thanks. However the limit is much higher and the pdf is well under the limit. Please attach it for review.
Created attachment 37336 [details] Gary's edit of the Overview
Dded Gary Schnabl to cc. I will look at your edits.
Created attachment 37338 [details] Oveview section with GS edits
Created attachment 37341 [details] User Guide PDF'ed
I attached the PDF version, generated with 2.0.2 on Win XP. The TOC has link enabled. I updated the overwiew section with GS edits. Please be aware that the master document I used was an edited form of the last one available here (user_guide_master2x14b.odm) on this issue; so the PDF looks different than the one on OOo site (draft version number, blank pages at the end of sections, different font effects).
Beppec56: Thanks. If I remember correctly, the PDF was generated from 2.0 so it is good to know about 2.0.2 etc being better at exporting. In the meantime, I have made changes too so will re-gen with 2.0.3rc7 and we should be gold.
Created attachment 37378 [details] Master fro 17th edition
Can you put the whole odt/odm files in one zip file, please? Have you got one file odt version? Thanks, KAMI
I think there is a mistake on page 221 of the user guide 2 draft. The sentence "Thus, using the formula =CONVERT(50;"EUR";"USD"), displays the number of US dollars that is the equivalent of 50 Euro dollars." seems incorrect. Euros are not dollars so the sentence would be : "Thus, using the formula =CONVERT(50;"EUR";"USD"), displays the number of US dollars that is the equivalent of 50 Euros."
To thelau@openoffice.org: Please edit http://www.openoffice.org/nonav/issues/showattachment.cgi/34767/user_guide_master26.odt and attached the revised file to this issue. Whiel you are at it, please update the text if it is missing for 2.x or incorrect.
just proofreading at this point... let me know if there is anything else I can do!
Created attachment 37965 [details] Revised version with 'Euro' replacing 'Euro dollars'
I attached a revised version of user_guide_master26.odt. I changed 'Euro Dollars' with 'Euro'. I did not commit anything. Is it necessary ? There can be an issue with the plural of Euro as explained in the wiktionary (http://en.wiktionary.org/wiki/Euro). You can put a 's' or not at the end. It depends on what seems more natural to you.
thelau: No more is needed. Thanks. I will integrate your changes with mine and publish in a day or so. BTW, you used an _OLD_ copy of Chapter three. The most recent one is chapter3_master2.odt and even is is somewhat outdated with the changes I made this week. For others and yourself, please work from the bottom of the attachment list to get the most recent versions.
From 68666: Usage of the term "Function Bar" in user guide is confusing to the user because because it is inconsistent with the usage in OO applications and other parts of the User Guide (URL below). Specifically, at the top of page 48 (and further in text) User Guide says "... Function Bar ...", but on page 44 it says "... Standard toolbar." Also in applications this toolbar is called Standard (as in Calc\View\Toolbars\Standard). User Guide http://documentation.openoffice.org/manuals/OOo2.x/user_guide2_draft.pdf,
*** Issue 68666 has been marked as a duplicate of this issue. ***
kpalagin: At the bottom of page 36 - "... easy toattach and ...".
*** Issue 68678 has been marked as a duplicate of this issue. ***
kpalagin: "Format paintbrush" feature in not mentioned at all in user_guide2_draft.pdf.
*** Issue 68681 has been marked as a duplicate of this issue. ***
Fixed problems identified by kpaligin adn added bit about the style painter. Attached all affected chapters.
Created attachment 38567 [details] updated
Created attachment 38568 [details] user_guide_master2a.odm updated
Created attachment 38569 [details] chapter9_master2.odt updated
Created attachment 38570 [details] chapter8_master2.odt updated
Created attachment 38571 [details] chapter6_master2.odt updated
Created attachment 38572 [details] reaad chapter8_master2.odt updated (1st uploaded as a doc)
Created attachment 38573 [details] chapter5_master2.odt updated
Created attachment 38574 [details] chapter4_master2.odt updated
Created attachment 38575 [details] chapter3_master2.odt updated
Created attachment 38576 [details] chapter2_master2.odt updated
Created attachment 38577 [details] chapter10_master2.odt updated
Created attachment 38578 [details] master edition 20
* Notes should begin consistently with "Note:" (not for example "NOTE:" * Removed empty headers * Added a discription on how to insert, change and remove notes.
Created attachment 38628 [details] chapter3_master2.odt updated by ztyx
Will review and integrate the ztyx changes asap. I have the chapter in edit myself so ...
Changed title from "Inserting and Editing Notes" to "Inserting, Editing and Removing Notes". Changed - header "Calculating With Dates and Times" to a style "Heading 3" instead of "Heading 2" - header "Calculating With formulae" to a style "Heading 3" instead of "Heading 2" because I can't figure out the header hierarchy there otherwise.
Created attachment 38636 [details] chapter4_master2.odt updated by ztyx
BTW, all the paragraphs with the style "OOoNotes" in at least chapter 3 don't have the same look. There are different margin settings aswell as different font settings. Also, should everything with the style "OOoNotes" always begin with "Note: " to be consistent? I could go thrue and fix it if someone could tell what the original style should look like etc... PS. Would you rather like to have questions like this in the dev@documentation.openoffic.org? DS.
Styx: If you do not understand how styles are controlled in a master document I urge you to leave the sytles alone and concentrate on textual changes. I asked on the list that people interested in participating in developing the user guide to please announce their intentions on the list.
Help is needed with Indexing. If you have time, I need a volunteer.
Gerry, I am interested in learning more about indexing and would like to take a look at the information you mentioned that you have about how indexing is done. (before I say for sure I can help :) ) thanks - WalterAM
"Chapter 7: Databases and Data Sources" of User Guide needs to be updated for v2.0 and edited for clarity - it is unclear even where to start as neither Calc nor Base have Tools > Data Sources menu in OO2.
kpalagin: We are well aware about the shortcomings of Chapter 7. In fact it is being rewritten. Please bring any concerns you have to dev@documentation.openoffice.org so we can assign a task.
Created attachment 38955 [details] Chapter 10 Updated by WalterAM
Walteram - Thanks. The formatting worked well when integrated in the master doc.
Page 283 of User Guide talks about printing handouts from Impress, but totally fails to mention need to set checkmark "Handouts" under Options. I would also strongly suggest including screenshot of that dialog.
Regular expressions topics in both User Guide and online help would be more helpfull if they include common constructions like "begins", "does not begin", "ends", "does not end", "contains", "does not contain"
Did you find someone to help with the index? How do you work with an index as a subdocument?
Responded off issue because of problems with master doc format that require special handling.
When our document is split in master document, how to insert hyperlinks to a page in another part? Similarly, how to insert a page reference leading to a bookmark in another part? I didn't see that in the latest version. (I don't know the answer, so can't help with the drafting. Sorry!)
raindrops -> I have a question for you. Do paper books have hyperlinks in the body of the text? I think you must answer, no. Now the User Guide is being prepared for publication as a book. Therefore, the answer to your question is no. Perhaps you are thinking that because we can release preliminary draft copies in many formats, we should forgo our ultimate goal of proper publication. I would not support this at all.
I did not quite get your remark. My suggestion was not for implementing in the Ooo guide at all: I have my own 345+ pages odt file, which is causing me grief in maintenance (OOo crashes). Therefore I am thinking of chopping it into smaller chapters; so each chapter becomes manageable. So I downloaded the latest Guide and looked up the "master document" part, but didn't find what I want. That's what I have reported. IMO maintaining any document as master should not affect its features (e.g. links to other chapters). If it does, this should be specifically mentioned as cautions in the Guide; so that users will not try to convert a single document into master.
If it ever comes to mentioning Calc's autoinput feature in User Guide, I would suggest adding the following information: "Once the autoinput suggestion appears, hit F2 to accept it and switch to editing mode. Also, once the autoinput suggestion appears, you can choose a different possible completion by hitting TAB or Shift+TAB (unfortunately it's not a circular list), or you can type Ctrl+D to get a dropdown of all the previous entries for that column." by Joe Smith [jes@martnet.com] in Users mailing list.
Neither User Guide, nor Online Help says that it is possible to reposition slides in handout view by simply dragging them with mouse. Please mention this nice (and apparently unique) feature in documentation.
-> kpalagin Thanks for your note. The user guide Impress chapter is being worked on so I am certain the author will take this into consideration. However, with respect to Help, I found the following: Changing the Slide Order Do one of the following: Choose View - Slide Sorter, select one or more slides, and then drag the slides to another location. To select multiple slides, hold down shift and click on the slides. To create a copy of a selected slide, hold down Ctrl while you drag. The mouse pointer changes to a plus sign. You can also drag a copy of a slide into another open OpenOffice.org Impress document. Choose View - Outline, select a slide, and then drag the slide to another location. Choose View - Normal or Notes, select the slide preview on the Slides Pane, and then drag the slide preview to another location. To temporarily remove a slide from your presentation, go to Slide Sorter, right-click the slide, and then choose Show/Hide Slide. The name of the hidden slide becomes gray. To show the slide, right-click the slide, and then choose Show/Hide Slide. Since handouts are only another variation the way things are displayed, I think that your observation may be covered. Nonetheless, please open an issue for On-line Help with this enhancement.
Regarding the position changing of slides in Hand Out View (comment by kpalagin). Whilst it is true that it can be done (the slide miniatures are simply drawing objects on the page), I cannot for the life of me see a use for it. It does NOT change the order of the Slides in the Presentation. Can anyone give me a good use for this unique facility. I am quite happy to write about it if people believe it is useful.
-> grsingleton, andreasks this feature is not about order of slides. It is about arrangement (horizontal of vertical). See http://www.openoffice.org/issues/show_bug.cgi?id=70823 http://www.openoffice.org/servlets/ReadMsg?list=users&msgNo=132080 P.S. Is Online Help different from User Guide in that there is no single issue for it in IZ and we should file new issues?
Yes. Online Help (Application Help) is a different deliverable. If you want something changed or added there, please file an issue with online help as sub-component.
In Calc (page 237/8) there is an example for CONVERT using USD / Euros. USD / Euros is determined by market forces - it is not constant and is not calculated by Calc. =CONVERT(100;"USD";"EUR") is the example. There is an eleven step procedure to show how to enter it into a cell - so very much trying to hold the hand of the user; and at the end of it all, *it gives an error*, because CONVERT does not take "USD" as a parameter. I wonder if it would be better to use eg SQRT here - as CONVERT is of little use now the Euro is established. Hope to help
Thanks for the comment. For the record here is my response to your private mail so to keep some continuity: I am a contact. Better you had added this to the issue 29679 that is > listed on the doc/manuals webpage from where you downloaded. As to the > example, it is just that an example. So what are you suggesting: > 1. Users are not aware enough to deal with daily changes? > 2. The example is not useful and should be removed? > 3. The text is wrong? > > Looking at the help that will be part of 2.1, I see that CONVERT is > a function hat allows conversion of a European currency value into > Euros. So using USD is probably not a good idea. > > You see the idea of the section is to show users that there are built-in > functions and not to particularly detail everything to death. > > So yes this has been helpful but it will not show up until Chapters 7 > and 9 have been uploaded to the issue and integrated so we can post and > new pdf. Now to answer your question. No SQRT is not quite the same thing as CONVERT. CONVERT is one of a few built-in routines that is a bit more than a function like SQRT. It is these built-ins that this section attempts to point out to users.
Minor formatting error report: Page 10, numbered list: Numbering continues from previous list. It should start from 1.
Please add regex for inserting "paragraph end" - "\n\n" to either the list of regular expressions (Chapter 2, page 39)or to description of "Find and Replace" feature.
->kpaligan I would agree your suggestion might be useful. Please download http://www.openoffice.org/nonav/issues/showattachment.cgi/38576/chapter2_master2.odt edit it appropriately and attach the edited file to this issue for review.
@ kpaligan for inserting "paragraph end" - "\n" should be used and NOT "\n\n", otherwise 2 "end of paragrah" sings will be inserted.
Created attachment 41528 [details] chapter2 updated by Andrzej Szelachowski
-> superandrzej: Thanks. Have made changes as well so will need to integrate.
Created attachment 42128 [details] Database chapter updated for 2.x
Created attachment 43179 [details] embedded graphics as links did not work
In the Forms chapter (Xriter guide), the method to enter different items in a list box is not clear. Current page is 373. Method should be as follow : 2) In the List Entries box, enter the names of the shapes : Circle, Triangle, Square and Pentagon. Type in one shape and press Shift + Enter to add a new row ; finish the list with Enter. You should see it displayed as: “Circleâ€;â€Triangleâ€;â€Squareâ€;â€Pentagonâ€. The punctuation is added automatically; don't type it directly. To add entries to an existing list, either place your cursor at the end of the list and type Shift + Enter to add a new row or click on the arrow on the right and place your cursor at the end of the list before typing Shift + Enter.
=> Hagar Thanks I will get to it when I get a chance. However, if you think it important enough, please download the chapter from the list above and edit it appropriately. Language is en-US and the format should not be changed as it depends on the master. To save you from having to search the list, the link to the Xforms chapter is http://www.openoffice.org/nonav/issues/showattachment.cgi/34776/user_guide_master214.odt Please attach your edited copy as chapter12.odt so it can be integrated quickly.
updates to chapters 2, 5, 7 and newfeatures attached.
Created attachment 43559 [details] updated
Created attachment 43560 [details] chapter2updated
Created attachment 43561 [details] chapter7_master2a updated
Created attachment 43562 [details] new_features_master updated
Created attachment 43563 [details] user_guide_mater2a odm updated
Created attachment 43564 [details] master2a odm updated with record and show changes enabled
Chapter 2. I agree with raindrops on Thu Mar 2 17:44:58 +0000 2006. It is better in chapter 2 to move the description of the fileformat used to the the manual to the end or even remove it all together. For a developer who want wants to use the files for automated (post) processing it gives not enough information and for the everyday user this information is not usefull. A normal user only wants to save its documents and data and how it is done he doesn't care.
=> bulldozer Perhaps you are right. However, why not show me what you are trying say by editing the current chapter2 source file and attaching it to the issue for review?
change owner. This issue might be helpful for OOoManuals. If it's of no use for OOo3, close this issue.
This document has been superceded by the user guides produced by OOoAuthors and need not be updated for OOo3, especially since the version for 2.x was never finished. This issue can be closed.
Closing.