243101 - Content about Sidebar in customize_help.xhtml needs to be updated

Status: VERIFIED FIXED

(Documentation Graveyard :: Help Viewer, defect)

Description

[Stefan [:stefanh]]

The sidebar is hidden by default (1.4 -->) and there isn't any close/open
sidebar buttons in the Toolbar. That was a Netscape-only feature. The image of
the Sidebar could also be replaced.

Comment 1

[Giacomo Magnini]

Ok, I've removed locally the references to the Sidebar open/close buttons in the
toolbar. I can make new snapshots of the sidebar if needed, but I think that the
text should be rewritten partially beacuse it's not very clear as it is (after
cutting). I've added the option of pressing F9 for making the Sidebar appear,
but the ul about the handle is not very useful/clear. Also, where are the
references to My Sidebar? They should be removed as well.

Comment 2

[Stefan [:stefanh]]

(In reply to comment #1)
> Ok, I've removed locally the references to the Sidebar open/close buttons in the
> toolbar. I can make new snapshots of the sidebar if needed, but I think that the
> text should be rewritten partially beacuse it's not very clear as it is (after
> cutting). I've added the option of pressing F9 for making the Sidebar appear,
> but the ul about the handle is not very useful/clear. Also, where are the
> references to My Sidebar? They should be removed as well.

Giacomo,

Sorry for the delay. If i manage to update the text, can you fix the
screenshots? Will hopefully be able to get to this soon. Would probably be best
if you provide a fresh png after I updated the text. Then you can change the
search terms if necessary. Not really sure if "Baby Doll" is the best search
term anymore... BTW, does F9 do the same thing as View-->Show/Hide-->Sidebar?
That is, either open the sidebar or completely hides the sidebar (even the
handle)? Just want to confirm, since this doesn't works on mac anymore (due to
Apple's mapping of F9 to Exposé in Panther).

Actually, the references to My Sidebar are now only in the image itself ;)

Comment 3

[Giacomo Magnini]

(In reply to comment #2)
> Sorry for the delay. If i manage to update the text, can you fix the
> screenshots?

Sure, will gladly do.

> Will hopefully be able to get to this soon. Would probably be best
> if you provide a fresh png after I updated the text. Then you can change the
> search terms if necessary. Not really sure if "Baby Doll" is the best search
> term anymore...

Pick up another search term, and I'll update the screenshot accordingly.

> BTW, does F9 do the same thing as View-->Show/Hide-->Sidebar?

Yes.

> That is, either open the sidebar or completely hides the sidebar (even the
> handle)?

Yes.

Comment 4

[Stefan [:stefanh]]

Attachment: updated content for sidebar

OK, this will update the sidebar stuff in help. Giacomo, since the search term
"baby doll" also appears in the Location Bar in nav_help I haven't changed the
search term. But I would really like to change it. Suggestions are welcome...,
what about "hostels rome"? ;)

Ian: this might need some more changes, I'm wondering if we can remove
"Opening, closing and..." and rename it to "Using Sidebar" (current "Using
Sidebar" stuff will be included).

Also, several features seem to be broken, especially the Advanced search
features described in nav_help. And I don't seem to be able to customize any
tab...

Comment 5

[Ian Neal]

Comment on attachment 169731 [details] [diff] [review]
updated content for sidebar

I think it is better to keep Opening, Closing and Resizing separate to Using -
Makes it more obvious for someone searching. With that in mind are you going to
have different images for the three sections or use the same one for all three?
Before I r= I'd like to see the new images.

Comment 6

[Stefan [:stefanh]]

(In reply to comment #5)
> (From update of attachment 169731 [details] [diff] [review] [edit])
> I think it is better to keep Opening, Closing and Resizing separate to Using -
> Makes it more obvious for someone searching.

I have a suggestion: since nearly all the headings except "What is Sidebar"
could fit under "Using Sidebar" and we're already on the <h3>-level, how about
removing the "Using Sidebar" section and just have it like this:

Sidebar
  What is Sidebar?
  Opening, Closing and Resizing Sidebar
  Viewing Sidebar Tabs (used to be "Using Sidebar")
  Adding Sidebar Tabs
  Customizing Individual Sidebar Tabs
  Reorganizing Sidebar Tabs
  Removing Sidebar Tabs


With that in mind are you going to
> have different images for the three sections or use the same one for all three?

I think we need just one image of the sidebar in customize_help. The same image
could be used in the "Using Sidebar" section in nav_help. We also need a new
image for the "Advanced Search Mode" section in nav_help.

Comment 7

[Stefan [:stefanh]]

Attachment: Sidebar content update

OK, here's a new version. Giacomo, can you fix the two images? I have changed
the filenames to better correspond to the images:

1) sidebarclosed_small.png --> sidebar.png: The search terms could be "open
source" or "hotels rome", (Ian suggested "open source")... as long as you'll
get good results it's fine with me ;)

2)searchmusic.png --> sidebar-advanced.png

