Osis2mod - Revision history

Dmsmith: /* Module and Testament Introductions */ Making progress toward having Module and Testament Introductions

2025-07-14T16:50:27Z

Module and Testament Introductions: Making progress toward having Module and Testament Introductions

@@ Line 411: / Line 411: @@
 # In the following, the effects of the above transformations are not shown. The tagging of the pre-verse material is also not shown.
-===Module and Testament Introductions===
+===Module Introduction===
-At this time, osis2mod does not fully support module and testament introductions. A module introduction should be place into testament 0, book 0, chapter 0, verse 0. A testament introduction should be placed into testament 1 or 2, book 0, chapter 0, verse 0. Currently, these are placed into Genesis 0:0 or Matthew 0:0.
+At this time, osis2mod does not fully support module introduction. It is intended that the following will work. All material after the &lt;/header&gt; and before a div with a type of book or bookGroup is a module heading.
 ===Book Introductions and Titles===

Dmsmith: /* History of Changes */ new history entry

2025-07-07T21:25:09Z

History of Changes: new history entry

← Older revision		Revision as of 21:25, 7 July 2025
Line 18:		Line 18:
	!Revision		!Revision
	!Feature		!Feature
			\|-valign="top"
			\|
			'''2025-07-07'''
			\|
			r3907
			\|
			* MODTOOLS-25 give location in input for messages.

			Created identifyMsg which creates a standardized message for reporting and used it for all messages to standard out.

			The message is of the form: type(kind)[linePos,charPos] osisID=osisID: message

			Where:
			type The message type (e.g., "ERROR", "WARNING", "INFO").
			kind The message category or kind (e.g., "REF", "PARSE").
			linePos The position in the file of the last line that was read.
			charPos The position in the line of the last character that was read.
			osisID (Optional) The current OSIS ID to include. May be nullptr or empty.
			message event description with details

			* If linePos is 0, the position ([linePos,charPos]) is omitted.
			* If osisID is nullptr or empty, the osisID part is omitted.
			* The returned string always ends with a colon and a trailing space (": ").

	\|-valign="top"		\|-valign="top"
	\|		\|
Line 25:		Line 49:
	\|		\|
	* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.		* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.
			** Outputs the name of the versification system being used at program start
	- Outputs the name of the versification system being used at program start		** Adds layered resolution of versifications:
	- Adds layered resolution of versifications:		## Case-sensitive exact match
	1) Case-sensitive exact match		## Case-insensitive exact match
	2) Case-insensitive exact match		## Case-insensitive prefix match
	3) Case-insensitive prefix match		** Shows detailed error messages when input is invalid or ambiguous:
	- Shows detailed error messages when input is invalid or ambiguous:		*** Lists all matches in case of ambiguity
	* Lists all matches in case of ambiguity		*** Lists input and valid options if no match is found
	* Lists input and valid options if no match is found

	\|-valign="top"		\|-valign="top"

Dmsmith: /* Messages */

2025-07-07T17:51:19Z

Messages

@@ Line 613: / Line 613: @@
 Osis2mod has robust, mind-boggling messages. These are provided here in hopes that it will help problem diagnosis.
-===Diagnostic Messages===
+Messages are output with a standard format:
 In the following, example values are given in '''{...}'''. The brackets do not actually appear in the message. Also, the messages are a bit prettier here than in reality.
-In the following
-* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
+===Diagnostic Messages===
   WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''):     Should be converted to UTF-8 ('''{text }''')
@@ Line 702: / Line 730: @@
 '''-d 1'''<br/>
-Output of what is being written to the module. The two osisIDs should always be the same.
+Output of what is being written to the module.
   DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''):      '''{ text so far }'''
 '''-d 4'''<br/>

Dmsmith: /* Diagnostic Messages */

2025-07-07T17:09:10Z

Diagnostic Messages

← Older revision		Revision as of 17:09, 7 July 2025
Line 613:		Line 613:
	Osis2mod has robust, mind-boggling messages. These are provided here in hopes that it will help problem diagnosis.		Osis2mod has robust, mind-boggling messages. These are provided here in hopes that it will help problem diagnosis.

	==Diagnostic Messages==		===Diagnostic Messages===
	In the following, example values are given in '''{...}'''. The brackets do not actually appear in the message. Also, the messages are a bit prettier here than in reality.		In the following, example values are given in '''{...}'''. The brackets do not actually appear in the message. Also, the messages are a bit prettier here than in reality.

