Mention the share menu in the documentation

Authored by ervin on Oct 12 2017, 11:52 AM.

Diff Detail

R223 Okular
Automatic diff as part of commit; lint not applicable.
Automatic diff as part of commit; unit tests not applicable.
ervin created this revision.Oct 12 2017, 11:52 AM
Restricted Application added a project: Okular. · View Herald TranscriptOct 12 2017, 11:52 AM
Restricted Application added a subscriber: Okular. · View Herald Transcript

Adding the docs mailing list in case they have any suggestion. The definition is a bit weird but agreed it's a bit hard to define something that you don't really know what would be there since it's dynamic.

yurchor accepted this revision.Oct 13 2017, 10:54 AM
This revision is now accepted and ready to land.Oct 13 2017, 10:54 AM

I don't see this entry at all in my version of Okular 1.2.2 (17.08.2). Is it new, or does it's presence depend on whether there would be any entries?

Also, do the entries depend on the system settings (as in what can be set with the app of that name) or do they depend on which applications supporting such services are installed? If the latter, it should be more explicit that the item might not show up at all.

ervin added a comment.Oct 14 2017, 8:41 AM

This is introduced by another patch which is through review as well.
The "Share" menu will show up and will always contain at least a couple of actions, but the exact list of actions is unknown, it depends on which plugins for KPurpose are available in the system and the settings the admins might have put in place.

Hope that helps clarify a bit.

ervin: Thanks. Would it then be worth mentioning KPurpose plugins instead of just "system settings?" I understand that text should stay concise, but if a user is trying to find out what that menu item does, the description should point to where it can be controlled. For me, "system settings" is too nebulous. Even if it means the "System Settings" app, it would help to say which section within it is relevant.

ervin added a comment.Oct 16 2017, 8:59 AM

Wasn't sure mentioning a technology like KPurpose directly wouldn't be considered like jargon... I can change it indeed.

ervin updated this revision to Diff 20848.Oct 16 2017, 9:09 AM

Trying to address Jack Ostroff's comment.

Thanks again. I understand the danger of using jargon, but there are lots of descriptions of programs and menu items out there which are correct, but completely useless to the user who doesn't already know. Hopefully, by the time this actually hits distros, a user would be able to search and find info on KPurpose, or perhaps this could even (eventually, not necessary now) be turned into an appropriate link.

This revision was automatically updated to reflect the committed changes.