VCOO0034

OmniOutliner: Jump Links

A set of commands for appending and removing jump links to/from row notes. A jump link is a link to another row.

Scope and Syntax

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

Scope: OmniOutliner

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

• “Add Jump Links”
• “Clear Jump Links”
• “Clear All Jump Links”

Requirements

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

Video: Jump Links

A set of commands for appending and removing jump links to/from row notes.

PLAY (E) PAUSE BACK REWIND

Video: Jump Links

A set of commands for appending and removing jump links to/from row notes.

PLAY (E) PAUSE BACK REWIND

Downloads

• ⇩ COMMANDS-FILE (OmniOutliner 5) (macOS)
• ⇩ SHORTCUT-LINK (“Add Jump Links”) (iOS/iPadOS)
• ⇩ SHORTCUT-LINK (“Clear Jump Links”) (iOS/iPadOS)
• ⇩ SHORTCUT-LINK (“Clear All Jump Links”) (iOS/iPadOS)

Script Code

Here is the script code:

To add a pair of jump links, select two rows and run the command:

Add Jump Links
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()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource", message:"No outline document is open."}
		}

		var editor = document.editors[0]
		selectedItems = editor.selection.items
		if(selectedItems.length === 2){

			rowA = selectedItems[0]
			rowB = selectedItems[1]
			
			rowATitle = rowA.topic
			rowBTitle = rowB.topic
									
			rowALink = `omnioutliner:///open?row=${rowA.identifier}`
			rowAurl = URL.fromString(rowALink)
			rowBLink = `omnioutliner:///open?row=${rowB.identifier}`
			rowBurl = URL.fromString(rowBLink)
			
			var rowAnote = rowA.valueForColumn(document.outline.noteColumn)
			if (rowAnote === null) {
				rowAnote = new Text("", document.outline.noteColumn.style);
			}
			var newLineObj = new Text("\n", rowAnote.style)
			if(rowAnote.string.length > 0){rowAnote.append(newLineObj)}
			
			Alink = new Text("*️⃣", rowAnote.style)
			style = Alink.styleForRange(Alink.range)
			style.set(Style.Attribute.Link, rowBurl)
			style.set(Style.Attribute.UnderlineStyle, UnderlineStyle.None)
			rowAnote.append(Alink)
			rowA.setValueForColumn(rowAnote, document.outline.noteColumn)
			node = editor.nodeForObject(rowA)
			node.expandNote()
			
			var rowBnote = rowB.valueForColumn(document.outline.noteColumn)
			if (rowBnote === null) {
				rowBnote = new Text("", document.outline.noteColumn.style);
			}
			//newLineObj = new Text("\n", rowBnote.style)
			if(rowBnote.string.length > 0){rowBnote.append(newLineObj)}
			
			Blink = new Text("*️⃣", rowBnote.style)
			style = Blink.styleForRange(Blink.range)
			style.set(Style.Attribute.Link, rowAurl)
			style.set(Style.Attribute.UnderlineStyle, UnderlineStyle.None)

			rowBnote.append(Blink)
			rowB.setValueForColumn(rowBnote, document.outline.noteColumn)
			node = editor.nodeForObject(rowB)
			node.expandNote()
			
			utterance = createUtterance("Rows linked!")
			synthesizer.speakUtterance(utterance)
		} else {
			throw {
				name: "Selection Issue",
				message: "Please select the two rows to be linked."
			}
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

To remove a pair of jump links, select the two rows to be unlinked and run the command.

Remove Jump Links
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()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource", message:"No outline document is open."}
		}

		var editor = document.editors[0]
		var tree = document.outline
		selectedItems = editor.selection.items
		if(selectedItems.length === 2){

			var stringToRemove = "*️⃣"
			var searchParams = [Text.FindOption.CaseInsensitive]
			var counter = 0
			selectedItems.forEach(item => {
				textObj = item.valueForColumn(tree.noteColumn)
				if(textObj){
					matchingRange = textObj.find(stringToRemove, searchParams)
					if(matchingRange !== null){
						textObj.remove(matchingRange)
						counter = counter + 1
					}
				}
			})
			
			noOrCount = (counter === 0) ? "No":String(counter)
			rowOrRows = (counter === 1) ? "rows":"rows"
			wasOrWere = (counter === 1) ? "was":"were"
			response = `${noOrCount} ${rowOrRows} ${wasOrWere} unlinked.`
			utterance = createUtterance(response)
			synthesizer.speakUtterance(utterance)
		} else {
			throw {
				name: "Selection Issue",
				message: "Please select the two rows to be unlinked."
			}
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}
	}
})();

To remove all jump links in the outline, run the command.

Remove All Jump Links
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()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource", message:"No outline document is open."}
		}

		var editor = document.editors[0]
		var tree = document.outline
		var allItems = document.outline.rootItem.descendants
		if(allItems.length === 0){
			throw {
				name: "Selection Issue",
				message: "This document has no rows."
			}
		} else {
			var stringToRemove = "*️⃣"
			var searchParams = [Text.FindOption.CaseInsensitive]
			var counter = 0
			allItems.forEach(item => {
				textObj = item.valueForColumn(tree.noteColumn)
				if(textObj){
					matchingRange = textObj.find(stringToRemove, searchParams)
					if(matchingRange !== null){
						textObj.remove(matchingRange)
						counter = counter + 1
					}
				}
			})
			
			noOrCount = (counter === 0) ? "No":String(counter)
			rowOrRows = (counter === 1) ? "rows":"rows"
			wasOrWere = (counter === 1) ? "was":"were"
			response = `${noOrCount} ${rowOrRows} ${wasOrWere} unlinked.`
			utterance = createUtterance(response)
			synthesizer.speakUtterance(utterance)
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			new Alert(err.name, err.message).show()
		}	
	}
})();