Style Guide
From Layton Support
(Difference between revisions)
m (New page) |
|||
| Line 1: | Line 1: | ||
| − | |||
__FORCETOC__ | __FORCETOC__ | ||
=Product Names= | =Product Names= | ||
| − | These are the agreed-upon written representations of the product names. When used in a page name, follow the name with a ™ symbol: | + | These are the agreed-upon written representations of the product names. <strike>When used in a page name, follow the name with a ™ symbol</strike> No more trademark symbols, thanks: |
| − | Layton ServiceDesk | + | *Layton ServiceDesk |
| − | AuditWizard | + | *AuditWizard |
| − | HelpBox | + | *HelpBox |
| − | DeviceShield | + | *DeviceShield |
=Page-Naming Conventions= | =Page-Naming Conventions= | ||
| − | For the user-guide pages, begin with the product name, then a hyphen, then the section name, another hyphen, then the page name. | + | <strike>For the user-guide pages, begin with the product name, then a hyphen, then the section name, another hyphen, then the page name.</strike> |
| − | + | Pages should simply be named after the configuration menu or concepts they cover. This make for more convenient and thus more likely cross-linking within articles which should occur as often as possible. | |
| − | + | =Images= | |
| − | + | ||
| − | + | Images were previously unframed as well as positioned and captioned with HTML markup. Things like positioning, framing, captioning and more should be handled by paramter as much as possible. | |
| − | < | + | |
| + | *E.g. <nowiki>[[File:Fig44.png|frame|right|link=|The default Layton ServiceDesk login page]]</Nowiki> | ||
| + | *Image Formatting Information: http://www.mediawiki.org/wiki/Help:Images | ||
| + | |||
| + | =Things That Need To Occur= | ||
| + | |||
| + | #Wiki-wide Adjust of "Layton ServiceDesk" to "Layton ServiceDesk" | ||
| + | ##Move pages to fit new page naming scheme that does not include the product name on every page. | ||
| + | ###Establish Test Wiki | ||
| + | ###Figure Out Ramifications of Page Movement If Any | ||
| + | ###MOVE THEM | ||
| + | ##Find and Replace all other instances within the text. Hopefully this can be handled via SQL Script | ||
| + | #Refactor all images as they are incurred to remove HTML markup and replace with proper wiki markup | ||
| + | #Get Rid of all of those "Back to Table of Contents" links on every page | ||
| + | ##Look into how to otherwise establish breadcrumbing | ||
| + | |||
| + | =References= | ||
| + | *http://www.mediawiki.org/wiki/Help:Contents | ||
Latest revision as of 04:58, 9 November 2012
Contents |
[edit] Product Names
These are the agreed-upon written representations of the product names. When used in a page name, follow the name with a ™ symbol No more trademark symbols, thanks:
- Layton ServiceDesk
- AuditWizard
- HelpBox
- DeviceShield
[edit] Page-Naming Conventions
For the user-guide pages, begin with the product name, then a hyphen, then the section name, another hyphen, then the page name.
Pages should simply be named after the configuration menu or concepts they cover. This make for more convenient and thus more likely cross-linking within articles which should occur as often as possible.
[edit] Images
Images were previously unframed as well as positioned and captioned with HTML markup. Things like positioning, framing, captioning and more should be handled by paramter as much as possible.
- E.g. [[File:Fig44.png|frame|right|link=|The default Layton ServiceDesk login page]]
- Image Formatting Information: http://www.mediawiki.org/wiki/Help:Images
[edit] Things That Need To Occur
- Wiki-wide Adjust of "Layton ServiceDesk" to "Layton ServiceDesk"
- Move pages to fit new page naming scheme that does not include the product name on every page.
- Establish Test Wiki
- Figure Out Ramifications of Page Movement If Any
- MOVE THEM
- Find and Replace all other instances within the text. Hopefully this can be handled via SQL Script
- Move pages to fit new page naming scheme that does not include the product name on every page.
- Refactor all images as they are incurred to remove HTML markup and replace with proper wiki markup
- Get Rid of all of those "Back to Table of Contents" links on every page
- Look into how to otherwise establish breadcrumbing
