Article Standards

From Grooper Wiki

When writing and reviewing your articles please stick to the following standards:

General

Always use proper spelling and grammar.


Always ensure the accuracy of your statements. Verify your statements are accurate in Grooper before cementing them in an article. If you are having trouble, there are a number of resources in the company to help you.

  • Get help from your documentation and training peers.
  • Ask the Client Fulfillment team for help.
    • Help Desk sees problems from clients every day ranging from mundane, to bugs, to outright bizarre.
    • Professional Services members build solutions for clients and likely have some experience with what you're unfamiliar with.
    • Email: fulfillmenttech@bisok.com
  • QA can help determine if something is a bug.
    • Email: qateam@bisok.com
  • If all else fails, ask a dev. They are next door.


Double spacing after periods at the end of sentences is a digital to print standard. For content that lives purely in a digital environment, like Wiki articles, single spaces after periods is the accepted standard.

Links

Always link to internal Grooper Wiki articles using the [[Article Name]] syntax. Ex:


For external links either:

  • Use the full text link
  • Or, use the nickname syntax Grooper
    • Grooper
    • [https://www.grooper.com Grooper]
  • NEVER use the footnote syntax
    • [1]
    • [https://www.grooper.com]


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


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.
  • Other examples include: Labeling Behavior, Ordered Array, Tabular Layout


BE AWARE: This guidance has not always been followed in the past. You may find older examples in the wiki that do not follow this advice. Any author may correct an articles bolding and italic convention at any time.

Grooper ZIPs

Include links to download Grooper content the reader can import into their own Grooper environments.

  • Use the following information box format:
{|class="download-box"
|
[[File:Asset 22@4x.png]]
|
You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). The first contains a '''Project''' with resources used in examples throughout this article. The second contains one or more '''Batches''' of sample documents.
* [[Media:2023_Wiki_Article-Name_Batches.zip]]
* [[Media:2023_Wiki_Article-Name_Projects.zip]]
|}

You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). The first contains a Project with resources used in examples throughout this article. The second contains one or more Batches of sample documents.

Where does this box go?

  • This should be the first thing the reader sees before the first level 2 heading (usually the "About" section).


Should this be configured or unconfigured content?

  • This content should be configured content.
  • The only exception is for resources such as CMIS Connections that contain sensitive connection info to external systems. Either do not include this content in the ZIP or leave it unconfigured.


How many Grooper ZIPs should I include?

  • Most typically you will link to a maximum of two (2) files:
  • One Grooper ZIP for Batches containing any documents shown in the article. Use the following naming format:
    • VersionNumber_Wiki_Article-Name_Batches.zip
  • One Grooper ZIP for Projects containing any resources shown in the article. Use the following naming format:
    • VersionNumber_Wiki_Article-Name_Projects.zip


What if I have multiple Batches I need to upload?

  • Put them in a folder in Grooper and export the folder.

What if I have multiple Projects I need to upload?

  • Put them in a folder in Grooper and export the folder


What if I don't reference the Grooper UI in my article at all?

  • In cases where articles do not reference the Grooper UI, you don't need to include a Grooper ZIP file.

What if I only have screenshots of one Batch?

  • Size does not matter.
  • Even if its just a single Batch with a single document, ZIP it up, and include it.

What if I only have screenshots of a single object, like just one Value Reader?

  • Size does not matter.
  • Even if it's a single node, put it in a Project, ZIP it up, and include it it.

Version Control

The first line of any article should be the following:

  • {{AutoVersion}}
  • This inserts the version control toggle box at the top of any article.


All articles written in the most recent release version of Grooper will be written in the "Main" namespace. Articles written for older versions of Grooper will be migrated to a corresponding namespace as newer versions of Grooper are released.

  • For example, imagine the current release version of Grooper is "2024" and an article about the Data Model object. The various "Data Model" articles for various versions would be named as below:
    • Data Model
    • 2023.1:Data Model
    • 2023:Data Model
    • 2022:Data Model
    • And so on


When a new version is released, articles currently in the Main namespace will be moved into a corresponding namespace.

  • For example, imagine 2024 was just released. A new namespace will be created for 2023.1 articles. All articles currently in the Main namespace will be migrated to the new "2023.1" namespace.
  • What about articles written for beta versions?
    • Typically, it is our internal policy to wait to document content until GA release.
    • In rare cases where we do need advance beta version documentation, there is a "Beta" namespace. Articles in the "Beta" namespace will be migrated to the Main namespace upon GA release.


BE AWARE: Moving an article to a different namespace can cause problems for our labeled section transclusion. When a GA release motivates a namespace move, we will need to take extra care to ensure transclusions work appropriately.


FYI: There may be a plan to prune older articles in the future but none has been implemented yet. Currently, articles from an EOL version do not show up in our standard search, but can be searched for using the advanced search.

Retrieved from "https://wiki.grooper.com/index.php?title=Article_Standards&oldid=19593"