Tinderbox 8 Inspector

This tab gives an overview of metrics about the current (front) document.

1. The left column shows the numbers of notes and other object types in the document. These are totalled at the bottom.
2. The right column gives a word count and numbers of underlying structural elements like prototypes and templates.

Note for users from pre-v6: this view replaces the v5 Hypertext view.

This shows performance of action code and various forms of synching.

1. The number of agents. The vertical green bar (seen here only at the right end of the second bar) moves from left to right each agent update cycle giving an indication of how much work is having to be done. The name shown in the bar is the agent being processed currently. This makes it easy to see very slow-running agents.
2. The number of rules.  As for the agent, a sweeping progress line is shown for the rule cycle and the rule currently being run.
3. The pending figure shows—at the beginning of the cycle—the number of tasks (queries, rules, etc.) to be run and counts down as the agent cycle progresses
4. This shows any synching that is in use and its status. This process covers AutoFetch, watched folders, DEVONThink watched groups, geocaching updates, Simplenote synch, Bookends import updates, and other periodic maintenance. The processes described start as the progress reaches the 12:00 position (top centre). Beneath is shown how recently they were updated.
5. This indicates the number of edicts in use.

This tab lists all the current document's System (built-in) attributes:

1. Search for a particular attribute. Start typing an attribute name and a selection of auto-complete possible matches are offered in a popup below the box. This is useful if the attribute name is known but not its grouping (category). Selecting a match here sets the next two pop-ups.
2. Category. The name of the (under-the-hood) attribute grouping to which the attribute belongs. These categories generally pull together attributes related to a particular purpose or part of the UI. Click to open a pop-up listing of groups.
3. Attribute. Click to show a pop-up list of attributes for the selected Category/group (above). Read-only attributes are listed in italics.
4. The selected attribute's Tinderbox data type, e.g. string, number, list, etc. Here it is a 'set'.
5. Default. The default value for the selected attribute. For all but read-only attributes, the doc level default value (inherited by all notes) can be edited here.
6. Suggested. A box for suggested values. Enter an optional list (semi-colon delimited) of suggested attribute values which pre-populates the pop-up list of values in the Get Info/Attributes dialog and Key Attribute tables.
7. This is ticked if this attribute is used as a Key Attribute by the currently selected note(s). This can be used to set/unset Key Attributes, although main text pane pop-up or Get Info are better tools for this task.
8. A short description of the purpose of the attribute.

This tab lists all the current document's (custom) User attributes. It can be used to add/delete user attributes and make some edits to their configuration:

1. A pop-up of existing user attributes for the current document - here a specimen string-type attribute 'MyString' has already been added.
2. Click this gear-wheel button for a drop-down menu with options to either add a new attribute or to delete the currently selected one.
3. Name. The name of the selected attribute. The box may initially be empty until the first user attribute is added. Use the Return key to finish editing or click outside the box (or the Escape key to exit with no edit).
4. Type. A pop-up list sets the Tinderbox data-type for the attribute. It should not generally be changed once the attribute is defined.
5. Default. Give the attribute a document level default, or leave blank to use the app default for the given attribute data type (e.g. zero for Number, nothing for string, 'never' for Date, etc.)
6. Suggested. A box for suggested values. Enter an optional list (semi-colon delimited) of suggested attribute values which pre-populates the pop-up list of values in the Get Info/Attributes dialog and Key Attribute tables.
7. sequential. Only used by Number-type attributes. If ticked, each existing note receives a sequential value in $OutlineOrder order and thereafter new notes in the order they are added.
8. This is ticked if this attribute is used as a Key Attribute by the currently selected note(s). This can be used to set/unset Key Attributes, although main text pane pop-up or Get Info are better tools for this task.
9. Description. Optionally provide a textual description for the need/purpose of the attribute. The description is only displayed in this location.

This tab is used for configuring/editing defined (named) colours in the current document. In addition to the v5 named colours ('red', etc.) v6 defines ten shades of grey 0 through 9. N.B the actual values of all/some named colours may be redefined by use of colour palette applied via the Document Settings 'Colors' tab or via drag/drop of a colour scheme file onto a TBX. Controls are:

