Article Standards: Difference between revisions
Dgreenwood (talk | contribs) Created page with "When writing and reviewing your articles please stick to the following standards: '''General''' * Always use proper spelling and grammar '''Links''' * Always link to internal Grooper Wiki articles using the <code><nowiki>Article Name</nowiki></code> syntax. Ex: ** Tabular Layout ** *** <code><nowiki>Tabular Layout</nowiki></code> * For external links either: ** Use the full text link *** https://www.grooper.com *** <code><nowiki>https://www.grooper.com</no..." |
Dgreenwood (talk | contribs) No edit summary Tag: visualeditor-switched |
||
| Line 7: | Line 7: | ||
* Always link to internal Grooper Wiki articles using the <code><nowiki>[[Article Name]]</nowiki></code> syntax. Ex: | * Always link to internal Grooper Wiki articles using the <code><nowiki>[[Article Name]]</nowiki></code> syntax. Ex: | ||
** [[Tabular Layout]] | ** [[Tabular Layout]] | ||
** <code><nowiki>[[Tabular Layout]]</nowiki></code> | |||
* For external links either: | * For external links either: | ||
** Use the full text link | ** Use the full text link | ||
Revision as of 10:30, 5 March 2024
When writing and reviewing your articles please stick to the following standards:
General
- Always use proper spelling and grammar
Links
- Always link to internal Grooper Wiki articles using the
[[Article Name]]syntax. Ex:- Tabular Layout
[[Tabular Layout]]
- For external links either:
- Use the full text link
- https://www.grooper.com
https://www.grooper.com
- Or, use the nickname syntax Grooper
- Grooper
[https://www.grooper.com Grooper]
- NEVER use the footnote syntax
- [1]
[https://www.grooper.com]
- Use the full text link
- If a linkable topic exists multiple times in an article, link the word or phrase the first time it appears in an article's section.
- Linking to an article more than once per section crowds the topic and makes it more difficult to read.
- Visit the Article Formatting#Links page for more information.
Bolding and Italics
- Bold all Grooper objects
- What's an object? A good rule of thumb is anything you can add to the Node Tree is an object.
- Ex: Batch, Batch Folder, Batch Page, Value Reader, Content Model, Data Model, Document Type
- What's an object? A good rule of thumb is anything you can add to the Node Tree is an object.
- Bold and Italicize all Grooper properties
- What's a property? Anything in a property configuration grid.
- Ex: A Value Reader only has one configurable property, the Extractor Type property.
- Italicize all Grooper property settings in "How To" sections.
- Ex: On the Data Field, set the Display Width to 200
- When referring to a property selection that has sub-property configurations, keep that property in bold italics.
- For example, Pattern Match is an Extractor Type'.
- It is not a Grooper object. So, it should not be bolded.
- But it is more than just a simple property configuration. It is a set of properties.
- Pattern Match makes it more visually apparent that it is a set of properties.
- Pattern Match gives the impression that it is something simple like a true/false value or a simple dropdown choice that requires no further configuration.
- BE AWARE: This guidance was not always followed. You may find older examples in the wiki that do not follow this advice.'
- For example, Pattern Match is an Extractor Type'.