This version is out of date, covering development as far as v4.2.5. It is maintained here only for inbound reference links from elsewhere. Jump to the current version of aTbRef. |
A Tinderbox Reference File : Tinderbox File Types : Configuration Files : linkTypes.xml |
linkTypes.xml |
This file describes/defines the default set of link types for use in Tinderbox files. A color may also be defined - default is black (#000000). Visibility of individual types in map views may not be set here but should be done via the Link Types pane of the Attributes dialog.
Don't forget you can save your customised files outside the application, rather than overwriting the application's default file inside the package.
The application should be re-started after editing these files to ensure changes are detected.
Hierarchy of inheritance
The link types included in a new TBX file are defined by the 'linkTypes.xml' file. This file resides inside the Tinderbox application package (i.e. most users will never see it). To assist the user Tinderbox also checks this location:
~Library/Application Support/Tinderbox/
... and if a copy of the file is found there, then it takes precedence over the application's default version of the file. Note: if the folder doesn't exist, just make one of the appropriate name. As Tinderbox offers is this 'external' location, more safely accessible to the user, you are advised to use the latter for customisation of link types. This avoids the possibility of a mistaken edit inside the application package that might upset Tinderbox as a whole.
File syntax
This is the v3.5.x default set of link types:
<linkTypes version="1">
<link name="*untitled" label="" color="#000000" required="true" />
<link name="prototype" color="#993333" required="true" />
<link name="note" color="#666666" required="true" />
<link name="note+" color="#444444" required="true" />
<link name="response" color="#000000" />
<link name="agree" color="#000000" />
<link name="disagree" color="#000000" />
<link name="clarify" color="#000000" />
<link name="update" color="#000000" />
<link name="example" color="#000000" />
<link name="exception" color="#000000" />
<link name="response" color="#000000" />
</linkTypes>
Note that 'response' is listed twice - this is doubtless an oversight, not harmful to function and not required when drafting custom versions of this file.
The full allowable <link> syntax is this:
<linkType name="*untitled" label="" visible="1" showLabel="0" color="#000000" style="0" required="true" />
The 'showLabel' and 'style' parameters were added as of v3.0.5. Although the application defaults (above) don't use these additions you may safely use them in v3.0.5 or later in custom link files.
The 'required' parameter was added in v3.5.0.
Note, up to v3.0.6 internal links do not set or store the additional web link parameters. Although the create/browse links dialogs will allow you to set target, title and class data is it saved only for web links. This is changed from v3.5.0 onwards; 'internal' links such as basic links and text links can have target, title and class info set via the create/browse links dialogs.
Syntax for linkTypes.xml file:
Up: Configuration Files | |
Previous: html_helpers.xml | Next: menus.xml |
Licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
[See aTbRef CC licence Attribution/Waiver info info]