How is "Detect Wiki-style links" supposed to work in MacJournal?
Detect Wiki-style links is a function in MacJournal that creates links to entries based on the way text is typed. If the text is formatted in a specific way (in CamelCase--see below for more information on what CamelCase is), MacJournal should recognize the text as a Wiki link and render the specially-formatted text as a link to another entry in the MacJournal document.
What is CamelCase?
CamelCase is a method of transcription (the practice of writing text out) that follows two basic rules:
- The first letter of each word in the phrase is capitalized.
- There are no spaces between words.
If the phrase This is CamelCase was written in CamelCase, it would look like this:
The idea behind the name "CamelCase" is that the staggered capital letters are evocative of the humps on a camel.
How does it work, then?
Suppose that you have an article in MacJournal about a visit to the Great Wall of China, and that you currently have an entry in your journal named Great Wall of China. You might currently be writing (or editing) an entry elsewhere that refers to your visit to the Great Wall of China, and you would like to link to your entry documenting your visit. To do this, simply enter the following into your entry:
Functionalities in MacJournal to detect Wiki Style links will do the following:
- MacJournal will attempt to locate an entry in the current document named Great Wall of China (capitalized properly, with spaces).
- If MacJournal finds a document named Great Wall of China, it will render the text
GreatWallOfChinaas a link to this article
- If you click on the link, MacJournal will display the target article (here: the article Great Wall of China) in the editor pane.
Functions (and options) in MacJournal related to Wiki-style links
There are some specific functions and options in MacJournal that are related to the location (and rendering) of Wiki-style links.
Clean up Wiki Links
If MacJournal is not currently set to discover Wiki-style links as you type (see below), Clean up Wiki Links will discover new links and render them.
To use this function, select Clean Up > Wiki Links from the Format menu.
Discover Wiki-style links (as you type)
This option enables MacJournal to check for (and render) Wiki-style links automatically (as you type).
This option is available under the Editing pane of MacJournal preferences. By default, this preference is enabled.
Require valid targets for Wiki Links
The option Require valid targets for Wiki links limits MacJournal to acting on CamelCase text (as a Wiki-style link) only if it links to a journal that currently exists. Going back to the example of the Great Wall of China, suppose that you did not visit the Forbidden City, and that (because of this) you do not have an entry on the Forbidden City at all--if you enter the name
TheForbidenCity) into an entry in MacJournal, MacJournal will not render the CamelCase text as a link (because no target article exists to link to).
This option is available under the Advanced pane in MacJournal preferences.