Bug 7920 - Establish style guide for Koha help pages
Summary: Establish style guide for Koha help pages
Status: CLOSED INVALID
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: master
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Chris Cormack
QA Contact:
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-04-06 14:33 UTC by Owen Leonard
Modified: 2020-01-06 20:15 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Text to go in the release notes:
Version(s) released in:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Owen Leonard 2012-04-06 14:33:12 UTC
In my work on Bug 2780 I'm finding some inconsistency in the way the help pages are styled and punctuated. I think it would be a good idea to establish some rules about how we express some things:

- How should system preference names be quoted and/or styled?
- How should Koha modules be quoted and/or styled?
- How should we style common elements like 'hints' and 'Important:' blocks?

Also:

- Should we link system preference mentions to the corresponding help page?
Comment 1 Nicole C. Engard 2013-05-21 13:35:23 UTC
The problem here is that it's all copied from the manual and as I'm the only one writing the manual I often just write as quickly as I can to get the content in there.  Any style changes to the help files should be made in the manual as well since it's just a copy/paste effort.

As for linking prefs - I'm A-OK with that. I do that in the manual, but was removing those links from the help files because I figured that we didn't want to link out.
Comment 2 Katrin Fischer 2019-03-14 07:33:09 UTC
We have removed the help pages in favor of links to the manual since, making this bug obsolete: bug 19817