1. A pop-up list of all currently named/defined colours, both built-in and user-added. The little circle shows the actual colour defined, before listing the defined colour's name.
2. A pop-up control to add new colours or delete existing ones, or save a colour scheme (TBC) file.
3. The colour chip opens the Mac's OS colours palette to set a colour or the value can be defined via the input box.
4. The hexadecimal value of the colour.
5. The Tinderbox name for the new/currently selected colour (note that numerals are allowed and names may be more than one word, e.g. 'burnt umber')
6. Tick this box to hide the colour from pop-up lists of defined colours elsewhere in Tinderbox. The colour may still be used in actions and in attribute values, it is simply not listed.

This tab lists and defines link types in the current document:

1. Link types. A pop-up list of currently defined link types (regardless of whether used at present or not). Information for the selected item is shown in the rest of the pane.
2. A control with options to add a new link type, delete the current link type, or delete all unused link types within the present document.
3. Name. The name of the currently selected link type.
4. An OS colour control to change the colour of the links drawn with the selected link type.
5. Shown as. The displayed (on map links) name of the currently selected link type. New to v6, a link type's on-screen label name differ from the internal name. This can help for using longer screen labels or if needing characters that are problematic for action code use, e.g. where filtering links by link type name where the internal name is used as opposed to the screen label
6. Tick-box controls to alter how the selected link type is drawn on maps.
   • visible. If ticked (default), the currently selected link type is drawn on maps. Un-tick to hide this link type.
   • dotted. If ticked (default is un-ticked), the currently selected link type's link lines are drawn as dotted lines instead of solid. Dotted and dashed stylings can be be ticked to give a dot-dash line style.
   • broad. If ticked bezier links are to be drawn in the broad style.
   • bold. If ticked (default is un-ticked), the currently selected link type's link line is drawn bolded (i.e. wider line width).
   • dashed. If ticked (default is un-ticked), the currently selected link type's link lines are drawn as dashed lines instead of solid. Dotted and dashed stylings can be be ticked to give a dot-dash line style.
   • labeled. If ticked (default - except for '*untitled'), the currently selected link type's links are drawn with a label. The label is the name (#2 above) unless a custom screen label is defined (#3 above).
   • linear. If ticked (default is un-ticked), the currently selected link type 's link lines are drawn as straight lines instead of the normal bezier curves.
7. Connector. Choose a connector type: arrow (default) or circle.
8. Action. LinkTypes can define an optional OnLink action that will be performed whenever a new link of that type is created.

This tab allows creation, configuration and use of stamps in the current document:

1. A list of currently saved stamps - here a specimen item has already been added.
2. Controls to delete the currently selected list item, or to add a new stamp.
3. Name. Add/edit a stamps' name.
4. Add/edit the stamp's code.
5. Apply. Click the button to apply the stamp to the currently selected note(s). This an alternative to using the main Stamps menu.

This tab holds controls a number of note-related general configuration settings:

1. Prototype. A pop-up shows the currently selected prototype assigned ($Prototype) if any.  The list shows all prototypes currently defined for the document.  The selection choice sets/changes/removes a prototype assignment.
2. Prototype. Tick to make the note a prototype ($IsPrototype).
3. Template. Tick to make the note an export template ($IsTemplate).
4. Separator. Tick to make the note a separator ($Separator). Separators are only visible in Outline view.

This tab offers a quick way to set a value for an attribute for the selected note(s), or ro re-assert inheritance of values:

1. Quick search box with auto-complete to find attributes. Selecting a match here sets the next two pop-ups.
2. The name of the (under-the-hood) attribute grouping to which the attribute belongs. These categories generally pull together attributes related to a particular purpose or part of the UI. Click to open a pop-up listing of groups.
3. Click to show a pop-up list of attributes for the selected Category/group (above). Read-only attributes are listed in italics.
4. Inherited value, or 'default' if no prototype set. The value string shown is the value to be inherited if different from the local value. Click the button to apply this value/inheritance to the current selection.
5. Value assigned (locally) to this note, or 'default value' if no prototype set. The value string shown is the value to be inherited if different from the local value. Click the button to apply this value/inheritance to the current selection.
6. An input box to set a local value for the selected attribute for the current note selection.
7. Existing value pop-up list. If the selected attribute is of String, List or Set data type, this pop-up shows existing unique values for the attribute
8. Apply. Click the button to apply the displayed settings.

This tab holds two map-related controls:

