2023:Article Template - Revision history

Dgreenwood at 14:51, 30 October 2025

2025-10-30T14:51:59Z

Dgreenwood: /* Version Differences */

2025-10-30T14:40:42Z

Version Differences

@@ Line 73: / Line 73: @@
 * 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.
 == See Also ==

Dgreenwood: /* Fourth Section: Examples */

2025-10-28T14:26:21Z

Fourth Section: Examples

← Older revision		Revision as of 09:26, 28 October 2025
Line 66:		Line 66:

	== Fourth Section: Examples ==		== 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.
	'''~~How does it work?~~'''		** 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.
	~~If you can~~'t ~~adequately explain the topic in the introductory paragraph,~~ the "~~About~~" ~~section will allow you to expand. What differentiates the Wiki from the is~~ the ~~Wiki answers "How?~~ and ~~Why?" where~~ the ~~Help Documentation answers "What?"~~. ~~Help Documentation explains "what" something is in Grooper~~. ~~Wiki articles should expand this~~ to "~~how~~" ~~something functions~~ and ~~is used~~. ~~The About section expands on how something works~~ in ~~Grooper~~. ~~You can't always get a good idea of how something works in Grooper with~~ the ~~description given in the help documentation. The About section gives you more room to demonstrate how something works~~.		* Ideally, this will be a real-world or practical example (or multiple examples!).
	* ~~This should~~ be a ~~high level/general explanation~~.		* 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.
	* ~~Visual aids are encouraged~~, ~~including:~~
	** Diagrams
	** Document screenshots
	*** Be sure all documents are "public facing". ~~They cannot come from~~ a ~~client or have personal data. Use public records or mocked up documents.~~
	** Grooper UI screenshots
	*Screenshots and images are highly encouraged here to aid your explanation. Most people learn better ~~with visual aids.~~
	*This section should be mostly conceptual. The "How To" and ~~"Use Cases" section can reinforce your explanation here with specifics~~.

	== Version Differences ==		== Version Differences ==

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

2025-10-28T14:19:39Z

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

← Older revision		Revision as of 09:19, 28 October 2025
Line 63:		Line 63:


	''You may name this section whatever you think is most appropriate. Or just name it "How to set up {ArticleTopic}"''		''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 ==		== Fourth Section: Examples ==

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

2025-10-28T14:19:12Z

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

← Older revision		Revision as of 09:19, 28 October 2025
Line 57:		Line 57:

	<big>For UI Elements</big>		<big>For UI Elements</big>
	* Explain how to ~~configure~~ the ~~feature~~.		* Explain how to interact with the UI element.
	* You must include at least describe ~~the~~ most "basic" or "standard" ~~configuration~~.		* All UIs exist to do help a user do something. Explain how you use it to do that thing.
	* For more complicated features, this section will likely result in several sub-sections detailing different ~~configuration scenarios~~.		* 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.

Dgreenwood: /* Second Section: What is it for? */

2025-10-28T14:16:54Z

Second Section: What is it for?

← Older revision		Revision as of 09:16, 28 October 2025
Line 40:		Line 40:
	** What problem does it solve?		** What problem does it solve?
	** If it prepares content for downstream processing, what is it doing and how does it help?		** 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.		* 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.

Dgreenwood: /* Use Cases */

2025-10-28T14:16:01Z

Use Cases

@@ Line 78: / Line 78: @@
 *Screenshots and images are highly encouraged here to aid your explanation.  Most people learn better with visual aids.
 *This section should be mostly conceptual.  The "How To" and "Use Cases" section can reinforce your explanation here with specifics.
 == Version Differences ==

Dgreenwood: /* How To */

2025-10-28T14:15:54Z

How To

@@ Line 78: / Line 78: @@
 *Screenshots and images are highly encouraged here to aid your explanation.  Most people learn better with visual aids.
 *This section should be mostly conceptual.  The "How To" and "Use Cases" section can reinforce your explanation here with specifics.
 == Use Cases ==

Dgreenwood at 14:15, 28 October 2025

2025-10-28T14:15:37Z

@@ Line 2: / Line 2: @@
 {{AutoVersion}}
-[[File:Grooper TM 1.png|thumb|An image at the top of the article is a good visual to identify your topic.]]
+[[File:Grooper TM 1.png|thumb|200px|An image at the top of the article is a good visual to identify your topic. <code>thumb</code> tagged images can be reduced in size (but not enlarged). <code>frame</code> tagged images cannot be size adjusted.]]
 <blockquote>
-Start with a quick one to two sentence "glossary" style definition of the subject to introduce the topic here.
+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.
 </blockquote>
-Expand the introduction here with a few more sentences if necessary.  This introductory section should be no longer than a paragraph.  More in-depth explanation of the topic should be done in the "About" section.
+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.'''''
 {|class="download-box"
+|
@@ Line 28: / Line 20: @@
 |}
-See the [[Article Standards]] for more specifics on Grooper ZIP standards.
+<big>A note on sections in articles</big>
-== About ==
+* Use sections (h2) to break up information in your article.
 '''How does it work?'''
@@ Line 99: / Line 135: @@
 == See Also ==
-Here, link to other articles in the wiki related to the topic or appropriate external links.
+You are not required to include this section. But it can help point users to other features and information on the wiki.
 Example:
 * [[Article Formatting]]
 * [[Article Standards]]
 [[Category:Style Guide]]

Dgreenwood: Dgreenwood moved page Article Template to 2023:Article Template

2025-10-28T13:36:54Z

Dgreenwood moved page Article Template to 2023:Article Template

← Older revision	Revision as of 08:36, 28 October 2025
(No difference)