Dmsmith: Moved Exit Statuses

2025-07-07T17:08:21Z

Moved Exit Statuses

← Older revision		Revision as of 17:08, 7 July 2025
Line 773:		Line 773:
	cipherKey: '''{ cipherKey }'''		cipherKey: '''{ cipherKey }'''
	normalize: '''{ normalize }'''		normalize: '''{ normalize }'''

			===Exit Status===
			When an error occurs that causes osis2mod to exit without processing the entire input file, a non-zero exit status is supplied to the caller. Here are the codes that osis2mod uses:
			const int EXIT_BAD_ARG = 1; // Bad parameter given for program
			const int EXIT_NO_WRITE = 2; // Could not open the module for writing
			const int EXIT_NO_CREATE = 3; // Could not create the module
			const int EXIT_NO_READ = 4; // Could not open the input file for reading.
			const int EXIT_BAD_NESTING = 5; // BSP or BCV nesting is bad or improper XML comment

	== Future Roadmap ==		== Future Roadmap ==

Dmsmith: Moving Exit Status after messages

2025-07-07T17:06:41Z

Moving Exit Status after messages

← Older revision		Revision as of 17:06, 7 July 2025
Line 612:		Line 612:
	==Messages==		==Messages==
	Osis2mod has robust, mind-boggling messages. These are provided here in hopes that it will help problem diagnosis.		Osis2mod has robust, mind-boggling messages. These are provided here in hopes that it will help problem diagnosis.

	~~===Exit Status===~~
	~~When an error occurs that causes osis2mod to exit without processing the entire input file, a non-zero exit status is supplied to the caller. Here are the codes that osis2mod uses:~~
	~~const int EXIT_BAD_ARG = 1; // Bad parameter given for program~~
	~~const int EXIT_NO_WRITE = 2; // Could not open the module for writing~~
	~~const int EXIT_NO_CREATE = 3; // Could not create the module~~
	~~const int EXIT_NO_READ = 4; // Could not open the input file for reading.~~
	~~const int EXIT_BAD_NESTING = 5; // BSP or BCV nesting is bad or improper XML comment~~

	==Diagnostic Messages==		==Diagnostic Messages==

Dmsmith: New format

2025-07-07T16:18:12Z

New format

Show changes

Dmsmith: /* Debug Messages */

2025-07-07T15:41:00Z

Debug Messages

Dmsmith: /* Diagnostic Messages= */

2025-07-07T15:37:38Z

Diagnostic Messages=

← Older revision		Revision as of 15:37, 7 July 2025
Line 621:		Line 621:
	const int EXIT_BAD_NESTING = 5; // BSP or BCV nesting is bad or improper XML comment		const int EXIT_BAD_NESTING = 5; // BSP or BCV nesting is bad or improper XML comment

	==Diagnostic Messages===		==Diagnostic Messages==
	In the following, example values are given in '''{...}'''. The brackets do not actually appear in the message. Also, the messages are a bit prettier here than in reality.		In the following, example values are given in '''{...}'''. The brackets do not actually appear in the message. Also, the messages are a bit prettier here than in reality.

Dmsmith: /* Debug Messages */

2025-07-07T15:36:31Z

Debug Messages