Comment 8

[Stefan [:stefanh]]

Attachment: Correct version

Sigh, this should be the one...

Comment 9

[Giacomo Magnini]

(In reply to comment #7)
> OK, here's a new version. Giacomo, can you fix the two images?

Sorry for being so late, but I was away. Will take me one or two days to get
back to this: will do my best to get the smallest possibile file sizes, without
hurting image quality too much. Will use "open source" if it gets sane results.

Comment 10

[Giacomo Magnini]

Attachment: sidebar.png

Comment 11

[Giacomo Magnini]

Attachment: sidebar-advanced.png

Now that I think of it... The file name (and the references) should be changed
to sidebar_advanced.png to comply with filename rules...

Comment 12

[Giacomo Magnini]

Attachment: Correct handle and ellipse

Comment 13

[Giacomo Magnini]

Attachment: Correct pointer and correct filename

Comment 14

[Stefan [:stefanh]]

Attachment: New patch with changes in jar.mn as well

Comment 15

[Stefan [:stefanh]]

I'll keep the filename sidebar-advanced.png. So, attachment #170224 [details] should have
the filename "sidebar-advanced.png". Ian, tell me if you need a new version with
a new filename.

Comment 16

[Ian Neal]

Comment on attachment 170270 [details] [diff] [review]
New patch with changes in jar.mn as well

Yes you need to update the references to sidebar_advanced.png
Opening, closing and resizing Sidebar does not appear in the search if you
enter search.
searching from Sidebar probably needs some work - e.g. reference/link to
sections with more information about the steps.
Advanced Search Mode perhaps needs to have Sidebar in its heading as this what
it is about.
Clicking Advanced Search mode (rather than Mode) within Help Search seems to go
to Browsing the Web

Comment 17

[Stefan [:stefanh]]

(In reply to comment #16)
> (From update of attachment 170270 [details] [diff] [review] [edit])
> Yes you need to update the references to sidebar_advanced.png

I want the image to be named "sidebar-advanced.png" and not
"sidebar_advanced.png". We shouldn't be using underscores in filenames. I know
that there are a lot of images in Help with underscores in their names, but
hopefully we can get rid of all the images except the sidebar ones when we're
done with the xul stuff.

> searching from Sidebar probably needs some work - e.g. reference/link to
> sections with more information about the steps.

OK, I add a link to the main "Sidebar" section in customize_help and a link to
the Advanced search mode further down.

> Advanced Search Mode perhaps needs to have Sidebar in its heading as this what
> it is about.

Hmm, I guess "Sidebar Search - Advanced Mode" could work.

Comment 18

[Stefan [:stefanh]]

Attachment: New version

OK, I think this is the one. "Sidebar Advanced Search Mode" is the new heading
title, as suggested by Ian.

Comment 19

[Stefan [:stefanh]]

(In reply to comment #18)
> Created an attachment (id=171268) [edit]
> New version
> 
> OK, I think this is the one. "Sidebar Advanced Search Mode" is the new heading
> title, as suggested by Ian. 

Aagh, forgot to change some lines in jar.mn :(. Gimme a few minutes...

Comment 20

[Stefan [:stefanh]]

Attachment: Correct version (checked in)

Here's the correct patch. Sorry!

Comment 21

[Ian Neal]

Comment on attachment 171269 [details] [diff] [review]
Correct version (checked in)

Looks good to me

Comment 22

[Ian Neal]

Comment on attachment 171269 [details] [diff] [review]
Correct version (checked in)

Checked in and images add/removed as appropiate

Comment 23

[Stefan [:stefanh]]

--> Fixed

Comment 24

[Giacomo Magnini]

Attachment: Fix for the wrong entry in help-toc.rdf

Comment 25

[Ian Neal]

Comment on attachment 172156 [details] [diff] [review]
Fix for the wrong entry in help-toc.rdf

Advanced Sidebar Search Mode should also be changed to Sidebar Advanced Search
Mode to match the heading title.

Comment 26

[Stefan [:stefanh]]

Attachment: fix for the entry (checked in)

Sorry about this.

Comment 27

[Ian Neal]

Comment on attachment 172161 [details] [diff] [review]
fix for the entry (checked in)

That's better

Comment 28

[Stefan [:stefanh]]

v