After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 633522 - Rewrite documentation/help on Mallard Syntax
Rewrite documentation/help on Mallard Syntax
Status: RESOLVED FIXED
Product: eog
Classification: Core
Component: documentation
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: EOG Maintainers
EOG Maintainers
Depends on:
Blocks:
 
 
Reported: 2010-10-30 00:25 UTC by Sergio Infante Montero
Modified: 2011-09-04 10:14 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Sergio Infante Montero 2010-10-30 00:25:06 UTC
Rewrite eog documentation/help on topic oriented format using Mallard
Comment 1 André Klapper 2010-10-30 10:23:35 UTC
Sergio: Without a patch I'd close this as WONTFIX if I was a maintainer...
Comment 2 Felix Riemann 2010-10-31 14:57:25 UTC
Considering eog's manual also needs an update regarding its content this could possibly be done in the same run.
Comment 3 Tiffany Antopolski 2011-04-11 13:55:56 UTC
Work on this started on master:

http://git.gnome.org/browse/eog/commit/?id=9ec30ae9a87cc0b39ec42d26cc948e690e0730d8
Comment 4 Felix Riemann 2011-04-14 20:25:10 UTC
Nice. I like the outline you have plotted, Tiffany. There's even some points I didn't even think of putting them into the docs, like the commandline and the keyboard shortcuts (yay, finally a place where we can list all those secret shortcut keys). :)
Comment 5 Tiffany Antopolski 2011-04-15 07:56:56 UTC
Hi Felix :-).  Can you tell me if the 'Edit image' button is available in a all distros, or just some?
Comment 6 Felix Riemann 2011-04-15 18:12:59 UTC
(In reply to comment #5)
> Hi Felix :-).  Can you tell me if the 'Edit image' button is available in a all
> distros, or just some?

It's not available by default. The distro has to specifically enable it by settings an editor. From what I know no distro shipping 3.0 does this yet. The only distro I know that uses it at the moment is Ubuntu, but they patch a 2.32 release especially for this.

Yet all distros have the "Open With..."-list in the "Image"-menu. Just to avoid a possible misunderstanding. :)
Comment 7 Tiffany Antopolski 2011-04-28 07:01:57 UTC
Mallard pages completed.  Now just need review.  Makefile.am updated and committed
by Ryan Lortie.
Comment 8 Felix Riemann 2011-04-28 14:20:56 UTC
I had quick look over it and fixed a few typos as I spotted them, but nothing major. Also the figures where recompressed using OptiPNG and PNGOUT which made them smaller by ~10% in total.

I'll try to have a deeper look tonight. :)
Comment 9 Tiffany Antopolski 2011-04-28 19:47:28 UTC
awesome :-)
Comment 10 Felix Riemann 2011-04-30 11:05:46 UTC
Just a few things so far:

In the section about zooming it would be good if there would be a short explanation that while "Best Fit" follows the window size it will only change the zoom factor at most to 100%. It won't zoom in any further to have smaller images fill a large window. There were often some misconceptions about that behavior before.

The sections "Convert multiple images" and "Rename many images at once" could be linked, mentioning something like that the same dialog could also be used for the other function. Also when renaming it should be mentioned that one should make sure the file format box says "as is" or it won't be a simple rename anymore.

The section "Flip and rotate" reminds the user to save the changes. Should we tell him how to actually save or is it okay to assume common knowledge here?

Maybe a little sidenote to the "Printing an image" section: The position of the image on the page can also be adjusted by dragging it around in the preview.

"Keyboard Shortcuts": Ctrl+W doesn't really close eog, but just the current window. Not sure if this should be changed or if the user should believe he has multiple instances (window=instance) open although they are one process.
Also: Ctrl+Shift+= zooms in (although not sure why) but Ctrl++ should probably be listed here to stay in line with zooming out. Note that the + and - work also alone for zooming, I think the Ctrl was just used because the HIG told us so.

"The Command Line": Opening an image in slideshow mode doesn't make much sense. ;)
What happens is that all the images in the folder will be shown in the slideshow. It makes more sense to just give the folder to be shown as parameter there.

That's all I found so far. :)
Comment 11 Tiffany Antopolski 2011-05-01 01:40:11 UTC
(In reply to comment #10)
> Just a few things so far:
> 
> In the section about zooming it would be good if there would be a short
> explanation that while "Best Fit" follows the window size it will only change
> the zoom factor at most to 100%.

I agree.  done.

> The sections "Convert multiple images" and "Rename many images at once" could
> be linked, mentioning something like that the same dialog could also be used
> for the other function. Also when renaming it should be mentioned that one
> should make sure the file format box says "as is" or it won't be a simple
> rename anymore.

done. 

> The section "Flip and rotate" reminds the user to save the changes. Should we
> tell him how to actually save or is it okay to assume common knowledge here?

Some apps (namely Shotwell) do not require explicitly saving rotate changes, therefore I don't think it can be assumed to be common knowledge (since it's not always necessary).  Having said that, eog does ask if you are sure you want to close without saving the changes, reminding the user to save anyways.  So not sure.  Left it alone for now.  If you think the instruction should be removed I will do so. :-)

> Maybe a little sidenote to the "Printing an image" section: The position of the
> image on the page can also be adjusted by dragging it around in the preview.

Sidenote added.

> "Keyboard Shortcuts": Ctrl+W doesn't really close eog, but just the current
> window. Not sure if this should be changed or if the user should believe he has
> multiple instances (window=instance) open although they are one process.
> Also: Ctrl+Shift+= zooms in (although not sure why) but Ctrl++ should probably
> be listed here to stay in line with zooming out. Note that the + and - work
> also alone for zooming, I think the Ctrl was just used because the HIG told us
> so.

Done.  I didn't know it worked without the Ctrl (The Ctrl is stated in the menu).
 
> "The Command Line": Opening an image in slideshow mode doesn't make much sense.
> ;)
> What happens is that all the images in the folder will be shown in the
> slideshow. It makes more sense to just give the folder to be shown as parameter
> there.

Agree. Changed example.


Thanks for your quick feedback :-) Let me know what other changes I can make to make these docs awesome!

Cheers.
Comment 12 Tiffany Antopolski 2011-09-03 20:09:30 UTC
Just finished polishing these docs up with Shaun McCance (on Master).  Closing this bug.
Comment 13 Felix Riemann 2011-09-04 10:14:25 UTC
Thanks a lot, Tiffany ( & helpers) . :)