Slightly update the docs, add configuration section
ClosedPublic

Authored by yurchor on Apr 9 2018, 8:47 AM.

Details

Summary

Some minor updates, a new configuration section added.

Test Plan

checkXML5 index.docbook
meinproc5 index.docbook

Diff Detail

Repository
R260 Gwenview
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
yurchor created this revision.Apr 9 2018, 8:47 AM
Restricted Application added a subscriber: kde-doc-english. · View Herald TranscriptApr 9 2018, 8:47 AM
yurchor requested review of this revision.Apr 9 2018, 8:47 AM
rkflx requested changes to this revision.Apr 9 2018, 11:30 AM
rkflx added subscribers: ngraham, rkflx.

@yurchor Nice, you even used the new terminology which landed only today…

Also, thanks for re-adding the importer section, I've been meaning to tackle this basically since the importer was added back. Never got around to it, because ideally such a change would also need to replace the KDE4-era screenshots with something more recent…

There are a couple of changes I'd like you to make. Nothing serious, just some points to describe more accurately how Gwenview works.

@ngraham Any additional tips on the wording in the new section?

doc/index.docbook
221

Shouldn't this (and Rotate Left/Right) get the same <guiicon> treatment as the items in the lines above?

716

Either remove the first the, or add checkbox after </guilabel>.

716

images items → images

722

Use → Move the

grayscale color → color of the gray background in Browse and View mode

731

Instead of "-", would it make sense to use something more typographically correct like "—", or is there some entity for that?

Also, I'd use a capital letter at the start of the phrase.

(Applies to all places where this was added.)

737

Add any after show.

750

"Choose how the background of transparent raster or SVG images is rendered."

759

the solid color → a color

767

"Select how scrolling over an image in View mode behaves."

770

That's not what this option is about. Better:

"When zoomed in, pan the image vertically. Otherwise, nothing will happen."

773

"Switch to the next or the previous image."

781

"Allows choosing how zooming in View mode works."

787

zoom → zoom level

790

"Use individual zoom levels for each image."

793

the View mode → View mode

801

"Allows choosing how fading between images is done in View mode."

804

"Use hardware accelerated animations."

807

"Do not use hardware accelerated animations. Select this option if <guilabel>OpenGL</guilabel> does not work satisfactory, but you still want to fade between images."

810

"Do not use animations when switching between images."

824

"Show a horizontal thumbnail strip below the image."

827

"Show a vertical thumbnail strip to the right of the image."

846

this → This

(Should also be changed in the UI file, as well as improving the markup for .thumbnails…)

This revision now requires changes to proceed.Apr 9 2018, 11:30 AM
yurchor updated this revision to Diff 31738.Apr 9 2018, 1:46 PM
yurchor marked 21 inline comments as done.

Corrected according to the comments. Thanks for them.

yurchor marked an inline comment as done.Apr 9 2018, 1:47 PM

Updated screenshots:

rkflx added a comment.Apr 9 2018, 11:42 PM

Thanks for the updates! One more thing I noticed: Currently "Configuring Gwenview" is under "4. Tips" in the table of contents. Not sure whether there's any standard to follow, but perhaps this would make more sense now as a top-level section, i.e. "5. Configuring Gwenview"? (Before your patch, not having only "Advanced Configuration Options" as a top-level section was reasonable, of course…)


BTW, the screenshots don't show up as part of the patch on Phabrictor (most likely because you used the web uploader instead of Arcanist), but I assume on you local branch everything will be fine.

yurchor updated this revision to Diff 31788.Apr 10 2018, 5:52 AM

Convert configuration section into chapter

rkflx accepted this revision.Apr 10 2018, 11:52 AM

Thanks again. LGTM now, but there really is no need to rush, so perhaps wait a day or two with committing in case other people have more ideas for improvements.

This revision is now accepted and ready to land.Apr 10 2018, 11:52 AM
rkflx added a comment.Apr 14 2018, 6:20 AM

@yurchor I guess you can land this now.

This revision was automatically updated to reflect the committed changes.