Article Standards - Revision history

Dgreenwood at 14:53, 6 November 2025

2025-11-06T14:53:38Z

← Older revision		Revision as of 09:53, 6 November 2025
Line 34:		Line 34:
	All Grooper objects and properties should be capitalized. Exceptions to this rule are documented in the [[Grooper Colloquialisms]] article.		All Grooper objects and properties should be capitalized. Exceptions to this rule are documented in the [[Grooper Colloquialisms]] article.

	<big>~~Letter~~ case for section headings</big>		<big>Sentence case for section headings</big>

	Starting Q3 2024, we will use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case] for all section headings. Sentence case is the standard for Wikipedia. It better distinguishes between proper nouns (objects and properties in the formal Grooper vocabulary) and other words.		Starting Q3 2024, we will use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case] for all section headings. Sentence case is the standard for Wikipedia. It better distinguishes between proper nouns (objects and properties in the formal Grooper vocabulary) and other words.
	* Capitalize ONLY the first letter of the section's title and any proper nouns.		* Capitalize ONLY the first letter of the section's title and any proper nouns.
	* All Grooper objects and properties should be capitalized. Exceptions to this rule are documented in the [[Grooper Colloquialisms]] article.		* All Grooper objects (incl. Node Types, Activity Types, Export Providers, etc.) and properties should be capitalized. Exceptions to this rule are documented in the [[Grooper Colloquialisms]] article.

	<big>Quotes</big>		<big>Quotes</big>

Dgreenwood: /* "First mention" linking and icons */

2025-11-04T15:20:42Z

"First mention" linking and icons

