Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[udig-devel] [jira] Created: (UDIG-422) Update/correct English help for uDig1.0 
Update/correct English help for uDig1.0
---------------------------------------

         Key: UDIG-422
         URL: http://jira.codehaus.org/browse/UDIG-422
     Project: uDIG
        Type: Task
  Components: help  
    Versions: UDIG 1.0.RC    
    Reporter: Matthias basler
 Assigned to: Jody Garnett 
    Priority: Minor
     Fix For: UDIG 1.0


Trying to translate the English "Getting started tutorial" help pages to German I find that the English version would need a reworking too before beeing finally released.

I'll put issues I found here. Please see this as constructive critisism.

- Duplicate pages (have same contents)
"Editors and views" vs. "Views and editors"
"FAQ" vs. "Question index"
Please delete the latter and check for references to the deleted one

- Some pages have nearly no contents, just one or two lines of text and maybe two or three references.
Examples:
  * "Closing an editor": One line + one image
    BTW: Do you really think uDig users are THAT stupid??? ;-)
  * "Tools": A page that just explains what I can already see from the
    table of contents is not very helpful.

PLEASE try to avoid that. It just confuses the user, and increases the number of pages to maintain. As a suggestion I would generally try to reduce the number of pages and create slightly larger pages instead. Believe me: For tutorials that is the better solution than many small pages.

- XML errors
The "tools" page is horrible! This cannot and does not work:
   <body>
				    <div class="pageheader">
					    <span class="pagetitle">
                            Tools
                                                    </h2>
The "body" is never closed, "/h2" never opened and the pageheader and pagetitle things should get deleted for consistency. Should be:
    <body>
		<h2>
                            Tools
                                                    </h2>
    ... content ...
    </body>

- Outdated content
Zoom help page is outdated (at least the version I have from last week)

- Consistency in formatting
There is a good overall consistency in formatting, but some small problems nonetheless: The "Navigating resources" pages has two "h2" titles, one above the other. The latter should be h2. And I think I've seen similar problems on other pages.

Also check the "Zoom" page. There are nested <ol><ul> environments at the end without any obvious reason. Just remove them, please. They look ugly.

- TOC and overview pages not consistent?
I had one case where the table of contents contained an item that was not on the overview list of that chapter or the other way round. Unfortunately I've already forgotten where it was and cannot find it now.

- Some obvious spelling errors...

That's it for now. Have fun.


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira

Back to the top