1. Toggled the locked state ($Lock) of the selected items.
2. Toggle the sticky state ($Sticky) of the selected items.

This tab controls a number of the most commonly used appearance-related aspects of notes:

1. Color. Tinderbox color controls to set $Color. In Outline/Chart views this is the colour of the item's title. In Map view it is the main colour of the map icon for the note.
2. Pattern. Sets $Pattern, though only for named values and not for calculated forms as used for container plots. Patterns are drawn using $Color and $Color2.
3. Translucent. If ticked, the note's Map view $Opacity is set to 50(%). N.B. these are not the only allowed values for the atribute.
4. Accent. Tinderbox color controls to set $Color2. In Map view it is the secondary, 'accent', colour of the map icon for the note used for patterns, progress bars and the like.
5. Shape. Sets the shape of the note's Map view icon, stored in $Shape.
6. Badge. Sets the note's badge ($Badge).
7. Large (tick box). When ticked a display box of 64x64 pixels is used instead of the default 32x32.
8. Texture. Sets the note's Map view icon's texture fill ($Fill). If a texture is used then $Pattern and $Colour are not seen.
9. Add Badge. An image well accepts a drag-drop of a bitmap image as a custom badge.

This tab controls the appearance of the Map view border of notes:

1. Color. Tinderbox color controls to set $BorderColor. In Outline/Chart views this is the colour of the item's title. In Map view it is the main colour of the map icon for the note.
2. Style. Sets the style of the border edge ($BorderBevel).
3. Dashed. If ticked and the border style is 'plain', the map icon is drawn with a dashed border ($BorderDash is set to '5', or '0' when not ticked). N.B. these are not the only allowed values for the attribute.
4. Width. Sets the border width if a border is shown ($Border).

This tab controls whether Map view icons show a drop shadow:

1. Shadow. If ticked, map icons are drawn with a drop shadow ($Shadow).
2. Distance. The distance a drop shadow is drawn from its source note ($ShadowDistance).
3. Blur. The degree of blur in the drop shadow ($ShadowBlur).
4. Color. Tinderbox color controls to set $ShadowColor. In Map view it is the colour used to draw the note's drop shadow.

This tab controls the background colour of Outline views:

1. Background. Tinderbox color controls to set the colour of the Outline view background for the current view ($OutlineBackgroundColor).

This tab controls various aspects of a Map view's container plots. Not all inputs/controls are visible - it depends on the plot type (pattern) that is specified.

1. Pattern. The type of container plot expression.
2. Expression. The container plot expression (code).
3. X axis. Optional input for the xyplot() expression.
4. Minimum. Optional maximum value for the Y axis.
5. Maximum. Optional maximum value for the Y axis.
6. Target. Displayed on a  new line between Minimum/Maximum and Plot Color, when the Pattern type is bar() or vbar().
7. Plot Color. Tinderbox color controls to set the colour of the plotted data in a container plot ($PlotColor).
8. Background. Tinderbox color controls to set the colour of the container plot background for this note's Map ($PlotBackgroundColor).
9. Background opacity. A slider is used to set the opacity of the plot's background - if transparent, the child map shows through ($PlotBackgroundOpacity).
10. Currently defined plot pattern string ($Pattern). To edit use the settings above.
11. Preview window. A preview image of the above settings as a plot.

This tab controls how the current note's title appears:

1. Color. Tinderbox color controls to set the colour of the title in Map icons ($NameColor, maps only).
2. Alignment. The horizontal alignment of titles in map icons ($NameAlignment).
3. Size (Map). Sets the relative size of the Map icon title ($MapTextSize); subtitle & body text are scaled appropriately.
4. Size (Outline). Sets the relative size of the Outline/Chart title ($OutlineTextSize);
5. Bold. Sets the title to bold text in all views ($NameBold).
6. Strikethrough. Sets the title's text style to strikethrough in all views ($NameStrike).
7. Display Expression. Input box for a display expression; the input is the action code to be evaluated ($DisplayExpression). The output of the expression is $DisplayName; if $DisplayName has a value, it is used instead of $Name in all main view titles (but not in the text pane header title).
8. Display Expression Enabled. The tick box allows control over whether the current display expression is evaluated or not ($DisplayExpressionDisabled).

This tab controls how the current note's subtitle appears (used in Map views only):

