Notebooks URL Schemes
Notebooks supports a set of so called URL schemes, which basically are URLs that allow other apps to communicate with Notebooks.
Open a Specific Document
This URL opens Notebooks and displays the referenced document; it is the format that Notebooks uses for its internal links.
The path must be URL-escaped and is relative to Notebooks‘ root.
Add Text as New Document
notebooks://addnote/note%20body&title=Title%20of%20document&parent=path/to/parent notebooks://addnote/note%20body&title=title%20of%20document notebooks://addnote/note%20body
When a parent parameter is given, Notebooks adds a new document to the given parent book. Without parent, this scheme adds a new document to Notebooks‘ top level. When used without title, Notebooks uses the “first line” of the body as title. – This is a convenient option for other apps to send a document directly to Notebooks.
Append Text to an Existing Document
With this scheme you can append the given text to a document at the given path. Notebooks assumes that the document exists and handles it as plain text (Markdown works as well).
Add a New Default Document
Open Notebooks and present a new, empty document, ready to add text. When a valid parent is given, the new document is created in that book, otherwise it appears at Notebooks‘ top level.
Add a New Task
Create a new, empty task. When a valid parent path is given, the task is created in that book (Notebooks does not check if that book in fact is a task list), otherwise Notebooks uses the defines default Inbox (defined in Notebooks‘ settings). If no default in box is set, Notebooks shows an alert.
Search for a Given Term
Open Notebooks and trigger a search for the given term; you can optionally add the path to a book to restrict the search scope to the contents of that book.
Import from a URL
notebooks://grab/URL&title=Title%20of%20document&parent=Path%20to%20target%20book notebooks://grab/URL&title=Title%20of%20document notebooks://grab/URL
With this scheme you tell Notebooks to import the document at the given URL, which basically is what the Notebooks bookmarklet does. You can optionally assign a title and specify where the document should be stored in Notebooks.
Notebooks for Mac/PC currently supports the
grab schemes, but others will follow. You need to take special care of the relative document path, which in this case it taken relative to Notebooks‘ root directory.