GNOME Bugzilla – Bug 415887
Content from the Window List manual should be merged into the GUG
Last modified: 2009-06-14 23:55:56 UTC
Hi :o) The Workspace Switcher applet has it's own manual, however it seems to be our policy to include such basic function documentation in the GUG. Here is a patch that merges the content of the Window List applet into the GUG. I have also brought the section up to date, but it still needs refactoring. Love, Karderio.
Created attachment 84200 [details] [review] Merge the Window List manual into the GUG. !!! We should remember to replace the Window List manual with a redirect to this section. !!!
Re :o) This bug is blocking Bug 415899. It would be great to have this committed as soon as possible. Love, Karderio.
(In reply to comment #1) > We should remember to replace the Window List manual with a redirect to this > section. I don't know how to do this bit. There's also scrollkeeper stuff to do to remove the Window List manual from help contents etc, which I'm not sure about either. You're on IRC quite a lot lately -- can you get Shaun to help us with this?
Hmm, you're adding it to the "Default Panel Objects' section, and it's not a default -- at least not in Ubuntu. It's a rubbish name for a section anyway -- I think I can up with it as a general dumping ground. The whole of the Panel section needs refreshing with a flamethrower anyway: the sections on Buttons / Launchers / Menus / Default Panel Objects need to be combined into one super section, as to the user they are all just 'doodads on the panel'.
(In reply to comment #4) > Hmm, you're adding it to the "Default Panel Objects' section, and it's not a > default -- at least not in Ubuntu. DUH. I'm thinking of the Window Selector. Why do these two applets have identical-meaning names?
Committed. Updated the DocBook ids -- 'windowlist-prefs' becomes 'panel-windowlist-prefs'. I'll leave refactoring to another bug, especially as I think a lot of this actually needs to go into "2.3. Windows". Leaving open, as someone who know how needs to decommission the Window List manual.
(In reply to comment #3) Re :o) I've attached a new patch to Bug #415899. It replaces the old help file with an error message, a redirect to the relevant section in the GUG and an invitation to the user to file a bug saying how he came across this document. (all references to sections are preserved) I think it's up to the maintainers of gnome-panel to commit this, is that correct ? Love, Karderio.
Re :o) > It's a rubbish name for a section anyway -- I think I can up with it as a > general dumping ground. > > The whole of the Panel section needs refreshing with a flamethrower anyway: the > sections on Buttons / Launchers / Menus / Default Panel Objects need to be > combined into one super section, as to the user they are all just 'doodads on > the panel'. >I'll leave refactoring to another bug, especially as I think a lot of this >actually needs to go into "2.3. Windows". Yes, it is certainly not the right place to put this, but the main thing is we get it in the GUG, so we can patch the panel app before things get frozen, then we can move it all about as we wish ^_^ Love, Karderio.
Re :o) >Updated the DocBook ids -- 'windowlist-prefs' becomes 'panel-windowlist-prefs'. Ah... Well... That stops the patches on Bug #415899 working :-/ I understand that it fits a little better with where the content is currently placed in the guide, but when we move it about this is likely to no longer be true. Thinking about it, I would actually argue against repeating super-section names in section IDs when it can be avoided - it violates DRY and makes it harder for us to move things around. Love, Karderio.
(In reply to comment #7) > I've attached a new patch to Bug #415899. It replaces the old help file with an > error message, a redirect to the relevant section in the GUG and an invitation > to the user to file a bug saying how he came across this document. (all > references to sections are preserved) Shaun has previously mentioned the possibility of Yelp doing redirects itself -- this came up when I moved the Bug-buddy stuff. Chase him up about doing this here :) > I think it's up to the maintainers of gnome-panel to commit this, is that > correct ? If it's docs, we can commit.. However, I'd rather we properly obsoleted those docs, otherwise we'll forget. Ie, remove them from the build and the repository and other dark magic I know nothing about. (In reply to comment #9) > Thinking about it, I would actually argue against repeating super-section names > in section IDs when it can be avoided - it violates DRY and makes it harder for > us to move things around. Hmm, that's a good point. My case for it has been that when I get a bug report saying "section 'doodad'" I want to get to section 'doodad' fast, and when I see a link elsewhere to section 'doodad' I want to have an idea of where it is and what it's about. Is 'window-list' sufficiently unique?
(In reply to comment #10) > Shaun has previously mentioned the possibility of Yelp doing redirects itself > -- this came up when I moved the Bug-buddy stuff. Chase him up about doing this > here :) Yelp voodoo, cool ^_^ I'll try and get hold of Shaun about this then, thanks. > > I think it's up to the maintainers of gnome-panel to commit this, is that > > correct ? > > If it's docs, we can commit.. Cool :-o > However, I'd rather we properly obsoleted those docs, otherwise we'll forget. > Ie, remove them from the build and the repository and other dark magic I know > nothing about. Sounds like the best way. Is this not easier now we have svn ? I could remove them from the build, but do we not need to coordinate this with the module maintainer ? > Is 'window-list' sufficiently unique? I think it should do. We can always call the section for these docs whatever we want, and put an anchor so that the Window List applet calls the appropriate section. Thus the Window List will always call the 'window-list' section, and we could show, say, the section 'managing-windows'. Hmm, hope that was clear :-/ Love, Karderio.
(In reply to comment #11) > > However, I'd rather we properly obsoleted those docs, otherwise we'll forget. > > Ie, remove them from the build and the repository and other dark magic I know > > nothing about. > > Sounds like the best way. Is this not easier now we have svn ? > > I could remove them from the build, but do we not need to coordinate this with > the module maintainer ? I don't know what needs to be done -- scrollkeeper dark magic amongst other things. Ask Shaun :) (Make a note on the wiki of all the required steps, so we have a record for other manuals we merge in.) > > Is 'window-list' sufficiently unique? > > I think it should do. We can always call the section for these docs whatever we > want, and put an anchor so that the Window List applet calls the appropriate > section. Thus the Window List will always call the 'window-list' section, and > we could show, say, the section 'managing-windows'. Hmm, hope that was clear > :-/ Ok, you've convinced me. I'm reverting the ids I changed.
This has been fixed as the Workspace Switcher docs were deprecated and included in the GNOME User Guide instead