1. Color. Tinderbox color controls to set the colour of the subtitle text Map icons ($SubtitleColor).
2. Opacity. The opacity with which the subtitle is drawn ($SubtitleOpacity).
3. Size. The relative size of the subtitle's text compared to the note's title ($SubtitleSize).
4. Subtitle. The input box holds the subtitle's text - this is not an evaluated expression ($Subtitle).

This tab controls how the current note's caption appears (used in Map views only):

1. Color. Tinderbox color controls to set the colour of the subtitle text Map icons ($CaptionColor).
2. Opacity. The opacity with which the caption is drawn ($SubtitleOpacity).
3. Size. The relative size of the caption's text compared to the note's title ($SubtitleSize).
4. Alignment. The horizontal alignment of caption beneath Map icons ($CaptionAlignment).
5. Subtitle. The input box holds the caption's text - this is not an evaluated expression ($Caption).

This tab sets the current note's hover expression. Hover expressions are intended mainly for Map views, but also display in Outline and chart views. The hover expression is shown when the cursor is over a note; the note does not have to be selected to show the expression.

1. Hover Expression. Input box for a hover expression; the input is the action code to be evaluated ($HoverExpression).
2. Opacity. This slider alters the note's opacity ($HoverOpacity).
3. [image file]. Drop a bitmap image here to set an image background ($HoverImage). If used, a preview of the image is displayed.
4. Clear. Button is only enabled if a $HoverImage is set. Click to clear the existing image.

This tab controls a number of features relating to the current note's text:

1. Color. Tinderbox color controls to set the colour of the subtitle text Map icons ($TextColor).
2. Paragraph Spacing. Set the spacing of paragraphs within the current note ($ParagraphSpacing).
3. Line Spacing. Set the line spacing within the current note ($LineSpacing).
4. Don't check spelling. Tick to turn-off doc-level preferences to spell-check documents ($NoSpelling); essentially a local override.
5. Smart Quotes. Tick to turn-off doc-level preferences to automatically change straight quotes to typographic, i.e. 'curly', quotes. ($SmartQuotes); useful if putting code into note $Text.

This tab controls a number of features relating to exporting the current note:

1. Export. Tick to ensure this note is exported during an export of the document ($HTMLDontExport).
2. Export Children. Tick to export child notes even if this note is not exported ($HTMLExportChildren).
3. Markup Text. Evaluate an ^export^ code in the note, including smart lists and automatic headings ($HTMLMarkupText).
4. Quote HTML. If ticked any inline HTML code will be escaped, i.e. so it applies as test in HTML rather than getting interpreted as mark-up code ($HTMLQuoteHTML).
5. File Name. The filename to use for this note's exported file - leave blank to use an automatically assigned name ($HTMLExportFileName).
6. Extension. The filename extension (including an initial full stop) to use for exported files ($HTMLExportExtension).
7. Template. Chose an existing internal template note to act as this note's export template ($HTMLExportTemplate).
8. Export to. Click to set the OS folder into which export will occur (document wide setting).

This tab controls a number of markup choices used when exporting the current note:

1. First paragraph (start). Formatting to insert at the start of the first paragraph of a note's text ($HTMLFirstParagraphStart).
2. First paragraph (end). Formatting to insert at the end of the first paragraph of a note's text ($HTMLFirstParagraphEnd).
3. Paragraph (start). Formatting to insert at the start of the second and subsequent paragraphs of a note's text ($HTMLParagraphStart).
4. Paragraph (end). Formatting to insert at the end of the second and subsequent paragraphs of a note's text ($HTMLParagraphEnd).
5. Indented (start). Formatting to insert at the start of any indented paragraphs of a note's text ($HTMLIndentedParagraphStart).
6. Indented (end). Formatting to insert at the end of any indented paragraphs of a note's text ($HTMLIndentedParagraphEnd).
7. Before/After (start). Formatting to insert into any exported date before the start of the actual text ($HTMLBefore).
8. Before/After (end). Formatting to insert into any exported date after the end of the actual text ($HTMLAfter).

This tab controls a number of styling markup choices used when exporting the current note:

