The Basics

Creating New Pages

Tap the New button at the top of the screen and choose Page. To change the name of your new page tap the page name and enter a new name. When the page is saved the name will be transformed into a valid WikiWord.

Alternatively putting a WikiWord into a page and then tapping it will create a new page - assuming no page already has that WikiWord as a name.

You cannot create or edit pages which start with Docs:, Special: or New:. Page titles must also not contain any of the following characters ‘/’, ‘\’ or ‘;’.

Finding Pages

Tap in the search bar and start typing. Trunk Notes will find pages with a matching name. If you want to search each page’s text tap on the “Search for” option. When searching a page’s text large back and forwards icons will be displayed on the screen allowing you to skip through the page for each match.

You can display the names of all your pages by tapping the __Pages button on the toolbar at the bottom of your screen. The buttons at the bottom of the screen will allow you to show pages organised alphabetically, by most recently edited and by popularity.

A history is kept of the pages you visit. Use the back and forwards buttons on the toolbar to navigate the history. Tapping the Home button will return you to your home page. You can change the name of your home page using the Settings app.

Editing Pages

Tap edit to modify a page.

The toolbar at the bottom of the screen allows you to create headings, bulleted and numbered lists. Tap a button to set the formatting for the current line.

The other buttons on the edit toolbar are,

  • Actions - clear the text in the current page, insert a link to another page or insert an image, timestamp or sound recording. If you choose an image/sound recording then the image/sound recording will be embedded into the page.
  • Tag - this will allow you to tag the current page.
  • Delete - this will delete the page.

To change the format of the timestamp use the Settings app.

The following keyboard shortcuts are available whilst editing:

  • CMD + B (Bold)
  • CMD + I (Italics)
  • CMD + L (Link)
  • CMD + T (Strikethrough)
  • CMD + S (Save)
  • CMD + 1 (Heading)
  • CMD + 2 (Bulleted list)
  • CMD + 3 (Numbered list)
  • CMD + D (Insert timestamp)

Images

Trunk Notes can store images taken with your camera or from your photo library.

To create a new image entry,

  • Tap New…
  • Choose either Image From Library or Image From Camera (if a camera is available on your device)
  • Select the image from your library, or take a picture

If you want to insert an image directly into the page you are editing,

  • Tap the action button
  • Choose Insert…
  • Select Image From Library or Image From Camera
  • Choose or take the picture. A new page will be created to store the image and a link to the image inserted at the cursor. Note that if you revert the changes, or delete the link to the image the image will still exist in Trunk Notes.

Trunk Notes will create a new page containing your picture. You can edit the page to associate text and add tags. You can include images in other pages. For example - /{{image File:cat.png}} will include the image with the name File:cat.png. You can leave out the File: if you wish.

Images can be searched for in exactly the same way as text pages. Please note that in the current version of Trunk Notes images are not included in your backups.

Sound

You can create Sound Recordings in Trunk Notes.

  • Tap New…
  • Choose Sound Recording
  • When you are ready tap the Start Recording button
  • When you have finished tap Save Recording (to discard just tap Cancel)

As with images you can easily add text to your new Sound Recording page or tag the entry.

You can insert a Sound Recording directly into another page in a similar way to images.

Sound Recordings are not currently included in Trunk Notes backups.

Renaming a Page

To rename a page click Edit. Tap in the bar at the top containing the page name. Change the name of the page. Now click Save.

Formatting Pages