← Older revision		Revision as of 15:36, 7 July 2025
Line 752:		Line 752:
	'''-d 128'''<br/>		'''-d 128'''<br/>
	OSIS ids and references can be of a form that SWORD cannot parse. Osis2mod contains a routine that munges these into a form that SWORD can understand.		OSIS ids and references can be of a form that SWORD cannot parse. Osis2mod contains a routine that munges these into a form that SWORD can understand.
	DEBUG(REF): ~~Copy~~ range marker: '''~~[ marker ]~~'''		DEBUG(REF): VerseKey can parse this as is.
	DEBUG(REF): Found a work prefix '''[ workPrefix ]'''		DEBUG(REF): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): ~~Copy~~ osisID:'''[ osisID ]'''		DEBUG(REF): Found a work prefix '''[ workPrefix ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): Found a grain suffix '''[ grain ]'''		DEBUG(REF): Found an osisID:'''[ osisID ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	~~DEBUG(REF)~~: ~~Found a range~~		DEBUG(REF): Found a grain suffix '''[ grain ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): ~~replacing~~ space with ;. Remaining: '''~~[ text ]~~'''		DEBUG(REF): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): ~~shortended keyVal to`~~'''[ ~~text~~ ]'''`		DEBUG(REF): Parseable VerseKey -- '''[ osisRef ]'''

	'''-d 256'''<br/>		'''-d 256'''<br/>

← Older revision		Revision as of 15:41, 7 July 2025
Line 711:		Line 711:
	'''-d 1'''<br/>		'''-d 1'''<br/>
	Output of what is being written to the module. The two osisIDs should always be the same.		Output of what is being written to the module. The two osisIDs should always be the same.
	DEBUG(WRITE): '''[ osisID ]''':'''[ osisID ]''': '''[ text so far ]'''		DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ osisID ]''':'''[ osisID ]''': '''[ text so far ]'''

	'''-d 4'''<br/>		'''-d 4'''<br/>
	A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack		A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
	DEBUG(QUOTE): '''[ currentOsisID ]''': quote top('''[ quote stack size ]''') '''[ token ]'''		DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': quote top('''[ quote stack size ]''') '''[ token ]'''
	DEBUG(QUOTE): '''[ currentOsisID ]''': quote pop('''[ quote stack size ]''') '''[ topToken ]''' -- '''[ token ]'''		DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': quote pop('''[ quote stack size ]''') '''[ topToken ]''' -- '''[ token ]'''
	DEBUG(QUOTE): '''[ currentOsisID ]''': ('''[ quote stack size ]''') '''[ topToken ]''' -- '''[ token ]'''		DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': ('''[ quote stack size ]''') '''[ topToken ]''' -- '''[ token ]'''


	'''-d 8'''<br/>		'''-d 8'''<br/>
	Identifies when book and chapter introductions are being determined.		Identifies when book and chapter introductions are being determined.
	DEBUG(TITLE): '''[ currentOsisID ]''': OOPS INTRO		DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': OOPS INTRO
	inChapterIntro = '''[ inChapterIntro ]'''		inChapterIntro = '''[ inChapterIntro ]'''
	inBookIntro = '''[ inBookIntro ]'''		inBookIntro = '''[ inBookIntro ]'''
	DEBUG(TITLE): '''[ currentOsisID ]''': Looking for book introduction		DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Looking for book introduction
	DEBUG(TITLE): '''[ currentOsisID ]''': Done looking for book introduction		DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Done looking for book introduction
	DEBUG(TITLE): '''[ currentOsisID ]''': BOOK INTRO '''[ beading ]'''		DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': BOOK INTRO '''[ beading ]'''
	DEBUG(TITLE): '''[ currentOsisID ]''': Looking for chapter introduction		DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Looking for chapter introduction
	DEBUG(TITLE): '''[ currentOsisID ]''': Done looking for chapter introduction		DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Done looking for chapter introduction
	DEBUG(TITLE): '''[ currentOsisID ]''': CHAPTER INTRO '''[ heading ]'''		DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': CHAPTER INTRO '''[ heading ]'''

	'''-d 16'''<br/>		'''-d 16'''<br/>
	Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.		Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
	DEBUG(INTERVERSE): '''[ currentOsisID ]''': interverse start token '''[ token ]''':'''[ text ]'''		DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': interverse start token '''[ token ]''':'''[ text ]'''
	DEBUG(INTERVERSE): '''[ currentOsisID ]''': interverse end tag: '''[ tokenName ]'''('''[ tagDepth ]''','''[ chapterDepth ]''','''[ bookDepth ]''')		DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': interverse end tag: '''[ tokenName ]'''('''[ tagDepth ]''','''[ chapterDepth ]''','''[ bookDepth ]''')
	DEBUG(INTERVERSE): '''[ currentOsisID ]''': appending interverse end tag: '''[tokenName ]'''('''[ tagDepth ]''','''[ chapterDepth ]''','''[ bookDepth ]''')		DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': appending interverse end tag: '''[tokenName ]'''('''[ tagDepth ]''','''[ chapterDepth ]''','''[ bookDepth ]''')

	'''-d 32'''<br/>		'''-d 32'''<br/>
	The following messages relate to the transformations of containers to milestones.		The following messages relate to the transformations of containers to milestones.
	DEBUG(XFORM): '''[ currentOsisID ]''': xform empty '''[ token ]'''		DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform empty '''[ token ]'''
	DEBUG(XFORM): '''[ currentOsisID ]''': xform push ('''[ bspTagStack.size() ]''') '''[ token ]''' (tagname='''[ tagName ]''')		DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform push ('''[ bspTagStack.size() ]''') '''[ token ]''' (tagname='''[ tagName ]''')
	DEBUG(XFORM): '''[ currentOsisID ]''': xform top('''[ bsp stack size ]''') '''[ topToken ]'''		DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform top('''[ bsp stack size ]''') '''[ topToken ]'''
	DEBUG(XFORM): '''[ currentOsisID ]''': xform pop('''[ bsp stack size ]''') '''[ topToken ]'''		DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform pop('''[ bsp stack size ]''') '''[ topToken ]'''

	'''-d 64'''<br/>		'''-d 64'''<br/>
	Occasionally a verse reference is outside of the chosen versification. These messages help to understand difficulties that osis2mod has in storing extra-canonical material in the module.		Occasionally a verse reference is outside of the chosen versification. These messages help to understand difficulties that osis2mod has in storing extra-canonical material in the module.
	DEBUG(V11N): '''[ currentOsisID ]''' normalizes to '''[ after ]'''		DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''' normalizes to '''[ after ]'''
	DEBUG(V11N): Chapter max:'''[ chapterMax ]''', Verse Max:'''[ verseMax ]'''		DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''[ chapterMax ]''', Verse Max:'''[ verseMax ]'''

	'''-d 128'''<br/>		'''-d 128'''<br/>
	OSIS ids and references can be of a form that SWORD cannot parse. Osis2mod contains a routine that munges these into a form that SWORD can understand.		OSIS ids and references can be of a form that SWORD cannot parse. Osis2mod contains a routine that munges these into a form that SWORD can understand.
	DEBUG(REF): VerseKey can parse this as is.		DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
	DEBUG(REF): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''		DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): Found a work prefix '''[ workPrefix ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''		DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''[ workPrefix ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): Found an osisID:'''[ osisID ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''		DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''[ osisID ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): Found a grain suffix '''[ grain ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''		DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''[ grain ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''		DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
	DEBUG(REF): Parseable VerseKey -- '''[ osisRef ]'''		DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''[ osisRef ]'''

	'''-d 256'''<br/>		'''-d 256'''<br/>
	Osis2mod contains two stacks to validate proper nesting of BSP and BCV, respectively. This is an internal representation of the BCV stacks. It provides additional information to understand the diagnostic nesting messages.		Osis2mod contains two stacks to validate proper nesting of BSP and BCV, respectively. This is an internal representation of the BCV stacks. It provides additional information to understand the diagnostic nesting messages.
	DEBUG(STACK): '''[ currentOsisID ]''': push ('''[ stack size]''') '''[ tokenName ]'''		DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': push ('''[ stack size]''') '''[ tokenName ]'''
	DEBUG(STACK): '''[ currentOsisID ]''': pop('''[ tagDepth ]''') '''[ topToken.getName() ]'''		DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': pop('''[ tagDepth ]''') '''[ topToken.getName() ]'''

	'''-d 512'''<br/>		'''-d 512'''<br/>
	These are general debug messages.		These are general debug messages.
	DEBUG(FOUND): Found first div and pitching prior material: '''[ text ]'''		DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''[ text ]'''
	DEBUG(FOUND): New book is '''[ currentOsisID ]'''		DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New book is '''[ currentOsisID ]'''
	DEBUG(FOUND): Current chapter is '''[ currentOsisID ]''' ('''[ osisID attribute value ]''')		DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''[ currentOsisID ]''' ('''[ osisID attribute value ]''')
	DEBUG(FOUND): Entering verse		DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
	DEBUG(FOUND): New current verse is '''[ currentOsisID ]'''		DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse is '''[ currentOsisID ]'''
	DEBUG(FOUND): osisID/annotateRef is adjusted to: '''[ simpler osisID or osisRef ]'''		DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): osisID/annotateRef is adjusted to: '''[ simpler osisID or osisRef ]'''
	DEBUG(COMMENTS): in comment		DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
	DEBUG(COMMENTS): out of comment		DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment

	'''-d 512'''<br/>		'''-d 512'''<br/>