'Visual Effects' keyboard shortcuts not documented in help

Setting ubuntu-docs as affected.

Thanks for your bug report.

I think that this would be a sensible inclusion for Hardy, given that there are no locally-installed Compiz docs. The section should only cover the keyboard shortcuts for the default plugins, however.

Is compizconfig installed by default? If so then ubuntu-docs could point to that where the information is, however this should only be a temporary solution as the settings are not easily found in there.

It's not installed by default; it's in Universe.

As far as I know, Desktop effects has been renamed to Visual Effects. That's what it says in the dialog.

So, the summary should probably be renamed accordingly.

That is covered by bug #150641.

I will take this bug.

Here is the patch for this.

Hi Michael,

Thanks for the extensive patch, it looks really good. I found a few reasonably minor issues which need to be addressed:

 * "cursor, use the Super+1" => "cursor, use Super+1"
 * For keycombos, use the <keycombo> and <keycap> tags rather "+", i.e. "Ctrl+Shift+Alt" => "<keycombo><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Alt</keycap></keycombo>"
 * "It is used to change viewports" - as far as I can see, "workspace" should be used instead of "viewport". It might also be beneficial to create a link to the GNOME documentation which explains what a workspace is.
 * "By default there are, besides the core, the main plugins of Compiz as well as the main and extra plugins of Compiz Fusion installed" - the wording here seems a bit confusing.
 * The sect2 sections you've used should all have an id.
 * The note about the Super key is important enough to be a separate <note>, or at least its own paragraph.
 * "Default: Initiate cube free rotation" - this seems confusing, I'm not sure what is meant
 * Perhaps change the title from "Commands for default plugins" to "Keyboard shortcuts for the default visual effects"

Was the patch applied or included already?

No - the outstanding issues in the comment above are still to be addressed as far as I know.

I have been busy but I plan on finishing it either today or tomorrow and resubmiiting the patch with the changes.

Here is the new patch with the changes you recommended.

Hi Michael,

Couple more things:

* There are mentions of 'viewports' in other sections of the patch - like "desktop wall" - should these be changed to 'workspaces' too?
* You can link to the gnome workspace documentation in yelp by making a link to "ghelp:user-guide#workspaces" (may need to test that - there's other examples in the documentation)

Thanks for your work,

Dean

Here is the new patch with the changes Dean recommended.

Michael - has this patch been committed to our intrepid branch?

I just checked to see and its not I also don't have commit rights so somebody else is going to have to add it.

Ping on commit to the Upstream..

I've committed seisen1's patch to the repository with a few changes. I think ideally it would be included in a section with other keyboard shortcuts rather than the visual effects document, but I figured it was better included somewhere than not at all...

This bug was fixed in the package ubuntu-docs - 9.04.4

---------------
ubuntu-docs (9.04.4) jaunty; urgency=low

  * [Matthew East]
    - Rewrite of internet/connecting/mobile-broadband
    - Review of internet/connecting/wireless
    - fix typo - LP: #339227
    - Update guilabel for disabling visual effects (LP: #339103)
    - Correction to 'Hardware Drivers' entity
    - Add documentation for visual effects keyboard shortcuts (LP: #147294) - patch from seisen1
    - Refresh pot files
    - programming.xml - package name should be in small case (LP: #336629)
    - Switching from Windows - typo fix and update to firefox bookmark export (LP: #330912, LP: #330908)

  * [Dougie Richardson]
    - Document MTP player support for rhythmbox (LP: #338437)
    - Use xref links rather than ulink in musicvideophotos (LP: #222990)

  * [Adam Sommer]
    - Improvements to OpenLDAP credentials section (LP: #333733, LP: #333437)
    - Fix to Samba security instructions (LP: #332478)
    - Fix to Subversion authentication details (LP: #337215)
    - Add -c flag to vert-viewer command example (LP: #335541)
    - Update link to MoinMoin website (LP: #334652)
    - Updated Postfix section with instructions for new dovecot-postfix package
    - Bind configuration improvements (LP: #339910)

 -- Matthew East <email address hidden> Sun, 08 Mar 2009 13:54:15 +0000