Apache OpenOffice (AOO) Bugzilla – Issue 38279
Update README for OpenOffice.org Beta
Last modified: 2005-04-14 18:43:53 UTC
Update README for OpenOffice.org Beta.
set target
Add documentation people to CC:.
http://www.openoffice.org/welcome/readme.html has a later time stamp on it than the file in 1.9m65. Is the html the master?
mackmoon: no. The master is in the source code - it is named readme.xrm. See http://installation.openoffice.org/nonav/source/browse/*checkout*/installation/readlicense/docs/readme/readme.xrm?rev=HEAD&only_with_tag=HEAD&content-type=text/plain for the latest version.
I would be glad to copy the beta readme to the website as soon as we have one finalized for 2.0 Beta / 2.0. But it seems readme.xrm doesn't make it as readme.html in the installation directory. At least I can't find the section about the Error Reporting Tool in the readme.html/readme.txt. I think we should at least update the section "Last updated 2003 October 13" :-)
I was confused about the rev dates too. I compared the readme linked herein to the OOo1.1.4 README and the OOo1.9m69 README and the html file on the website, and they all look a little different, iirc, but they carry the same rev date.
It is unclear to me if you are looking for takers on this task, or if it is assigned to and/or checked out already. Could you please clarify? I see in the link below, the *checkout* directory. Does this mean the filet is checked out, therefore already under someone's care? What is the nonav directory? Sorry for the dumb/newbie questions, but that is what you get for adding me to the cc. ;)
In a sentence such as this: <Text id="c" xml:lang="en-US">Also read the sections below about getting involved the OpenOffice.org project. </Text> Can that last space before the closing </Text> tag be removed safely? Will there be adequate spacing outside of the text tags, so that what seem to be extra spaces inside tags like that can be removed?
<Text id="sdf3sd24" xml:lang="en-US">You need Microsoft Outlook Express or Microsoft Outlook installed and configured as your default (MAPI) e-mail client to send these error messages. Mozilla 1.0, 1.2, 1.3 and Netscape 6.x do not send the created error message correctly and will not display any error message.</Text> Is this true?
Note: under Solaris patches, the second patch listed is different for the German translation than what is shown in the English section. Is this ok?
In the section about Hebrew and Arabic Version, (JRE 1.4.1) is referred to as the latest Java Runtime Environment. Is there a later version that should be noted here?
In the section, "Changing the User Interface Font", Andale Sans UI is referred to as the default font. Is this still true? On my system it seems like Bitstream Vera fonts are the defaults, Sans for Calc, and Serif for Writer.... Does this section need an update?
In this sentence: <Text id="sdf3" xml:lang="en-US">File System ReiserFS: OpenOffice.org Will Not Start for User IDs Larger Than 65535</Text> It seems like units of some sort should be shown to better define the 65535.
Is this an accurate email addr? <Text id="f" xml:lang="en-US">Groupware: groupware@whiteboard.openoffice.org (moderate) </Text>
In this sentence <Text id="a" xml:lang="en-US" url="ahead">For help with the OpenOffice.org 2.0 office suite, take a look at the archives to questions already answered on the 'users@openoffice.org' mailing list at </Text> Should the punctuation around 'users@openoffice.org' be written in code?
I have modified a copy of the master file that Pavel linked below via a text editor. I have also created a text file that lists the notes that remain unaddressed, because I do not know the answers. I will attach both files momentarily. Please forgive me if I have treaded where I should not have. This issue was not greatly clear to me, so I made a best guess, assuming that my involvement was wanted and that is why I was cc'd. I only went through the file Pavel linked below and made edits. I have not yet looked at the other versions of the readme file to try to incorporate notes from them to this file. I do wonder if that should be done too.
Created attachment 21888 [details] edited readme file, first version with best guesses.
Created attachment 21889 [details] Notes of outstanding issues still existent in the edited readme file.
I see the readme.xrm cannot be checked out, because it is viewed as a module. Because I do not understand the file type, I cannot go further in that regard on my own. I thought I would try to compare what is there with the file that pjanik provided as the master. What an ironic situation this is. I've checked out the html page and will attempt to mesh it with the edited text file is attached, as the html file has been edited too, and in some cases is more well written. I will attach the result. I may try to find more answers to some of the unaddressed questions too, if I can. I will give it a try.
reassigned.
Created attachment 22042 [details] Modified readme.xrm , spaces recovered and replaced 1.x -> 2.0 in German strings
Created attachment 22043 [details] Generated German html README
Created attachment 22044 [details] Generated English html README
Modified readme.xrm have been commited to cws babelfish06
There are spacing issues in the HTML file, and the last revised date should be year 2005, not year 2004. (This date issue is my error. Perhaps the spacing issues are too...) What is the best way to show the errors? List them? Modify the HTML file and attach it?
Those spaces needs to stay for layout purposes. I suggest to list first. And please modify the xrm only
Created attachment 22051 [details] modified/added notes about edits needed on new readme.xrm file
Created attachment 22392 [details] Latest and greatest readme html
My notes: 1. we should unify URL syntax - all URLs should begin with http:// 2. The URL to readme.html should be differentiated between versions (imagine user of version 1.1.4 reading README for 2.0). This is probably task for st. 3. "involved the" -> "involved in the " 4. I'd remove or at least update system requirements. This is also issue for new ports - see #i22121#. It is assigned to svesik for a looong time. 5. technical issues that have to be cleared include: - pasting between two instances of OOo 2.0? - Gnome startup issues still valid? - is file locking still an issue? 6. Remove Thai input method section 7. Remove accesibility notice and things about "early access version" 8. Remove old reiserfs notice. 9. Info-ZIP section: no longer zipped installation sets, the file format is named OpenDocument. 10. move Used/Modified... section to THIRDPARTY*html? 11. "Issue Tracker" -> "IssueZilla"
re 2) We don't have to use a new URL for the on-site readme.html with every release. I would be glad to link to older readmes from welcome/readme.html re 9) and 10) Yes, those items are either obsolete or have been moved. Let's delete them. 11) I would replace the explicit date with a CVS placeholder like "$Date: $". 12) In the "Way to Start" section the link to the todo list should be changed to http://development.openoffice.org/todo.html 13) Occurrences of 1.x should be replaced with 2.x
I have a recommendation, please fix the system requirements to include all or be more general. As it currently sits, these are specific more or less to windows and to a lesser extent linux. However, we have Solaris ports on various architectures as well as linux and BSD ports and Mac ports that use other hardware than Intel.
*** Issue 31447 has been marked as a duplicate of this issue. ***
fixed
Verified for beta.
seen on master -> closed