There are three buttons in edit mode to help you format your pages,

  • Heading - tap on this to turn the current line into a heading. There are three levels of heading. In edit mode a line which is a heading will start with one, two or three hashes (#)
  • Bullet - tap on this to toggle a bullet point for the current line
  • Numbered list - tap on this to toggle a numbered list item for the current line. Even though Trunk Notes always puts “1. ” at the start of the line, when you save the page Trunk Notes will number the lines properly

If you want to make some text bold, italic or strike-through select it, then choose More… from the pop up menu. Tapping Bold, Italic or Strike will add that formatting to the selected text.

Trunk Notes uses a formatting system called Markdown. See the Docs:MarkdownSyntax for more information. You can also use most HTML tags in your pages - however Markdown is much simpler.

Organising Your Pages

Organise your information the best way for you. Link pages together using WikiWord’s. A WikiWord is two or more words written as one word with each word starting with a capital.

When you see a WikiWord tap on it to go to the page, or create a page with that name.

Web links are opened by Safari.

Tags

Trunk Notes allows you to add tags to pages. Tags can be used to help organize lots of pages. For example you might tag the pages SpagBol and WinterSoup with the tag Recipe. The pages Groceries, BooksToRead and DvdsToBuy could be tagged with Shopping.

To get a list of all the pages with a particular tag simply tap in the search bar and select the tag or start typing to filter the list of tags.

You can add as many tags to a page as you like. To tag a page start editing the page then tap the Tag button on the toolbar. You can then assign an existing tag or create a new tag.

Tags are included in backups of your wiki entries.

Geotagging

If Trunk Notes has been able to get a fix on your position then newly created pages will have your current location added to the metadata.

To see where a page was created tap on the icon in the pages status bar (where the last updated time is displayed at the top of the page.) If you don’t see an icon then the page does not have a geotag.

You can update a pages geotag by selecting ‘Update Location’ from the action toolbar button when in edit mode.

Duplicating Notes

If you wish to copy a note, tap New then Copy Of This Page. You will need to give the new page a name.

You may decide to create some pages to use as templates. Duplicate the template and fill it in.

Wi-Fi Sharing

You can view, edit and search for pages on your computer using a web browser (e.g. Internet Explorer, Mozilla Firefox, Opera or Safari). Just make sure your iOS device is connected to your local Wi-Fi network.

When viewing a page tap on the toolbar button situated at the bottom right of your screen and choose Wi-fi Sharing. You will be told the address to enter into your web browser’s address bar. For example, http://192.168.1.50:10000.

If you have turned on authentication you will be prompted for a username and password. These can be changed in the Settings application.

You can now view and edit pages using your web browser. Remember that your iOS device will fall asleep after a few minutes (if not attached to your computer) so if you find you lose the connection to Trunk Notes, just wake up your device.

Mailing notes and backups

You can mail a copy of a page. First tap on the button at the bottom right hand corner of the screen. Choose Mail…. You will now be given the change to mail a copy of the note fully formatted, mail a copy of the note in Markdown or mail a zipped backup of your entire wiki.

Please note that it may take Trunk a while to prepare the zipped backup. This depends on the size of your wiki.

Snippets

Wikipedia defines a snippet as a “small region of re-usable … text”. Basically a snippet is a small piece of text which you want to insert into other notes. It might be your sign off used when writing a letter, for example “Best wishes, Matthew”. Instead of typing the text in every time you want it to appear you type in a shortcut.

Unless you have changed the default snippet settings all snippets in Trunk Notes have names starting with Snippet:. The snippets are just normal wiki pages. If you want to use a snippet you just type the snippets name (without the Snippet: prefix) followed by a series of characters which execute the snippet.

Here is an example,

  1. You create a new page called Snippet:letter
  2. The text in Snippet:letter is,

Dear **,

Best wishes,

Matthew.

  1. You now create a new page. You start the page by typing letterxx. Trunk Notes will replace this with the contents of the wiki page Snippet:letter. The cursor will be positioned where the ** is (just after the Dear and before the ,)

As you can see snippets can be very useful and you can create as many as you need. If you create useful collections of snippets ZIP them using Trunk Notess backup feature and post them on the Apps On The Move forum.

You may wish to use snippets to insert timestamps or otherwise evaluate a Trunk Notes function. Simply add !! to the start of the snippet text and Trunk Notes will evaluate any functions in the snippet before substituting the text. For example,

!!{{timestamp}}

will create a snippet which when executed will insert a timestamp as text, rather than inserting /{{timestamp}}.

Functions

Functions are great for the more advanced Trunk Notes user. A function is a small piece of text which gets expanded by Trunk Notes every time you view the page. For example, /{{tagged Recipes}} will be expanded to show you a list of all the pages which have the recipe tag.

See [[Docs:Functions]] for details on the functions which Trunk Notes supports.

Note that the arguments to the functions (e.g. the name of a tag) are case sensitive. So /{{tagged urgent}} and /{{tagged Urgent}} refer to different tags.

Lua scripting

Trunk Notes has a built in scripting language for writing your own functions. See [[Docs:LuaScripting]] for more details.

Header and Footer

If you wish to have all your pages displayed with a particular header or footer you can set this up by editing the pages Special:Header and Special:Footer. Any text in these will be included in all pages when they are displayed. Useful text might include a list of your top five pages for quick reference, or a list of backlinks to pages which link to the displayed page (i.e., add /{{backlinks}} to Special:Footer)

Settings

To modify the Trunk Notes settings you need to use the Settings app on your iOS device. Exit Trunk Notes and return to the list of apps. Open the app Settings and scroll down until you find Trunk Notes. Tap Trunk Notes to see the settings.

There are a number of Trunk Notes settings,

  • Capitalize Wiki Words - turn this off if you don’t want Trunk Notes to automatically capitalize wiki words (for example Japanese users).
  • Easy Line Break - this is on by default and it allows you to press enter to create a line break. If turned off you need to put two spaces at the end a line for a line break.
  • Home page on start - forget the last page you were looking at when you exited Trunk Notes. When you start Trunk Notes you will always be sent to your home page if this is turned on. Trunk Notes will also forget your history between sessions if this is turned on.
  • Home page - the name given to your home page. The default is HomePage. Trunk Notes will revert to HomePage if a valid WikiWord cannot be constructed from this value.
  • Timestamp - the format of the date and/or time to insert when using the action button in edit mode. You can select either US or European format, and have just the date or the date and time.
  • Default Email - when mailing a page or a backup the email address specified here will be automatically used for the recipient.
  • Geotag Wiki Entries - whether Trunk Notes should try adding your current location to new wiki entries.
  • Custom stylesheet - if turned on a page called Special:SetStyleSheet will be created. Edit this to change how your wiki pages look on your iOS device. This stylesheet does not affect the web interface. Turn this to off to revert to the default stylesheet.
  • Data Detectors - if turned off then items, such as phone numbers, will not be automatically turned into links.
  • Snippet prefix - all snippets will be in wiki entries starting with this prefix. The default is Snippet:. You can make this blank if you want all wiki entries to be considered snippets.
  • Snippet execute - this is the combination of letters you need to type to execute a snippet. The default is xx. You can make this blank if you want snippets to be inserted as soon as their name is typed.
  • TextExpander Support - Trunk Notes includes support for TextExpander snippets in addition to Trunk Notes snippets. This option will only have an affect if TextExpander is installed on your iOS device.
  • Authentication - it is recommended to keep on authentication. This stops other users accessing your Trunk Notes pages when Wi-Fi Sharing is enabled.
  • Username/Password - used if authentication is turned on for Wi-Fi Sharing. The defaults are Trunk Notes and password. It is recommended that you change these.
  • Don’t Fall Asleep - turn this on if you want to put your device into Wi-Fi Sharing mode and have the device stay awake. If this is turned on you may find that your iOS device falls asleep after a few minutes.
  • Strip file extenstions - when uploading a ZIP of pages any three letter extensions on pages will be stripped (e.g. note.txt will be given the name Note).
  • Windows friendly - backups of pages will use Windows line terminators. This will allow you to use Notepad and other basic text editors with the Trunk Notes backup.
  • Dropbox Path - the path on Dropbox which will store your wiki. This is only used if you choose to use the Dropbox Sync feature of Trunk Notes.
  • Lua Scripting - if set to NO then Lua scripts will not run. This can be useful if you have a very broken Lua scripting in your header.

Creating a backup

Trunk Notes allows you to create a backup of all your wiki pages. This is achieved by clicking the Backup button in the Wi-Fi Sharing web interface. The default filename for the backup will include today’s date so you can easily manage multiple backups.

A Trunk Notes backup is a ZIP file of all your pages. The pages can be edited using a standard text editor. The first few lines of each file contain some information about the entry,

  • The full title of the entry. The Trunk Notes filename has punctuation removed and a unique id appended.
  • Timestamp. This is when the entry was last updated.
  • Last Accessed. When the entry was last looked at.
  • Times Accessed. How many times the entry has been viewed.

Using the Upload button in the web interface you can,

  • Restore a Trunk Notes backup.
  • Upload a ZIP of text files.

If you upload a ZIP of text files make sure that the files use UTF8 encoding. If Trunk Notes cannot interpret a file using UTF8 then the file will be ignored.

Although there is no inherent limit on the size of files which can be uploaded, or the size of the text files, remember that your iOS device is not a desktop computer.

Dropbox Sync

Trunk Notes has the ability to sync your wiki to Dropbox. For this to work you must have created a Dropbox account.

Each page in your wiki will be represented by a single text file. Images and sound recordings will be uploaded also.

You can use this feature to keep your wiki in sync between multiple iOS devices. If you sync a new device to an existing wiki on Dropbox then pages from Dropbox will overwrite any pages with the same name on the device.

You can choose where the wiki is stored on Dropbox by changing the path in the Settings app. Inside the folder you choose there will be created the folders pages and files. Each wiki entry will have a text file in the pages folder. Any images or sounds will be uploaded to the files folder.

Trunk Notes uses the timestamps of files to help it work out what to sync. If the last modified timestamp of a file on Dropbox changes and is more recent that when it was last synced Trunk Notes will assume it has been updated.

As well as editing pages in Trunk Notes on your device you can edit the text files on Dropbox directly using another app or on your computer. Any changes you make will be synced back to your device. Trunk Notes adds a .markdown extension to synced files, however it will recognise files with .mkd, .md and .txt extensions.

To sync your wiki to Dropbox tap the action button when viewing a page and select Dropbox Sync… The first time you do this on a device you will need to log in to Dropbox. If you don’t wish to keep your Dropbox credentials on the device you can choose to log out after syncing your wiki.

Trunk Notes will identify when a page has been updated on your mobile device AND on Dropbox. If it detects this conflict then you must choose which version you wish to keep. You can at this point choose to cancel the sync operation.

If you have a large wiki and are syncing for the first time it may take a long time to initially sync your wiki to Dropbox. Large images and sound recordings can take a while to upload.

A full log of what Trunk Notes is doing is displayed whilst syncing so you can be sure what has been uploaded and downloaded from Dropbox.

NOTE: It is very important that the time on your device is set correctly if using the Dropbox sync feature. If the time is incorrect the sync algorithm may make the wrong choices when deciding what is new or updated.

iTunes File Sharing

In addition to text, images and sounds you can store other types of document in Trunk Notes. At the moment there is support for PDF documents. To add a PDF document to Trunk Notes connect your iOS device to your computer and use the iTunes File Sharing interface to add files.

Trunk Notes will create a page for each document added. For example if you added MeetingSchedule2011.pdf then a page File:MeetingSchedule2011.pdf will have been added.

When viewing a PDF you will be first shown a thumbnail of the first page. To view the individual pages in the PDF tap the thumbnail.

Encryption

Trunk Notes supports AES–256 encryption. You can encrypt pages you wish to keep private. In order to view these pages a password must be entered.

To encrypt a page,

  • Edit the page
  • Tap the action button on the toolbar
  • Choose Encrypt

When using encryption for the first time you will be asked to choose a password. The longer the password the more secure your pages will be. This password is independent of your iOS unlock password, and the Trunk Notes Wi-Fi Share password.

If you decide a page doesn’t need to be encrypted simply edit the page, tap the action button and choose Decrypt.

To change the password used for encryption go to the page [[Special:Encrypt]]. This also allows you to lock encrypted pages without restarting Trunk Notes. [[Special:Encrypt]] will not exist until you use encryption for the first time. You can also access [[Special:Encrypt]] by tapping the padlock, in the wiki entry status bar, on any unlocked encrypted page.

If you wish to view encrypted pages in Wi-Fi Share mode you must have entered the password on your mobile device first. Remember that all data sent from Trunk Notes to your web browser is in plaintext.

When you take a backup of encrypted pages the page will be backed up in its encrypted state. If you wish to restore encrypted pages to a device you must ensure that the page [[Special:Encrypt]] is also restored. If Trunk Notes cannot decrypt this page then it will not decrypt any other pages. Trunk Notes can only contains pages encrypted with the same passphrase.

When your mobile device goes to sleep the password will be forgotten. If you were editing a page the page’s text will remain editable when the device is resumed.

If you exit Trunk Notes whilst editing an encrypted page it will be saved automatically for you. If the page’s name on exit was not valid a name will be automatically assigned to the page.

If you forget the password you chose to encrypt pages you will not be able to retrieve the pages.

Only a pages content is encrypted. The metadata is not (i.e. GPS location, name, last updated, tags) nor are images or sounds. You cannot perform fulltext searches on an encrypted page. Some Trunk Notes functions do not work with encrypted pages - for example /{{action}}.

Custom stylesheet

If you wish to change the fonts, background colors, etc of your wiki entries you can define your own custom stylesheet. A custom stylesheet is written using CSS.

To start turn on ‘Custom stylesheet’ in the Settings application.

Navigate to the page called Special:SetStyleSheet. Editing this page will update the stylesheet used to display your wiki pages on your iOS device.

Example

If you would like the font size of the body text to be larger change the font-size attribute.

body {
    font: medium "Arial";
    font-size: large;
    background-color: #FFFFFF;
    margin: 0;
}
  • h1, h2 and h3 change the style of the headings.
  • info modifies the bar at the top of each page with the time and date the page was last changed.
  • highlight changes how search terms are highlighted.
  • contents defines the main part of the wiki page (everything except the info bar.)

Tag Specific CSS

If a wiki entry has been tagged you can use the tags to further customise how the entry is displayed. For example if the page SummerPasta has the tags Recipe and Italian then the CSS classes tag-recipe and tag-italian can be used to change the styling for that page.

The Badge

The app icon for Trunk Notes can optionally display a badge. A badge displays a number allowing you to tell something about Trunk Notes from the app chooser.

When Trunk Notes exits it counts all of the bullet points in the page [[Special:Badge]] and displays that number as the badge.

By default the page [[Special:Badge]] will list all of the pages tagged with ToDo. This means that Trunk Notes will tell you how many ToDo items you have left.

Change [[Special:Badge]] to customise how Trunk Notes calculates the number for the badge.

Documentation and Special pages

Trunk Notes defines a number of default pages. The following documentation pages are available:

  • Docs:Help
  • Docs:GettingStarted
  • Docs:Manual
  • Docs:Functions
  • Docs:MarkdownSyntax
  • Docs:AdvancedFormatting
  • Docs:AboutTrunk

There are also some special pages, some of which can be edited to customise Trunk Notes:

  • Special:Badge - any list items are counted and applied as the Trunk Notes app badge count
  • Special:Header - any content is included at the top of every page
  • Special:Footer - any content is included at the bottom of every pages
  • Special:DropboxSync - used to keep track of Dropbox synchronisation
  • Special:SetStyleSheet - applied as a custom stylesheet on the iOS device
  • Special:Debug - may contain useful information if you have a bug to report to Apps On The Move

Launching Trunk Notes from other apps

You can go directly to any page from another app using the wiki:// or tn:// protocol.

For example if you write tn:///MyProject in OmniFocus then Trunk Notes will be opened and show you the MyProject page.