Issue 38279 - Update README for OpenOffice.org Beta
Summary: Update README for OpenOffice.org Beta
Status: CLOSED FIXED
Alias: None
Product: Installation
Classification: Application
Component: code (show other issues)
Version: current
Hardware: All All
: P3 Trivial (vote)
Target Milestone: OOo 2.0
Assignee: ivo.hinkelmann
QA Contact: issues@installation
URL:
Keywords:
: 31447 (view as issue list)
Depends on:
Blocks:
 
Reported: 2004-12-02 07:11 UTC by pavel
Modified: 2005-04-14 18:43 UTC (History)
4 users (show)

See Also:
Issue Type: DEFECT
Latest Confirmation in: ---
Developer Difficulty: ---


Attachments
edited readme file, first version with best guesses. (52.40 KB, text/plain)
2005-01-26 13:14 UTC, diane
no flags Details
Notes of outstanding issues still existent in the edited readme file. (673 bytes, text/plain)
2005-01-26 13:17 UTC, diane
no flags Details
Modified readme.xrm , spaces recovered and replaced 1.x -> 2.0 in German strings (52.41 KB, text/xml)
2005-01-31 16:35 UTC, ivo.hinkelmann
no flags Details
Generated German html README (8.15 KB, text/html)
2005-01-31 16:37 UTC, ivo.hinkelmann
no flags Details
Generated English html README (11.99 KB, text/html)
2005-01-31 16:37 UTC, ivo.hinkelmann
no flags Details
modified/added notes about edits needed on new readme.xrm file (3.32 KB, text/plain)
2005-01-31 20:38 UTC, diane
no flags Details
Latest and greatest readme html (12.04 KB, text/html)
2005-02-09 19:16 UTC, ivo.hinkelmann
no flags Details

Note You need to log in before you can comment on or make changes to this issue.
Description pavel 2004-12-02 07:11:49 UTC
Update README for OpenOffice.org Beta.
Comment 1 pavel 2004-12-02 07:37:30 UTC
set target
Comment 2 pavel 2004-12-20 08:01:47 UTC
Add documentation people to CC:.
Comment 3 diane 2005-01-12 20:49:21 UTC
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?
Comment 4 pavel 2005-01-13 15:53:22 UTC
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.
Comment 5 stx123 2005-01-18 14:05:58 UTC
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" :-)
Comment 6 diane 2005-01-18 15:07:24 UTC
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.
Comment 7 diane 2005-01-26 10:55:30 UTC
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. ;)
Comment 8 diane 2005-01-26 11:03:55 UTC
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?
Comment 9 diane 2005-01-26 11:08:50 UTC
			<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?
Comment 10 diane 2005-01-26 11:18:35 UTC
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?
Comment 11 diane 2005-01-26 11:29:56 UTC
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?
Comment 12 diane 2005-01-26 11:43:25 UTC
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?
Comment 13 diane 2005-01-26 11:46:52 UTC
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.
Comment 14 diane 2005-01-26 12:20:07 UTC
Is this an accurate email addr?

<Text id="f" xml:lang="en-US">Groupware: groupware@whiteboard.openoffice.org
(moderate) </Text>
Comment 15 diane 2005-01-26 12:29:30 UTC
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?
Comment 16 diane 2005-01-26 13:12:17 UTC
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.
Comment 17 diane 2005-01-26 13:14:59 UTC
Created attachment 21888 [details]
edited readme file, first version with best guesses.
Comment 18 diane 2005-01-26 13:17:02 UTC
Created attachment 21889 [details]
Notes of outstanding issues still existent in the edited readme file.
Comment 19 diane 2005-01-31 13:21:36 UTC
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.
Comment 20 Martin Hollmichel 2005-01-31 14:56:21 UTC
reassigned.
Comment 21 ivo.hinkelmann 2005-01-31 16:35:59 UTC
Created attachment 22042 [details]
Modified readme.xrm , spaces recovered and replaced 1.x -> 2.0 in German strings
Comment 22 ivo.hinkelmann 2005-01-31 16:37:01 UTC
Created attachment 22043 [details]
Generated German html README
Comment 23 ivo.hinkelmann 2005-01-31 16:37:37 UTC
Created attachment 22044 [details]
Generated English html README
Comment 24 ivo.hinkelmann 2005-01-31 16:38:28 UTC
Modified readme.xrm have been commited to cws babelfish06
Comment 25 diane 2005-01-31 18:11:38 UTC
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?
Comment 26 ivo.hinkelmann 2005-01-31 18:46:26 UTC
Those spaces needs to stay for layout purposes. I suggest to list first. And
please modify the xrm only
Comment 27 diane 2005-01-31 20:38:11 UTC
Created attachment 22051 [details]
modified/added notes about edits needed on new readme.xrm file
Comment 28 ivo.hinkelmann 2005-02-09 19:16:22 UTC
Created attachment 22392 [details]
Latest and greatest readme html
Comment 29 pavel 2005-02-09 20:09:53 UTC
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"
Comment 30 stx123 2005-02-10 15:21:56 UTC
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
Comment 31 grsingleton 2005-02-10 16:50:33 UTC
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.
Comment 32 ivo.hinkelmann 2005-02-11 12:46:44 UTC
*** Issue 31447 has been marked as a duplicate of this issue. ***
Comment 33 ivo.hinkelmann 2005-02-13 21:01:20 UTC
fixed
Comment 34 pavel 2005-02-13 21:32:32 UTC
Verified for beta.
Comment 35 ivo.hinkelmann 2005-04-14 18:43:53 UTC
seen on master -> closed