Vertical Wrap Detection - Revision history

Dgreenwood: Dgreenwood moved page Vertical Wrap (Property) to Vertical Wrap Detection without leaving a redirect

2025-09-10T20:16:57Z

Dgreenwood moved page Vertical Wrap (Property) to Vertical Wrap Detection without leaving a redirect

← Older revision	Revision as of 15:16, 10 September 2025
(No difference)

Dgreenwood at 20:16, 10 September 2025

2025-09-10T20:16:39Z

← Older revision		Revision as of 15:16, 10 September 2025
Line 1:		Line 1:
	<blockquote>{{#lst:Glossary\|Vertical Wrap Detection}}</blockquote>		<blockquote>{{#lst:Glossary\|Vertical Wrap Detection}}</blockquote>

	~~== Overview ==~~

	'''Vertical Wrap''' is a powerful extraction feature in Grooper that enables the detection and extraction of multi-line text segments that are stacked vertically within a document. This is especially useful for labels, headers, or values that are split across multiple lines due to formatting, such as table headers or field names in forms. By leveraging Vertical Wrap, Grooper can accurately group and extract text that would otherwise be missed or fragmented, improving data extraction from complex or variable document layouts.		'''Vertical Wrap''' is a powerful extraction feature in Grooper that enables the detection and extraction of multi-line text segments that are stacked vertically within a document. This is especially useful for labels, headers, or values that are split across multiple lines due to formatting, such as table headers or field names in forms. By leveraging Vertical Wrap, Grooper can accurately group and extract text that would otherwise be missed or fragmented, improving data extraction from complex or variable document layouts.

Dgreenwood at 20:15, 10 September 2025

2025-09-10T20:15:15Z

← Older revision		Revision as of 15:15, 10 September 2025
Line 1:		Line 1:
	{{~~Migrated~~}}		<blockquote>{{#lst:Glossary\|Vertical Wrap Detection}}</blockquote>
	{~~{2021~~:~~{{PAGENAME}}}~~}
			== Overview ==

			'''Vertical Wrap''' is a powerful extraction feature in Grooper that enables the detection and extraction of multi-line text segments that are stacked vertically within a document. This is especially useful for labels, headers, or values that are split across multiple lines due to formatting, such as table headers or field names in forms. By leveraging Vertical Wrap, Grooper can accurately group and extract text that would otherwise be missed or fragmented, improving data extraction from complex or variable document layouts.

			== What is vertical wrap for? ==

			Vertical Wrap is designed to address scenarios where important information—such as field labels or table headers—is presented in a vertical arrangement. For example, a label like "Purchase Order Number" may appear as:

			{\|style="margin:auto" cellpadding=10
			\|
			<pre>
			Purchase
			Order
			Number
			</pre>
			\|
			or
			\|
			<pre>
			Purchase
			Order Number
			</pre>
			\|
			or
			\|
			<pre>
			Purchase Order
			Number
			</pre>
			\|
			or
			\|
			<pre>
			Purchase Order Number
			</pre>
			\|}

			Vertical Wrap allows Grooper to recognize these stacked words as a single logical label or value, ensuring that extraction rules remain robust even when document formatting varies.

			== How does Vertical Wrap Detection work? ==

			When Vertical Wrap is enabled, Grooper analyzes the spatial relationship between lines of text. It groups vertically adjacent text segments based on configurable criteria, such as:

			* '''Maximum Line Spacing''': Controls how far apart vertically adjacent lines can be and still be grouped.
			* '''Alignment''': Ensures that only lines with matching horizontal alignment (left, center, right, or any combination) are grouped.
			* '''Alignment Tolerance''': Allows for minor misalignments due to scanning or OCR inaccuracies.
			* '''Allow Horizontal Rule''': Permits horizontal lines (such as underlines or table rules) between wrapped lines.
			* '''Allow Vertical Rule''': Permits vertical lines (such as table cell borders) between wrapped segments.

			Once grouped, the combined text is compared to the set of search terms or values defined in the extractor’s vocabulary. If a match is found, the value is extracted as a single entity.

			== Where is Vertical Wrap Detection used in Grooper? ==

			Vertical Wrap Detection is an available option for the following Grooper Value Extractors and Behaviors:
			* '''[[Labeling Behavior]]'''
			** When applied to a Content Type, this Behavior enables label-driven extraction and provides centralized configuration for label matching parameters, including Vertical Wrap.
			** Various "label set enabled" functionality utilizes its Vertical Wrap settings.
			* '''[[List Match]]''':
			** This Value Extractor is used to extract values from document text that match any entry in a list of search terms.
			** Vertical Wrap enables detection of terms split across multiple lines, such as stacked field labels and column headers in tabular data.
			* '''[[Label Match]]'''
			** This Value Extractor works identically to List Match but inherits the Fuzzy Matching, Vertical Wrap, and Constrained Wrap settings configured in the document's Labeling Behavior.
			**Vertical Wrap enables detection of terms split across multiple lines, such as stacked field labels and column headers in tabular data.

			'''Vertical Wrap Detection is enabled and configured for these items using their "Vertical Wrap" property.'''

			=== How to configure Vertical Wrap Detection ===

			Vertical Wrap Detection is configured through the "Vertical Wrap" property in supported Value Extractors and Behaviors.

			To enable Vertical Wrap Detection:

			# Select an item that can use Vertical Wrap Detection (such as a [[List Match]], [[Label Match]], or [[Labeling Behavior]] configuration).
			# Locate the "Vertical Wrap" property.
			# Enable it.

			In most cases, the default settings work well. However, several configurable properties are available to better target edge cases.

			Vertical Wrap Detection settings include:

			* "Maximum Line Spacing": Set as a percentage of font size to control vertical grouping.
			* '''Alignment''': Choose required horizontal alignment for grouped lines.
			* '''Alignment Tolerance''': Specify tolerance in inches for alignment analysis.
			* '''Allow Horizontal Rule''': Enable or disable horizontal dividers between lines.
			* '''Allow Vertical Rule''': Enable or disable vertical dividers between segments.

			==Tips==
			* Vertical Wrap Detection is used on structured and semi-structured documents to capture short text segments that span multiple lines..
			* '''''You should not use Vertical Wrap Detection on unstructured documents or paragraphs. It is not designed to work for these scenarios. Use [[Paragraph Detection]] instead.'''''
			* Use Vertical Wrap Detection for extracting multi-line labels, table headers, or any field that may be split vertically.
			* Adjust "Maximum Line Spacing", "Alignment", and "Alignment Tolerance" settings to fine-tune which lines are grouped.
			* Enable or disable Horizontal and Vertical Rule options based on the presence of lines between wrapped text segments.
			* Test extraction with representative samples to verify matching results and adjust settings as needed.

			== Summary ==

			Vertical Wrap is an essential feature for extracting multi-line, vertically arranged text in Grooper. By configuring Vertical Wrap options in supported extractors and behaviors, users can ensure accurate and consistent data extraction from documents with complex or variable layouts.

Randallkinard: Randallkinard moved page Vertical Wrap to Vertical Wrap (Property): new naming convention

2024-04-18T17:56:08Z

Randallkinard moved page Vertical Wrap to Vertical Wrap (Property): new naming convention

← Older revision	Revision as of 12:56, 18 April 2024
(No difference)

Dgreenwood at 18:58, 3 January 2024

2024-01-03T18:58:43Z

← Older revision		Revision as of 13:58, 3 January 2024
Line 1:		Line 1:
	{{~~Migrated2023~~}}		{{Migrated}}
	{{~~2023~~:{{PAGENAME}}}}		{{2021:{{PAGENAME}}}}

Dgreenwood: Removed redirect to Vertical Wrap - 2021

2024-01-03T18:58:34Z

Removed redirect to Vertical Wrap - 2021

← Older revision		Revision as of 13:58, 3 January 2024
Line 1:		Line 1:
	~~#REDIRECT [[Vertical Wrap - 2021]]~~		{{Migrated2023}}
			{{2023:{{PAGENAME}}}}

Dgreenwood: Redirected page to Vertical Wrap - 2021

2021-03-31T20:14:54Z

Redirected page to Vertical Wrap - 2021

← Older revision		Revision as of 15:14, 31 March 2021
Line 1:		Line 1:
	[[~~File:Vertical-wrap-stacked-v-simple.png\|right]]~~		#REDIRECT [[Vertical Wrap - 2021]]

	~~<blockquote style="font-size:14pt">~~
	~~'''''~~Vertical Wrap~~''''' is a property of the '''Content Model''' ''[[Labeling Behavior]]'' and certain '''Extractor Types''' used to provide simplified extraction of vertically wrapped text (typically stacked labels).~~
	~~</blockquote>~~

	~~== About ==~~

	~~Stacked labels are simply multi~~-word labels whose words are aligned vertically on multiple lines. In other words, they are "stacked" on top of each other. You can contrast this with simple labels which appear on a single line of the document.

	In the before times (before version '''2021'''), stacked labels presented somewhat of a challenge. For simple labels, the approach is, well, simple. We use regular expression to match the label. Do you want to match the label "ZIP CODE"? Your regex pattern is simply <code>ZIP CODE</code>.
	~~<br clear = all>~~

	~~{\|cellpadding=10 cellspacing=5~~
	~~\|valign=top style="width:40%"\|~~
	However, for stacked labels, it's a little trickier. Regular expression matches a regex pattern against the entire document as one big text string. By itself, it doesn't have the capability to match labels stacked on top of each other because it just matches against the text flow character by character.

	Instead, we had to use a '''Data Type''', collated as an ''Ordered Array'', using the '''''Vertical Layout''''' mode, looking for each line of the stacked label as the array elements, and usually specifying some minimum distance between the words in the label to throw out false positive results.

	~~You can see here an example of how this was done.~~
	~~# This is the parent '''Data Type''' (also the object we have selected in the Node Tree).~~
	~~# The two child extractors return the results of each line.~~
	~~# The '''Data Type''' is configured to use the ''Ordered Array'' option for its '''''Collation''''', enabling '''''Vertical Layout''''' mode.~~
	~~# The '''Data Type''' returns the label, looking for the word "ZIP" stacked on top of "CODE".~~


	~~Seems like a lot of work to find the label "ZIP CODE", right?~~

	~~Starting in version '''~~2021~~''', there is a much easier way of doing this through the '''''Vertical Wrap''''' property.~~
	\|
	~~[[File:Vertical-wrap-about-01.png~~]]
	\|}

	~~Currently, the '''''Vertical Wrap''''' property is accessible at two points in '''Grooper'''.~~
	~~# When using the ''List Match'' '''''Extractor Type'''''.~~
	~~# When using the '''Content Model''' ''Labeling Behavior''.~~

	~~<tabs style="margin:20px">~~
	~~<tab name="Vertical Wrap and List Match" style="margin:20px">~~
	~~=== Vertical Wrap and List Match ===~~
	~~{\|cellpadding=10 cellspacing=5~~
	~~\|valign=top style="width:40%"\|~~
	~~At any point you can use the ''List Match'' '''''Extractor Type''''' you can enable vertical wrapping.~~

	~~# Here, we've created and selected a '''Value Reader'''.~~
	~~# We've set its '''''Extractor Type''''' to ''List Match''.~~
	~~# We have a single label in our '''''Local Entries''''' list of labels, <code>ZIP CODE</code>~~
	~~# As you can see, it returns the simple label.~~
	~~# However, it does not return the stacked label yet.~~
	\|
	~~[[File:Vertical-wrap-about-01.png]]~~
	\|-
	~~\|valign=top\|~~
	We can get ''both'' the simple and stacked label to match using the '''''Vertical Wrap''''' property. For the ''List Match'' '''''Extractor Type''''', vertical wrapping is enabled using the '''''Vertical Wrap''''' property in the "Properties" tab.

	~~# Navigate to the "Properties" tab.~~
	~~# Change the '''''Vertical Wrap''''' property from ''Disabled'' to ''Enabled''.~~
	~~#* This property is found under the '''''Options''''' property heading.~~
	~~# Now both the simple and stacked labels are matched and returned!~~
	\|
	~~[[File:Vertical-wrap-about-02.png]]~~
	\|}
	~~</tab>~~
	~~<tab name="Labeling Behavior and Vertical Wrap" style="margin:20px">~~
	~~=== Labeling Behavior and Vertical Wrap ===~~

	~~{\|cellpadding="10" cellspacing="5"~~
	~~\|-style="background-color:#36b0a7; color:white"~~
	\|style="font-size:14pt"\|'''FYI'''\|\|''Labeling Behavior'' is a '''Content Type''' '''''Behavior''''' that utilizes a document's labels for a variety of document processing purposes. For more information on the ''Labeling Behavior'' functionality, visit the [[Labeling Behavior]] article
	\|}

	~~{\|cellpadding=10 cellspacing=5~~
	~~\|valign=top style="width:40%"\|~~
	~~'''''Vertical Wrap''''' is enabled by default when adding the ''Labeling Behavior'' to a '''Content Model'''.~~

	~~# Here, we've added the ''Labeling Behavior'' to our '''Content Model''' using its '''''Behaviors''''' property.~~
	~~# As you can see, the '''''Vertical Wrap''''' property is ''Enabled'' by default.~~
	\|
	~~[[File:Vertical-wrap-about-03.png]]~~
	\|-
	~~\|valign=top\|~~
	~~Next part waiting on guidance from dev.~~
	\|
	~~IMAGE.png~~
	\|}

	~~</tab>~~
	~~</tabs>~~

	~~{\|cellpadding=10 cellspacing=5~~
	~~\|valign=top style="width:40%"\|~~
	~~Furthermore, the '''''Vertical Wrap''''' property will match wrapped results of multiple variations.~~

	~~Take for example the label "Purchase Order Number:" With '''''Vertical Wrap''''' enabled, this ''List Match'' extractor matches:~~

	~~# The simple label on a single line.~~
	~~# Both varieties of the stacked label on two lines.~~
	~~# And the stacked label on three lines.~~

	~~All of this done ''just'' by enabling the '''''Vertical Wrap''''' property, using its default configuration.~~
	\|
	~~[[File:Vertical-wrap-about-04.png]]~~
	\|}

	~~<!----~~

	~~=== Additional Configuration Info ===~~

	~~Flesh out this section as needed if peeps can't figure out sub-properties on they own.~~

Dgreenwood at 19:36, 31 March 2021

2021-03-31T19:36:50Z

← Older revision		Revision as of 14:36, 31 March 2021
Line 102:		Line 102:
	[[File:Vertical-wrap-about-04.png]]		[[File:Vertical-wrap-about-04.png]]
	\|}		\|}

			<!----

	=== Additional Configuration Info ===		=== Additional Configuration Info ===

			Flesh out this section as needed if peeps can't figure out sub-properties on they own.

Dgreenwood at 19:21, 31 March 2021

2021-03-31T19:21:46Z

← Older revision		Revision as of 14:21, 31 March 2021
Line 2:		Line 2:

	<blockquote style="font-size:14pt">		<blockquote style="font-size:14pt">
	'''''Vertical Wrap''''' is a property of the '''Content Model''' ''[[Labeling Behavior]]'' and certain '''Extractor Types''' used to provide simplified extraction of vertically wrapped text, typically stacked labels.		'''''Vertical Wrap''''' is a property of the '''Content Model''' ''[[Labeling Behavior]]'' and certain '''Extractor Types''' used to provide simplified extraction of vertically wrapped text (typically stacked labels).
	</blockquote>		</blockquote>

Dgreenwood at 19:21, 31 March 2021

2021-03-31T19:21:07Z

← Older revision		Revision as of 14:21, 31 March 2021
Line 2:		Line 2:

	<blockquote style="font-size:14pt">		<blockquote style="font-size:14pt">
	'''''Vertical Wrap''''' is a property of the '''Content Model''' ''[[Labeling Behavior]]'' and certain '''Extractor Types''' used to provide simplified extraction of stacked labels.		'''''Vertical Wrap''''' is a property of the '''Content Model''' ''[[Labeling Behavior]]'' and certain '''Extractor Types''' used to provide simplified extraction of vertically wrapped text, typically stacked labels.
	</blockquote>		</blockquote>