Make the index a friendlier search database.

VERIFIED FIXED

Status

SeaMonkey
Help Documentation
VERIFIED FIXED
15 years ago
14 years ago

People

(Reporter: R.J. Keller, Assigned: Daniel Wang)

Tracking

Trunk
x86
Windows XP

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment, 1 obsolete attachment)

16.24 KB, patch
R.J. Keller
: review+
Details | Diff | Splinter Review
(Reporter)

Description

15 years ago
The index needs to be a little friendlier when searching through it. Currently,
the index has too many duplicate entries with the Table of Contents. This should
not be. Some entries have bad wording (such as "Preferences" for a large number
of items).
(Reporter)

Comment 1

15 years ago
Accepting bug.
Status: NEW → ASSIGNED
(Reporter)

Updated

15 years ago
Summary: Make the index and friendlier search database. → Make the index a friendlier search database.
(Reporter)

Updated

15 years ago
Depends on: 218878
(Reporter)

Comment 2

15 years ago
Fix checked in with bug 218878.
Status: ASSIGNED → RESOLVED
Last Resolved: 15 years ago
Resolution: --- → FIXED
(Assignee)

Comment 3

15 years ago
Created attachment 138544 [details] [diff] [review]
more clean up

Some Index entries have weird link, e.g. "adding" ->
mail_help.xhtml#adding_entries_to_your_address_book

Remove unneccessary entries, fix links, and change some descriptions to be more
search friendly
(Assignee)

Updated

15 years ago
Attachment #138544 - Flags: review?(rlk)
(Assignee)

Updated

15 years ago
Status: RESOLVED → REOPENED
Resolution: FIXED → ---
(Assignee)

Updated

15 years ago
Assignee: rlk → stolenclover
Status: REOPENED → NEW
QA Contact: stolenclover → rlk
(Reporter)

Comment 4

15 years ago
> -       <rdf:Description ID="adding:address_book_entries"
> -         nc:name="adding address book entries"
> -         nc:link="mail_help.xhtml#adding_entries_to_your_address_book"/>
> -     </rdf:li>

Why are we removing this? It seems appropriate for the sub-topic

> -         nc:name="email and cookies"
> +         nc:name="e-mail and cookies"

hmm. Is this the appropriate style gramatically? Not really sure on this one
myself. I'll ask around.

>         <rdf:Description ID="keyboard:preferences"
>           nc:name="keyboard preferences"
> -	 nc:link="cs_nav_prefs_advanced.html#keyboard_navigation"/>
> +	 nc:link=""/>

Why this change? These are Keyboard Preferences and should link to the
Preferences page.


> -	 nc:link="shortcuts.html#Navigator:keyboard_shortcutsIDX"/>
> +	 nc:link="chrome://help/locale/shortcuts.html#navigator"/>

I'd prefer not to use chrome URLs.


> -       <rdf:Description ID="POP:about"
> -         nc:name="about POP"
> -         nc:link="mail_help.xhtml#about_post_office_protocol"/>
> -     </rdf:li>

Why are we removing this?

> -<rdf:Description about="#software_installation">
> -   <nc:subheadings>
> -     <rdf:Seq><rdf:li>
> -       <rdf:Description ID="software_installation:preferences"
> -         nc:name="software install preferences"
> -	 nc:link="cs_nav_prefs_advanced.html#software_installation:preferencesIDX"/>
> -     </rdf:li></rdf:Seq>
> -   </nc:subheadings>
> -</rdf:Description>
> -

same here.

> -<rdf:Description about="help-indexAZ.rdf#x">
> -   <nc:subheadings>
> -     <rdf:Seq><rdf:li>
> -       <rdf:Description ID="XML"
> -         nc:name="XML"
> -	 nc:link="glossary.html#XMLIDX"/>
> -     </rdf:li>

and here.


I'm currently debating over whether removing nc:link="" will work, since that
would be cleaner. I'll try and compile a build later this weekend when I get
more time and tell you whether we whould remove those or not.
(Assignee)

Comment 5

15 years ago
Created attachment 138650 [details] [diff] [review]
patch 2nd try

>> -	   <rdf:Description ID="adding:address_book_entries"
>> -	     nc:name="adding address book entries"
>> -	     :
> Why are we removing this? It seems appropriate for the sub-topic

This is under "adding" and "adding address book", and "adding address book" is
right below "adding". I remove the one under "adding" to reduce the # of
duplicate entries.

>> -	     nc:name="email and cookies"
>> +	     nc:name="e-mail and cookies"
> 
> hmm. Is this the appropriate style gramatically? Not really sure on this one
> myself. I'll ask around.

both are grammatically correct. Which to use is really a style issue. There are
several entries with "emails", which I think are wrong since "mail" never has a
"s". I change those to "e-mail messages"

>>	     nc:name="keyboard preferences"
>> -	 nc:link="cs_nav_prefs_advanced.html#keyboard_navigation"/>
>> +	 nc:link=""/>
> 
> Why this change?

oops, fixed

>> -	 nc:link="shortcuts.html#Navigator:keyboard_shortcutsIDX"/>
>> +	 nc:link="chrome://help/locale/shortcuts.html#navigator"/>
> 
> I'd prefer not to use chrome URLs.

fixed

>> -	   <rdf:Description ID="POP:about"
>> -	     nc:name="about POP"
>> -	     nc:link="mail_help.xhtml#about_post_office_protocol"/>
>> -	 </rdf:li>
> 
> Why are we removing this?

Parent "POP" links to the same thing.
> 
>> -<rdf:Description about="#software_installation">
>> -   <nc:subheadings>
>> -	 <rdf:Seq><rdf:li>
>> -	   <rdf:Description ID="software_installation:preferences"
>> -	     nc:name="software install preferences"
>> -	
nc:link="cs_nav_prefs_advanced.html#software_installation:preferencesIDX"/>
>> -	 </rdf:li></rdf:Seq>
>> -   </nc:subheadings>
>> -</rdf:Description>
> 
> same here.

parent "software installation" links to the same thing. No need for "one" child
link.
> 
>> -<rdf:Description about="help-indexAZ.rdf#x">
>> -   <nc:subheadings>
>> -	 <rdf:Seq><rdf:li>
>> -	   <rdf:Description ID="XML"
>> -	     nc:name="XML"
>> -	 nc:link="glossary.html#XMLIDX"/>
>> -	 </rdf:li>
> 
> and here.

XML and XLST removed because they are not in glossary (and we shouldn't link to
glossary from Index anyway)
Attachment #138544 - Attachment is obsolete: true
(Assignee)

Updated

15 years ago
Attachment #138650 - Flags: review?(rlk)
(Reporter)

Comment 6

15 years ago
Comment on attachment 138650 [details] [diff] [review]
patch 2nd try

r=rlk@trfenv.com.

OK, sound good.
Attachment #138650 - Flags: review?(rlk) → review+
(Reporter)

Comment 7

15 years ago
Fix #2 checked in.
Status: NEW → RESOLVED
Last Resolved: 15 years ago15 years ago
Resolution: --- → FIXED
(Reporter)

Updated

15 years ago
Attachment #138544 - Flags: review?(rlk)
(Assignee)

Updated

15 years ago
Status: RESOLVED → VERIFIED
Product: Browser → Seamonkey
You need to log in before you can comment on or make changes to this bug.