Article Template

BE AWARE: The first line of any article should be {{AutoVersion}} This creates the version control box below.

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025

2023

Start with a quick one to three sentence "glossary" style definition of the subject to introduce the topic here. The glossary term should be added to the Glossary page and transcluded from there.

Optional: Expand the introduction here with a few more sentences (only if necessary). Longer "about" or "overview" information should be included in the article's first major section heading.

All articles should include Grooper ZIP files. ZIP files should be linked at the start of the article before the first section heading. Use the "download-box" style to call out downloads like the one below. See the Article Standards for more specifics on Grooper ZIP standards.

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

A note on sections in articles

Use sections (h2) to break up information in your article.
Use sub-sections (h3, h4, etc) to further break up complex information into more consumable (and linkable) parts.
While we have gone away from a rigidly prescribed section structure in our articles, the following 4 sections should likely be included in each article, in some way.

First Section: What is it?

Tell the reader what the feature/configuration object is.
Explain what it does.
This section is for overviewing the feature. It should be a "view from above" or "at a glance" in terms of detail. Include enough information so the reader can generally understand the feature's function.

Include screenshots, illustrations or a small supademo to overview what the feature is.

You may name this section whatever you think is most appropriate. Or just name it "What is {ArticleTopic}?"

Second Section: What is it for?

Tell the reader how the feature/configuration object is used.
Explain why people use this feature.
- What problem does it solve?
- If it prepares content for downstream processing, what is it doing and how does it help?
When possible, include overviews of practical use cases implementing the feature. How to users actually use this in the real world?
This section is about helping the reader understand the feature's utility and usefulness. If a user doesn't understand a feature's purpose, they are less likely to use it and more likely to misuse it.

Include screenshots, illustrations or a small supademo to overview the feature's use.

You may name this section whatever you think is most appropriate. Or just name it "What is {ArticleTopic} used for?"

Third Section: How do I set it up? (Or for UI Elements - How do I use it?)

For configuration objects

Explain how to configure the feature.
You must include at least describe the most "basic" or "standard" configuration.
For more complicated features, this section will likely result in several sub-sections detailing different configuration scenarios.

Must include supademos for each configuration scenario. This is likely to be the most supademo heavy section.

For UI Elements

Explain how to interact with the UI element.
All UIs exist to do help a user do something. Explain how you use it to do that thing.
You must include at least describe its most "basic" or "standard" use.
For more complicated features, this section will likely result in several sub-sections detailing different ways the UI is used.

You may name this section whatever you think is most appropriate. Or just name it "How to set up {ArticleTopic}" or "How to use {ArticleTopic}

Fourth Section: Examples

Showing how to configure something is a necessary part of learning how to implement Grooper features. But it doesn't show what they do.
All articles should have at least one example of what the feature does.
Figure out a way to show users the effect of a feature.
- Example: Don't just show users the "Recognize" activity by running the activity and calling it quits. Show them the text data that gets generated. Show them that extractors can now return text data. Show them
- Example: Don't just show users how to configure the "PDF Format" for Export and call it quits. Show them that PDF Format's place in an Export step. Show them the file that gets generated.
Ideally, this will be a real-world or practical example (or multiple examples!).
Even if the example is not the most practical, that's ok. User's seeing the results of a configuration helps them better understand what the feature does and its purpose.

First Section: What is it?

Second Section: What is it for?

Third Section: How do I set it up? (Or for UI Elements - How do I use it?)

Fourth Section: Examples

See Also