VCOO0028

OmniOutliner: Draft Markers

A set of commands for marking and unmarking rows as being in “DRAFT” mode.

Scope and Syntax

Language: English (United States 🇺🇸 · Great Britain 🇬🇧 · Australia 🇦🇺 · Canada 🇨🇦)

Scope: OmniOutliner

Command phrase variations (words in [brackets] are optional):

• “Mark as Draft”
• “Clear Draft Markers”
• “Clear All Draft Markers”

Requirements

• Application: OmniOutliner: 5.10 (macOS), OmniOutliner 3.9.1 (iOS/iPadOS)
• System: macOS 12, iOS 15, iPadOS 15

Video: “Draft” Markers

A set of commands for marking and unmarking rows as being in “DRAFT” mode.

PLAY (E) PAUSE BACK REWIND

Downloads

• ⇩ COMMANDS-FILE (OmniOutliner 5) (macOS)
• ⇩ SHORTCUT-LINK (“Mark as Draft”) (iOS/iPadOS)
• ⇩ SHORTCUT-LINK (“Clear Draft Markers”) (iOS/iPadOS)
• ⇩ SHORTCUT-LINK (“Clear All Draft Markers”) (iOS/iPadOS)

Script Code

Here is the script code for the commands.

Mark Selected Rows as “Draft”
Copy
(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()

		var markColor = Color.red
		var editor = document.editors[0]
		var tree = document.outline
		var selectedItems = editor.selection.items
		if(selectedItems.length > 0){
			// style name and insert string
			var styleTitle = 'DRAFT INDICATOR'
			var insertString = 'DRAFT: '
			// get the titles of the existing named styles
			nStyles = tree.namedStyles.all
			titles = nStyles.map(nStyle => nStyle.name)
			// create a named style if it doesn't exist
			if (titles.indexOf(styleTitle) === -1){
				nStyle = tree.namedStyles.add(styleTitle)
				nStyle.set(Style.Attribute.FontFamily, 'Helvetica')
				nStyle.set(Style.Attribute.FontName, 'Helvetica Bold')
				nStyle.set(Style.Attribute.FontWeight, 9)
				nStyle.set(Style.Attribute.FontFillColor, markColor)
				nStyle.set(Style.Attribute.FontStrokeColor, markColor)
			}
		
			// get a reference to the target style
			targetStyle = tree.namedStyles.byName(styleTitle)
			// create a new text object using the insert string
			textInsert = new Text(insertString, tree.baseStyle);
			// apply the special style to the new text object
			textInsert.style.addNamedStyle(targetStyle);

			// insert the new text object into the start of the target text object
			var counter = 0
			selectedItems.forEach(item => {
				targetTextObj = item.valueForColumn(tree.outlineColumn)
				textObjChars = targetTextObj.ranges(TextComponent.Characters)
				textStr = targetTextObj.string
				if (textStr !== '' && textStr.startsWith(insertString) === false){
					targetTextObj.insert(textObjChars[0].start, textInsert)
					counter = counter + 1
				}
			})
			
			noOrCount = (counter === 0) ? "No":String(counter)
			rowOrRows = (counter === 1) ? "row":"rows"
			utterance = createUtterance(`${noOrCount} ${rowOrRows} marked`)
			synthesizer.speakUtterance(utterance)
		} else {
			throw {
				name: "Selection Issue",
				message: "Please select one or more rows to mark."
			}
		}
	}
	catch(err){
		utterance = createUtterance(err.message)
		synthesizer.speakUtterance(utterance)
		//new Alert(err.name, err.message).show()	
	}
})();

Remove “Draft” Markers from Selected Rows
Copy

(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()
		
		var editor = document.editors[0]
		var tree = document.outline
		var selectedItems = editor.selection.items
		var counter = 0
		if(selectedItems.length > 0){
			var stringToRemove = 'DRAFT: '
			var searchParams = [Text.FindOption.Anchored, Text.FindOption.CaseInsensitive]
			selectedItems.forEach(item => {
				textObj = item.valueForColumn(tree.outlineColumn)
				matchingRange = textObj.find(stringToRemove, searchParams)
				if (matchingRange !== null){
					textObj.remove(matchingRange)
					counter = counter + 1
				}
			})
			
			noOrCount = (counter === 0) ? "No":String(counter)
			rowOrRows = (counter === 1) ? "row":"rows"
			utterance = createUtterance(`${noOrCount} ${rowOrRows} unmarked`)
			synthesizer.speakUtterance(utterance)
		} else {
			throw {
				name: "Selection Issue",
				message: "Please select one or more rows to unmark."
			}
		}
	}
	catch(err){
		utterance = createUtterance(err.message)
		synthesizer.speakUtterance(utterance)
		//new Alert(err.name, err.message).show()	
	}
})();

Remove All “Draft” Markers
Copy

(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()

		var tree = document.outline
		var stringToRemove = 'DRAFT: '
		var searchParams = [Text.FindOption.Anchored, Text.FindOption.CaseInsensitive]
		var counter = 0
		document.editors[0].rootNode.apply(node => {
			if (node.isRootNode === false){
				textObj = node.valueForColumn(tree.outlineColumn)
				matchingRange = textObj.find(stringToRemove, searchParams)
				if (matchingRange != null){
					textObj.remove(matchingRange)
					counter = counter + 1
				}
			}
		})
	
		noOrCount = (counter === 0) ? "No":String(counter)
		rowOrRows = (counter === 1) ? "row":"rows"
		utterance = createUtterance(`${noOrCount} ${rowOrRows} unmarked`)
		synthesizer.speakUtterance(utterance)
	}
	catch(err){
		utterance = createUtterance(err.message)
		synthesizer.speakUtterance(utterance)
		//new Alert(err.name, err.message).show()	
	}
})();