1. Bold (start). Formatting to insert at the start of any run of bold text ($HTMLBoldStart).
2. Bold (end). Formatting to insert at the end of any run of bold text ($HTMLBoldEnd).
3. Italic (start). Formatting to insert at the start of any run of italic text ($HTMLItalicStart).
4. Italic (end). Formatting to insert at the end of any run of italic text ($HTMLItalicEnd).
5. Underline (start). Formatting to insert at the start of any run of underlined text ($HTMLUnderlineStart).
6. Underline (end). Formatting to insert at the end of any run of underlined text ($HTMLUnderlineEnd).
7. Strike through (start). Formatting to insert at the start of any run of strike-through text ($HTMLStrikeStart).
8. Strike through (end). Formatting to insert at the end of any run of strike-through text ($HTMLStrikeEnd).

This tab controls a number of list markup choices used when exporting the current note:

1. Unordered (start). Formatting to insert at the start of an unordered (bulleted) list ($HTMLListStart).
2. Unordered (end). Formatting to insert at the end of an unordered (bulleted) list ($HTMLListEnd).
3. Ordered (start). Formatting to insert at the start of an ordered (numbered) list ($HTMLOrderedListStart).
4. Ordered (end). Formatting to insert at the end of an ordered (numbered) list ($HTMLOrderedListEnd).
5. List item (start). Formatting to insert at the start of a list item ($HTMLListItemStart).
6. List item (end). Formatting to insert at the end of a list item ($HTMLListItemEnd).

This tab allows for creation and management of export macros (with document, not note, scope):

1. Pop-up control to create/delete macros.
2. Pop-up list of existing macros.
3. Macro name.
4. Macro's code.

This tab controls the query for the current agent (agents only):

1. Items Found. This reports the number of items currently matching the query (i.e. child aliases within the agent container).
2. Query input box. Holds code used for the agent's query ($AgentQuery). To finish editing, either use the Return key or click outside the box. To exit with no edit, click the the Escape key. To create a line break in the code, click the Option+Return keys. Autocomplete is offered for attribute names.
3. Priority. The pop-up sets the frequency with with the agent is run including turning the agent off altogether ($AgentPriority).

This tab controls the action the current note or agent:

1. Action code input box. Holds code used for $OnAdd if the selection is a note (including smart adornments), or $AgentAction for agents. To finish editing, either use the Return key or click outside the box. To exit with no edit, click the the Escape key. To create a line break in the code, click the Option+Return keys. Autocomplete is offered for attribute names.

This tab controls the rule for the current note:

1. Inheritance state. default (uses document default), inherited (uses an inherited (prototype) value) or no caption if the rule is set locally in the note.
2. Rule code input box. Holds code used for the note's rule ($Rule). To finish editing, either use the Return key or click outside the box. To exit with no edit, click the the Escape key. To create a line break in the code, click the Option+Return keys. Autocomplete is offered for attribute names.
3. Enabled. Un-tick the box to disable the rule running in this note - useful for prototypes ($RuleDisabled).
4. Run Now. This button runs the rule immediately, once only, regardless of the state of the current agent/rule cycle. If the rule is disabled, this button is disabled.

This tab controls the remove action for the current note:

1. Action input box. Holds code used for $OnRemove

This tab controls the edict for the current note:

1. Inheritance state. default (uses document default), inherited (uses an inherited (prototype) value) or no caption if the rule is set locally in the note.
2. Edict code input box. Holds code used for the note's rule ($Edict). To finish editing, either use the Return key or click outside the box. To exit with no edit, click the the Escape key. To create a line break in the code, click the Option+Return keys. Autocomplete is offered for attribute names.
3. Enabled. Un-tick the box to disable the rule running in this note - useful for prototypes ($EdictDisabled).
4. Run Now. This button runs the edict immediately, once only, regardless of the state of the current agent/rule cycle. If the rule is disabled, this button is disabled.

This tab controls a number of sorting choices for the current note's children (applies to agents results too):

1. Sort By. Pop-up to select the primary sort attribute ($Sort).
2. Pop-up to set primary sort order criterion ($SortTransform).
3. reverse. Tick to reverse primary sort order ($SortBackward).
4. [Search]. A search box to help select the Sort By attribute choice.
5. and by. Pop-up to select the secondary sort attribute ($SortAlso).
6. Pop-up to set secondary sort criterion ($SortAlsoTransform).
7. reverse. Tick to reverse secondary sort order ($SortAlsoBackward).
8. [Search]. A search box to help select the and by attribute choice.