GH Wiki Standards Guide
Displaying SQL Code
All SQL codes snippets should be enclosed within <pre> and </pre> tags to avoid Wiki attempting to format the text.
Example:
SELECT * FROM ARTPROD WHERE ...
Indicating User Input
Any text that must be typed by the user should be enclosed within <tt> and </tt> tags to give it a different appearance from the rest of the instructions. Please preview this text before saving it, as Wiki may attempt to parse parts of the line that may include apostrophes, equal-signs, etc.
Sections
All ages should be broken down into logical sections and subsections wherever possible.
Links
When writing text, any reference to a menu option should spelled verbatim and entered with '''[[ and ]]''' link holders so additional information can be added later.
Be sure to include the three apostrophes before the brackets to display the option in boldface.
For example: "After you run '''[[Prepare Payroll]]'''..."
Categories
The table below shows the standard categories used within GH Wiki. All pages should have at least one CATEGORY entry and it is likely that many pages will have two or more. Please use ALL categories that are appropriate. They should appear as the first entry in the page.
For example, a page on PRODUCT FILE MAINTENANCE has many uses and would belong in the BATCH GH, DISPATCH, INVENTORY, MAINTENANCE, RECEIVEABLES, TICKETING and TICKET IMPORT categories.
| Balancing | Balancing Techniques within Keystone |
|---|---|
| Batch GH | GivenHansco Batch Information |
| Cash Management | Keystone Cash Management Information |
| Datascope | Keystone Datascope Scripts & Information |
| Dispatch | Keystone Dispatch Information |
| General Ledger | Keystone General Ledger Information |
| Inventory | Keystone Inventory Information |
| Maintenance | File and System Maintenance |
| Payables | Keystone Accounts Payable Information |
| Payroll | Keystone Payroll Information |
| Processing | Daily processing |
| Public | Information which can appear on the public Wiki if/when developed. |
| Receiveables | Keystone Accounts Receivable Information |
| Reporting | Reporting Functions |
| Setup | System Setup and Installation |
| SQL | SQL Scripts |
| Ticketing | Keystone Ticket Printing Information |
| Ticket Import | Keystone Billing Ticket Importing |
| Wiki | Information on GH-Wiki |
Images
| AP | Accounts Payable |
|---|---|
| AR | Accounts Receiveable |
| BA | Batching System |
| CM | Cash Management |
| DA | Datascope |
| DI | Dispatch |
| GL | General Ledger |
| IN | Inventory |
| PR | Payroll |
| TI | Ticketing |
| ZZ | Other |
Images should be uploaded in their full size. When coding the Wiki page, images should appear on the right, and thumbnails used to provide the maximum amount of space for the user to view the page. The default size for display should be 200 pixels. The IMAGE tag should be used prior to the text it complements.
Accordingly, the most common use of the tag will be:
- [[image:filespec|right|thumb|200px|caption]]
Images should be named carefully to allow easier organization and maintenance of the Wiki database and prevent potential overwrites according to the following standard:
- The first two characters should represent the subsystem according to the table to the right
- The third character should be an underscore character.
- Menu Option screenshots should be have the menu option name included in the file name.
- If multiple screenshots are required:
- Each must receive a number suffix.
- An underscore should separate the number from the rest of the filename.
- The main screen shot numbered as 0.
- Subequent pop-up/tab shots should be numbered sequentially thereafter.
For example: AR_Print_Invoices_0 would be the screen as it appeared when the program is first opened.