← Older revision		Revision as of 10:20, 4 November 2025
Line 78:		Line 78:
	* Linking to an article more than once per section crowds the topic and makes it more difficult to read.		* Linking to an article more than once per section crowds the topic and makes it more difficult to read.
	* Beyond linking to a topic the first time is up to the author's discretion. If it makes sense to link to it more than the first time, you may do so.		* Beyond linking to a topic the first time is up to the author's discretion. If it makes sense to link to it more than the first time, you may do so.
	* Ex: This is the first time we've mentioned ~~'''''~~[[Row Match]]~~'''''~~. So, we linked to it. But if we mention ~~'''''~~Row Match~~'''''~~ afterwards, we don't need to link to it.		* Ex: This is the first time we've mentioned [[Row Match]]. So, we linked to it. But if we mention Row Match afterwards, we don't need to link to it.


	When a Grooper '''~~object~~''' is mentioned the first time in an article, you should also prepend the link with that ~~object~~'s icon.		When a Grooper '''Node Type''' is mentioned the first time in an article, you should also prepend the link with that Node Type's icon.
	* Icons can be inserted inline with text ~~as an image~~.		* Icons can be inserted inline with text using a custom Grooper Wiki template.
	* ~~This image files are already uploaded to the wiki.~~ Use the following markup convention to reference them:		* Use the following markup convention to reference them:
	** <code><nowiki>[[~~image:GrooperIcon_ObjectName.png~~]]</nowiki></code>		** <code><nowiki>{{IconName\|Node Type}}</nowiki></code>
	* Ex: ~~This is the first time we've mentioned a [[image:GrooperIcon_Lexicon.png]] '''~~[[Lexicon]]~~'''. So we linked~~ to ~~it ''~~and~~'' prepended its icon to it~~. ~~But if we mention '''Lexions''' afterwards~~, ~~we don't need to link to it~~.		* Ex wikitext: <code><nowiki>{{IconName\|Lexicon}} [[Lexicon]]</nowiki></code>
			* Ex rendered: {{IconName\|Lexicon}} [[Lexicon]]
			*<li class="fyi-bullet"> This template uses a lookup to insert the icon from a Google Material Symbols and Icons font file hosted on the wiki server. If the lookup does not work using the objects name in Grooper, you can use the symbols name from Google.
			** Ex wikitext: <code><nowiki>{{IconName\|dictionary}}</nowiki></code>
			** Ex rendered: {{IconName\|dictionary}}

	== Grooper ZIPs ==		== Grooper ZIPs ==

Dgreenwood: /* Grooper ZIPs */

2025-11-04T15:14:30Z

Grooper ZIPs

← Older revision		Revision as of 10:14, 4 November 2025
Line 126:		Line 126:
	* Most typically you will link to a maximum of two (2) files:		* 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:		* One Grooper ZIP for '''Batches''' containing any documents shown in the article. Use the following naming format:
	** <code>~~VersionNumber_Wiki_Article-Name_Batches~~.zip</code>		** <code>VersionNumber Wiki Article Name Batches.zip</code>
	* One Grooper ZIP for '''Projects''' containing any resources shown in the article. Use the following naming format:		* One Grooper ZIP for '''Projects''' containing any resources shown in the article. Use the following naming format:
	** <code>~~VersionNumber_Wiki_Article-Name_Projects~~.zip</code>		** <code>VersionNumber Wiki Article Name Projects.zip</code>

			How should I format the file name? Where does it need spaces/dashes/underscores?
			* Use your best judgement to make it legible.
			* Mediawiki is agnostic towards underscores and spaces (it treats them as the same character).
			* Just make sure the title has (1) the version number followed by (2) the word "Wiki" followed by (3) the article name followed by (4) whether its a "Batches" zip or a "Projects" zip.

			Should I use the short article name in the file name or the full article name?
			* Full name = Object (Object Type)
			* Short name = Object
			* Use the short name.

	What if I have multiple Batches I need to upload?		What if I have multiple Batches I need to upload?
Line 141:		Line 150:
	* In cases where articles do not reference the Grooper UI, you don't need to include a Grooper ZIP file.		* 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~~'''~~?		What if I only have screenshots of one Batch?
	* Size does not matter.		* Size does not matter.
	* Even if its just a single ~~'''~~Batch~~'''~~ with a single document, ZIP it up, and include it.		* 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~~'''~~?		What if I only have screenshots of a single object, like just one Value Reader?
	* Size does not matter.		* Size does not matter.
	* Even if it's a single node, put it in a ~~'''~~Project~~'''~~, ZIP it up, and include it it.		* Even if it's a single node, put it in a Project, ZIP it up, and include it it.

	== Version control ==		== Version control ==

Rpatton: /* Supademo standards */

2025-10-02T17:38:57Z

Supademo standards

← Older revision		Revision as of 12:38, 2 October 2025
Line 190:		Line 190:
	* Refer to [[Data Inspector (UI Element)]] for an example.		* Refer to [[Data Inspector (UI Element)]] for an example.

	<big>Standard 2: Embed the Supademo iframe ~~before~~ the step-by-step instructions.</big>		<big>Standard 2: Embed the Supademo iframe after the step-by-step instructions.</big>
	* Refer to [[Data Inspector (UI Element)]] for an example.		* Refer to [[Data Inspector (UI Element)]] for an example.

Dgreenwood at 21:25, 27 August 2025

2025-08-27T21:25:44Z

@@ Line 53: / Line 53: @@
 == Bolding and italics ==
-As of version 2025, we no longer have rules regarding bolding and italicizing objects, properties, etc. Use your best judgement for what should be bolded or italicized.
+As of version 2025, we no longer have rules regarding bolding and italicizing nodes, objects, properties, etc. Use your best judgement for what should be bolded or italicized.
 == Links ==

Rpatton: // via Wikitext Extension for VSCode

2025-07-16T14:27:46Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 09:27, 16 July 2025
Line 53:		Line 53:

	== Bolding and italics ==		== Bolding and italics ==
			As of version 2025, we no longer have rules regarding bolding and italicizing objects, properties, etc. Use your best judgement for what should be bolded or italicized.

			<!-- Editor's Note: As of version 2025, we no longer have bolding and italics rules.

	Bold all Grooper '''node types''' and '''services'''.		Bold all Grooper '''node types''' and '''services'''.

Line 107:		Line 111:

	Tabs in the Grooper UI should can be enclosed in "quotes".		Tabs in the Grooper UI should can be enclosed in "quotes".
	* Example: Go to the '''Content Model's''' <span style="background-color:yellow">"Labels"</span> tab.		* Example: Go to the '''Content Model's''' <span style="background-color:yellow">"Labels"</span> tab.-->

	== Links ==		== Links ==
