[Bug 7920] New: Establish style guide for Koha help pages
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=7920 Priority: P5 - low Change sponsored?: --- Bug ID: 7920 Assignee: nengard@gmail.com Summary: Establish style guide for Koha help pages QA Contact: koha.sekjal@gmail.com Severity: normal Classification: Unclassified OS: All Reporter: oleonard@myacpl.org Hardware: All Status: NEW Version: master Component: Documentation Product: Koha 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? -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=7920 Nicole C. Engard <nengard@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|normal |enhancement --- Comment #1 from Nicole C. Engard <nengard@gmail.com> --- 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. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org