Bike
Search…
Creating Scripts
Create scripts to automate Bike and integrate with other apps. If you are just interested to run a script that someone else has written please see the Using Scripts section.
Overview
When scripting Bike you are dealing with
documents, windows, and rows. Documents and windows are common scripting objects with a few Bike extensions–rows are specific to Bike.Each row represents a row in your outline. Rows have a
name for accessing the row's text. Rows also have an id and other attributes. Rows can contain other rows. When you move or delete a row those contained rows are moved or deleted with it.You gain access to rows in a few ways:
- 1.From properties of a document such as
root row,selected row,focused row. - 2.From the
rowscollection belonging to each document. This collection contains all rows in the document (except for the root). This collection is a good place to quickly find existing rows. - 3.From the
rowscollection belonging to eachrow.This collection contains only the rows that are directly contained by the row (the children). This collection is a good place for making new rows and to use as a target to moving existing rows into.
Dictionary
Use Bike's scripting dictionary to learn what parts of Bike are scriptable.
To open Bike's scripting dictionary:
- Drag and drop Bike onto Script Editor's application icon.
- Or from Script Editor use File > Open Dictionary and choose Bike's dictionary.
Getting Started
Here's the official starting point for learning AppleScript:
The starting point for lesser people, such as myself, is to find example scripts and then randomly change them until they do what you want. I've included some for you below. You can also find scripts in the Bike user form and ask scripting questions.
Example scripts
You'll get the most out of these scripts by using Script Debugger instead of Script Editor that comes with your Mac. Among other things Script Debugger allows you to step through the script line by line so you can see the effect of each command on you document.
Kitchen Sink
This is a nonsense script that demonstrates many of Bike's scripting abilities. It's a good place to learn how basic things are done like making and moving rows.
1
tell application "Bike"
2
3
-- This script makes a new demo document so that it won't mess up any documents that you have open.
4
set demo to make document with properties {name:"Demo"}
5
6
tell demo
7
-- Bike shows welcome text in new documents, this line deletes that text
8
delete every row
9
10
-- Create a new "Hello World" row
11
set helloWorld to make row with properties {name:"Hello World"}
12
13
-- Add some child rows to "Hello World"
14
tell helloWorld
15
make row with properties {name:"one"}
16
make row with properties {name:"two"}
17
end tell
18
19
-- Insert a new child in into the middle
20
tell helloWorld
21
make row at (after row named "one") with properties {name:"middle child"}
22
23
-- Make a row "at" another row will at it as a child.
24
make row at row 2 with properties {name:"middle child child"}
25
end tell
26
27
-- You can also just make an empty row
28
make row
29
30
-- Or you can make a row with an id, so its easy to find later, even if it's name has been edited.
31
-- If the given id is already in use then the row will still be made, but will get assigned a different id.
32
make row with properties {id:"boom", name:"My id is boom"}
33
34
-- Change the name of an existing row
35
set name of row id "boom" to "You've been renamed"
36
37
-- Check to see if a row exists
38
if exists row id "boom" then
39
log "Yes! row id boom exists"
40
end if
41
42
-- When "Hello World" moves it brings all containing rows with it.
43
move row named "Hello World" to row id "boom"
44
move row named "one" to before row named "two"
45
46
collapse row named "Hello World" with all
47
expand row named "Hello World"
48
select at row id "boom"
49
50
-- Now just show "Hello World" and contained rows
51
set focused row to row named "Hello World"
52
53
-- Now just show rows contained by "Hello World"
54
set hoisted row to row named "Hello World"
55
end tell
56
57
-- Make another document
58
tell (make document with properties {name:"Move to"})
59
-- delete welcome text again
60
delete every row
61
62
-- Move row from our original document to this new document
63
move row named "middle child" of demo to first row
64
65
-- Can also just copy rows to new document
66
duplicate row named "one" of demo to end of rows
67
end tell
68
69
end tell
Copied!
Home Script
This script resets your view state to "Home"
1
tell front document of application "Bike"
2
set hoisted row to root row
3
if exists first row then
4
select at first row
5
end if
6
end tell
Copied!
Cleanup Script
This script saves the current selected row. Collapses all rows. Then restores your selection, which also expands any rows needed to show the selection. Use it to cleanup when you have to many rows expanded, but you still want to keep working where you are.
1
tell front document of application "Bike"
2
set saved to selection row
3
collapse root row with all
4
select at saved
5
end tell
Copied!
Today Script
This script create a simple calendar structure in your outline and adds a new line to "today" where you can start taking notes. It's interesting because it uses row
id's to track rows. Once the calendar is created you can move it to any place in your outline and the script will keep working.1
set yearName to do shell script "date +'%Y'"
2
set yearId to do shell script "date +'%Y'" & "/00/00"
3
set monthName to do shell script "date +'%B, %Y'"
4
set monthId to do shell script "date +'%Y/%m'" & "/00"
5
set dayName to do shell script "date +'%B %d, %Y'"
6
set dayId to do shell script "date +'%Y/%m/%d'"
7
​
8
tell application "Bike"
9
tell front document
10
set y to my getOrMake(yearId, yearName, root row)
11
set m to my getOrMake(monthId, monthName, y)
12
set d to my getOrMake(dayId, dayName, m)
13
select at make row at front of rows of d
14
end tell
15
end tell
16
​
17
to getOrMake(getId, getName, rowContainer)
18
using terms from application "Bike"
19
tell container document of rowContainer
20
if exists row id getId then
21
return row id getId
22
else
23
tell rowContainer
24
return make row at front with properties {id:getId, name:getName}
25
end tell
26
end if
27
end tell
28
end using terms from
29
end getOrMake
Copied!
Last modified 13d ago
Copy link
Edit on GitHub