169306 - creation of URL (with %s) to enable custom keyword functionality not documented

Status: VERIFIED FIXED

(Documentation Graveyard :: Help Viewer, defect)

Description

[Marc Bejarano]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.2a) Gecko/20020910
Build Identifier: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.2a) Gecko/20020910

the only reference i could find to custom keywords in the helpfile was under "Changing Individual Bookmarks" in the "Bookmarks" section.  here is what it says:
===
You can rename the bookmark (the name appears in your bookmark list), add descriptive information, or set a keyword. (You can type a bookmark's keyword into the location field to go to the bookmarked site.)
===
nowhere does it tell you that if you use a special URL with %s in it where your replacement text should go, that you'll get IE QuickSearch-like behavior.  this functionality was added with Bug 29871.

Reproducible: Always

Steps to Reproduce:
1.
2.
3.

Comment 1

[rudman]

To Jatin.

Comment 2

[Daniel Wang]

*** Bug 207648 has been marked as a duplicate of this bug. ***

Comment 3

[benc]

This is covered in:
http://www.mozilla.org/docs/end-user/keywords.html

It should probably also be mentioned that custom keywords is a column that is
off by default in the bookmarks disiplay.

Comment 4

[Daniel Wang]

Attachment: patch v1

Comment 5

[Giacomo Magnini]

Attachment: This should be it

Additional cleanup provided.
1) Solves the bug
2) Removes the useless h3's for plugins
3) fixes the (c) line i forgot to edit in cs_nav_prefs_appearance

Comment 6

[Marc Bejarano]

thanks for writing this up, giacomo.  i only read the part about custom keywords
as that's all i'm interested in.  a few small nits that you fix:

1) in the sententence "Bookmarks keywords allow you to create shorthand alias
for bookmarks and Web searches", you should start out with "Bookmark keywords"
and use the plural "aliases" instead of "alias".

2) "Navigator will loads http://www.mozilla.org." should be "Navigator will load
http://www.mozilla.org."

3) "In your Bookmarks window, click a bookmark." should be "In the Bookmarks
window, click on the bookmark that you created."

4) "your favorite search engines too." should be "your favorite search engines,
too."

unfortunately, many web search engines don't encode the search arguments in the
URL but rather use the POST method.  you can often convert this to an URL format
and have it still work.  i don't know any way within mozilla to see the
variables that are posted, though.  i use proxomitron when creating my custom
keyword-based search shortcuts.

Comment 7

[Giacomo Magnini]

Marc, tnaks for checking! I've fixed all of your nits locally, awaiting for
additional comments before supplying a new patch for checkin.

Comment 8

[Stefan [:stefanh]]

--> Giacomo

+  <li><a href="#managing_different_file_types">Plug-ins and Downloads</a></li>

I think you should change the anchors/id:s as well... Not for the user but for
the  people who edits the files ;)

+  <li><a href="#improving_speed_and_efficiency">Improving Efficiency</a></li>

help-toc.rdf needs to be changed (btw, what's wrong with speed?).

Comment 9

[Giacomo Magnini]

(In reply to comment #8)
> I think you should change the anchors/id:s as well... Not for the user but for
> the  people who edits the files ;)

Modified to plugins_and_downloads: this involves many files, so I'll wait for
the patch in bug 279054 to land...

> +  <li><a href="#improving_speed_and_efficiency">Improving Efficiency</a></li>
> 
> help-toc.rdf needs to be changed (btw, what's wrong with speed?).

Reinserted "Speed and" as it was before, both in nav_help and help-toc (that
happens when you just revive old patches... ;) ).
Other suggestions?

Comment 10

[Ian Neal]

Comment on attachment 173074 [details] [diff] [review]
This should be it

As above basically ;-)

Comment 11

[Giacomo Magnini]

Attachment: Fixed nits, some tab removal, another alphabetical order shift in glossary

Time is short for 1.8b1. If this gets r+, please check it in also!
TIA, Giacomo.

Comment 12

[Ian Neal]

Comment on attachment 173599 [details] [diff] [review]
Fixed nits, some tab removal, another alphabetical order shift in glossary

>Index: en-US/cs_nav_prefs_advanced.xhtml
>===================================================================
> <p>For more information about plug-ins, see
>-  <a href="nav_help.xhtml#managing_different_file_types">Managing Different
>+  <a href="nav_help.xhtml#plugins_and_downloads">Managing Different
>   File Types</a>.</p>

This time you changed the id/anchor but not the other.

>Index: en-US/cs_nav_prefs_navigator.xhtml
>===================================================================
> <p>To learn more about how to handle different file types with
>   &brandShortName;, see
>-  <a href="nav_help.xhtml#managing_different_file_types">Managing Different
>+  <a href="nav_help.xhtml#plugins_and_downloads">Managing Different
>   File Types</a>.</p>
And again.

> <p>For more information about downloading files from web pages, see
>-  <a href= "nav_help.xhtml#managing_different_file_types">Managing Different
>+  <a href= "nav_help.xhtml#plugins_and_downloads">Managing Different
>   File Types</a>.</p>
And again.

>Index: en-US/mail_help.xhtml
>===================================================================
> &brandShortName;. For more information, see
>-<a href="nav_help.xhtml#managing_different_file_types">Managing Different File
>+<a href="nav_help.xhtml#plugins_and_downloads">Managing Different File
> Types</a>.</li>
And again.

>Index: en-US/nav_help.xhtml
>===================================================================
>   <li><a href="#using_languages_and_international_content">Using Languages and
>     International Content</a></li>
>+  <li><a href="#plugins_and_downloads">Plug-ins and Downloads</a></li>
>   <li><a href="#improving_speed_and_efficiency">Improving Speed and
>     Efficiency</a></li>
This one is correct though.

Comment 13

[Giacomo Magnini]

Attachment: Now I see, fixed (Checked in)

Comment 14

[Ian Neal]

Comment on attachment 173709 [details] [diff] [review]
Now I see, fixed (Checked in)

Checking in cs_nav_prefs_advanced.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_advanced.x
h
tml,v  <--  cs_nav_prefs_advanced.xhtml
new revision: 1.37; previous revision: 1.36
done
Checking in cs_nav_prefs_navigator.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_navigator.
x
html,v	<--  cs_nav_prefs_navigator.xhtml
new revision: 1.26; previous revision: 1.25
done
Checking in customize_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/customize_help.xhtml,v
<--  customize_help.xhtml
new revision: 1.42; previous revision: 1.41
done
Checking in glossary.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/glossary.xhtml,v  <-- 
g
lossary.xhtml
new revision: 1.39; previous revision: 1.38
done
Checking in help-toc.rdf;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/help-toc.rdf,v	<-- 
hel
p-toc.rdf
new revision: 1.72; previous revision: 1.71
done
Checking in mail_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/mail_help.xhtml,v  <--
mail_help.xhtml
new revision: 1.53; previous revision: 1.52
done
Checking in nav_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/nav_help.xhtml,v  <-- 
n
av_help.xhtml
new revision: 1.49; previous revision: 1.48
done

Comment 15

[Stefan [:stefanh]]

Just assigning... sorry for spam.

Comment 16

[Stefan [:stefanh]]

And fixed...

Comment 17

[Stefan [:stefanh]]

v

Comment 18

[Marc Bejarano]

will the changes that were made here magically propagate to the firefox
helpfile, or should another bug be filed?

Comment 19

[Giacomo Magnini]

I don't know nothing about FX help, so I think it's better to open up a new bug
referencing this one for someone to take notice.