Line 153:		Line 157:
	\|		\|
	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.		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.
	* [[Media:~~2023_Wiki_Article-Name_Batches~~.zip]]		* [[Media:2023 Wiki Article Name Batches.zip]]
	* [[Media:~~2023_Wiki_Article-Name_Projects~~.zip]]		* [[Media:2023 Wiki Article Name Projects.zip]]
	\|}		\|}
	</pre>		</pre>
Line 163:		Line 167:
	\|		\|
	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.		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.
	* [[Media:~~2023_Wiki_Article-Name_Batches~~.zip]]		* [[Media:2023 Wiki Article Name Batches.zip]]
	* [[Media:~~2023_Wiki_Article-Name_Projects~~.zip]]		* [[Media:2023 Wiki Article Name Projects.zip]]
	\|}		\|}
	\|}		\|}
Line 242:		Line 246:
	* Text is necessary for the HelpSearch resource that AI Assistants use in Grooper.		* Text is necessary for the HelpSearch resource that AI Assistants use in Grooper.
	* More advanced users will just want to refer to the text-based steps anyway.		* More advanced users will just want to refer to the text-based steps anyway.
	* Refer to [[~~Project#Adding a New Project~~]] for an example.		* Refer to [[Data Inspector (UI Element)]] for an example.

	<big>Standard 2: ~~Link to~~ the ~~supademo~~ before the step-by-step instructions.</big>		<big>Standard 2: Embed the Supademo iframe before the step-by-step instructions.</big>
	*<li class="attn-bullet"> BE AWARE! This will change once we add the capability to embed ifra		* Refer to [[Data Inspector (UI Element)]] for an example.
	~~mes into the wiki articles.~~
	* Refer to [[~~Project#Adding a New Project~~]] for an example.

	<big>Standard 3: All demos' Step 1 should use the same template</big>		<big>Standard 3: All demos' Step 1 should use the same template</big>
Line 263:		Line 265:
	* Grooper teal callouts should be used rarely and with purpose (Don't just do it all the time. It gets in the way).		* Grooper teal callouts should be used rarely and with purpose (Don't just do it all the time. It gets in the way).

	<big>Standard 5: All demos' final step should be the ~~"Thank you for watching!"~~ image</big>		<big>Standard 5: All demos' final step should be the Grooper Desktop image with the Grooper Logo</big>
	* ~~This is the image Randall Kinard made with the text~~ under the ~~Grooper~~ logo.		* A Callout Box should be placed directly under the logo and say "Thank you for watching!"
	* No voiceover is necessary. Keep it clean and quiet.		* No voiceover is necessary. Keep it clean and quiet.

Dgreenwood: /* General */

2025-05-14T17:36:04Z

General

← Older revision		Revision as of 12:36, 14 May 2025
Line 47:		Line 47:

	Example logical quotation vs conventional quotation:		Example logical quotation vs conventional quotation:
	* logical quotation - ~~Select the~~ "~~Batch~~".		* logical quotation - If you want to perform a "mapped export", your Metadata Format will need to be "Normal".
	* conventional quotation - ~~Select the~~ "~~Batch~~."		* conventional quotation - If you want to perform a "mapped export," your Metadata Format will need to be "Normal."

	[https://en.wikipedia.org/wiki/Wikipedia:Logical_quotation_on_Wikipedia More on logical quotation]		[https://en.wikipedia.org/wiki/Wikipedia:Logical_quotation_on_Wikipedia More on logical quotation]

Dgreenwood at 17:29, 14 May 2025

2025-05-14T17:29:41Z

@@ Line 39: / Line 39: @@
 * Capitalize ONLY the first letter of the section's title and any proper nouns.
 * All Grooper objects and properties should be capitalized.  Exceptions to this rule are documented in the [[Grooper Colloquialisms]] article.
 == Bolding and italics ==

Dgreenwood: /* Bolding and italics */

2025-04-29T15:22:47Z

Bolding and italics

← Older revision		Revision as of 10:22, 29 April 2025
Line 58:		Line 58:


	Bold and Italicize all Grooper '''''properties''''' and embedded objects.		Bold and Italicize all Grooper '''''properties''''' and '''''embedded objects'''''.
	* What's a property?		* What's a property?
	** Anything in a property configuration grid.		** Anything in a property configuration grid.

Dgreenwood: /* Bolding and italics */

2025-04-29T15:07:43Z

Bolding and italics

← Older revision		Revision as of 10:07, 29 April 2025
Line 41:		Line 41:

	== Bolding and italics ==		== Bolding and italics ==
	Bold all Grooper '''~~objects~~''' and '''services'''.		Bold all Grooper '''node types''' and '''services'''.

	* What's ~~an object~~? ~~A good rule of thumb is anything~~ you can add to the Node Tree is ~~an object~~.		* What's a node type? Anything you can add to the Node Tree is a node.
	** '''Batch'''		** '''Batch'''
	** '''Batch Folder'''		** '''Batch Folder'''
Line 58:		Line 58:


	Bold and Italicize all Grooper '''''properties'''''		Bold and Italicize all Grooper '''''properties''''' and embedded objects.
	* What's a property?		* What's a property?
	** Anything in a property configuration grid.		** Anything in a property configuration grid.
Line 64:		Line 64:
	** This includes groups of properties in a property grid.		** This includes groups of properties in a property grid.
	**: Example: Expressions can be configured in a '''Data Field's''' <span style="background-color:yellow">'''''Behavior'''''</span> properties.		**: Example: Expressions can be configured in a '''Data Field's''' <span style="background-color:yellow">'''''Behavior'''''</span> properties.
	** ~~This includes anything~~ in ~~Grooper that has sub-properties as well~~.
	*** Example: <span style="background-color:yellow">'''''Pattern Match'''''</span> is an ~~'''''~~Extractor Type~~'''''~~.		* What's an embedded object?
	**** It is not a Grooper ~~object. So, it should not be bolded~~.		** Embedded objects are chunks of code used and re-used throughout Grooper property grids. The are ''embedded'' in a node's property grid. Once selected, they have their own set of property configurations.
	**** Rather, '''''Pattern Match''''' is ~~one of many things~~ in Grooper ~~that brings up a configurable set of properties once selected~~.		** A common example is all the "'''''Extractor Types'''''".
			*** Example: <span style="background-color:yellow">'''''Pattern Match'''''</span> is an Extractor Type.
			**** It is not a Grooper node type.
			**** Rather, '''''Pattern Match''''' is an object that can be called in numerous Grooper property grids when an extractor is needed.
	*** Other examples include:		*** Other examples include:
	**** All '''''Activities''''' ('''''<span style="background-color:yellow">Recognize'''''</span> etc)		**** All '''''Activities''''' ('''''<span style="background-color:yellow">Recognize'''''</span> etc)
Line 74:		Line 77:
	**** All '''''Table Extract Methods''''' ('''''<span style="background-color:yellow">Tabular Layout'''''</span> etc)		**** All '''''Table Extract Methods''''' ('''''<span style="background-color:yellow">Tabular Layout'''''</span> etc)
	**** All '''''Behaviors''''' ('''''<span style="background-color:yellow">Labeling Behavior''''' etc)		**** All '''''Behaviors''''' ('''''<span style="background-color:yellow">Labeling Behavior''''' etc)
	** This includes larger categories of Grooper ~~functionality as well~~.		** This includes the larger categories of Grooper objects too.
	*** Example: '''''Pattern Match''''' is an <span style="background-color:yellow">'''''Extractor Type'''''</span>		*** Example: '''''Pattern Match''''' is an <span style="background-color:yellow">'''''Extractor Type'''''</span>
	**** It is not a specific Grooper object. ~~So, it should not be bolded.~~		**** '''''Extractor Type''''' is not a specific Grooper object. It is a class of Grooper objects that all do extraction related things.
	**** These may or may not be a ~~configurable property. But they are a category~~ of ~~various things in~~ Grooper that ~~are configured with a property grid~~.
	*** Other examples include:		*** Other examples include:
	**** '''''<span style="background-color:yellow">Activity</span>'''''		**** '''''<span style="background-color:yellow">Activity</span>'''''
Line 92:		Line 94:


	Tabs in the Grooper UI should be enclosed in "quotes".		Tabs in the Grooper UI should can be enclosed in "quotes".
	* Example: Go to the '''Content Model's''' <span style="background-color:yellow">"Labels"</span> tab.		* Example: Go to the '''Content Model's''' <span style="background-color:yellow">"Labels"</span> tab.