Specific filename to be used for the note\\'s exported HTML page instead of default calculated name.<\/p>\n
If left empty, Tinderbox automatically generates a filename based on the note\\'s title.<\/p>\n
Note that a string set for this attribute should be the desired filename without<\/i> its extension, i.e. \\'index\\' not index.html\\'.<\/p>\n
Automatic filenames strip unsafe (see below) characters from the note title and truncate the resulting string to the number of characters set in $HTMLFileNameMaxLength<\/a> (where, from v9.5.0, the default is 100). The case of characters in the exported name will be as per the note title except if $HTMLFileNameLowerCase<\/a> is Default: (not set: empty string)<\/p>\n $HTMLExportFileName can be set via the Export Inspector\\'s ▸ Export<\/a> tab, \\'File Name\\' box.<\/p>\n To avoid filename naming collisions, Tinderbox has to check if the intended export name already exists in the currently exported-to folder. If a duplicate name might arise, a suffix will be added. Simplistically, if file \\\"abc.html\\\" is already being exported to the current folder, another note that would export with that name will be exported as \\\"abc_1.html\\\" (and -@, _3, etc.). <\/p>\n From v9.5.0, punctuation characters in $Name other than a forward slash, period, and tilde ( From v9.7.3, any caret ( Because the filename might<\/i> change on export, Tinderbox does not return a value for As Windows-OS web servers support fewer characters in file paths\/names that other OSs, the following characters are suppressed when generating filenames from $Name:<\/p>\n\t Further manipulation is available via $HTMLExportFileNameSpacer<\/a>.<\/p>\n $HTMLExportPath<\/a> evaluates the likely exported filename and path.<\/p>",
"date_published": "2004-08-15T00:13:41+01:00",
"date_modified": "2024-04-11T10:21:40+01:00"
},
{
"id": "1712843827",
"url": "https://www.atbref.com/atbref95/index/Automating_Tinderbox/Coding/Use_of_Attributes/Attribute_Listings/System_Attribute_List/WordCount.html",
"title": "WordCount",
"content_html": " The number of discrete words in the current note\\'s $Text<\/a> (read-only).<\/p>\n See $TextLength<\/a> for the total character count).<\/p>\n $WordCount is not language aware. Essentially it is tuned for the heuristics of English language. Therefore it may not work well with languages that use word-spacing conventions drastically unlike English.<\/p>\n For those needing a word count in a non-English language\/script\/locale, one approach is to consider String.split(regex), populating the regex with word break characters that may differ from English. Note, in this context punctuation doesn\\'t matter only the alternatives to spaces\/non-breaking spaces that a given language may use.<\/p>\n Word count is as much science as art. For instance, is \\'UNESCO\\' one word, six words—or seven if you include the \\'and\\' omitted from the acronym. Within a single country or a single language tradition there may be consensus on such points but it may not hold true more widely.<\/p>\n However, for English text, $WordCount should be considered accurate.<\/p>\n From v9.5.2, $WordCount now works better in Chinese and several other languages. Word count, even in English still remains something of an art. For some languages, such as Chinese, $TextLength—the character count of $Text—may be more useful, if only one type of (language) script is being used in the note. The word count for mixed-script text is always likely to have some inaccuracy as language typing to sub-string level, e.g. discrete parts of $Text, does not occur.<\/p>\n From v9.7.3, if $WordCount is a displayed attribute, editing the text pane periodically updates the displayed word count<\/p>\n Legacy note<\/b><\/p>\n In very early versions the attribute name was \\'Wordcount\\' and the program allows either spelling. However, the old version is deprecated.<\/p>",
"date_published": "2004-08-15T00:11:55+01:00",
"date_modified": "2024-04-11T10:30:12+01:00"
},
{
"id": "1712843175",
"url": "https://www.atbref.com/atbref95/index/Automating_Tinderbox/Coding/Action_Code/Operators/Full_Operator_List/String_replace_regexMatchStr_replacementStr.html",
"title": "String.replace(regexMatchStr, replacementStr)",
"content_html": " String\/List.replace(regexMatchStr, replacementStr)<\/b><\/p>\n This operator allows simple text transformations without use of runCommand as was hitherto required.<\/p>\n regexMatchStr<\/b> and replacement<\/b> are one of:<\/p>\n $MyString.replace(regexMatchStr, replacementStr)<\/b><\/p>\n In its simplest form, the operator creates a new string in which each occurrence of regex is replaced by the string replacement, i.e. global replacement. The source string is not changed by replace; if you wish to change the string itself, write back over the source attribute:<\/p>\n\t transforms a $MyString value of \\\"Hello World\\\" to \\\"Goodbye World\\\".<\/p>\n Where regexMatchStr<\/b> is a regular expression, and may contain wildcard characters such as \\\".\\\" (which matches any character) or \\\"*\\\" (which matches 0 or more occurrences of the preceding character). Thus \\\".*\\\" matches zero or more instances of any character.<\/p>\n Where parentheses in regexMatchStr<\/b> create multiple back-references<\/a>, replacementStr<\/b> strings can include $1, $2, etc., to insert the relevant back-reference matched string ($1 through $9 allowed, and with $0 being the entire match).<\/p>\n From v9.7.3, the replacement preserves styles in the source String.<\/p>\n Examples:<\/p>\n\t changes all instance of \\\"Spenser\\\" to \\\"Spencer\\\".<\/p>\n\t deletes all vowels<\/p>\n\t returns \\\"I do not like eggs green\\\". Or:<\/p>\n\t Will replace<\/p>\n\t with<\/p>\n Note that if the source text is part of a larger text, e.g. a whole email\\'s plain text, consider using stream parsing<\/a> methods.<\/p>\n A replace action does not alter the original source<\/b><\/p>\n Using .replace() does not affect the source string unless the replacement output is used to overwrite the original source value. Thus if $MyString holds \\\"Hello World\\\" then:<\/p>\n\t $MyString remains \\\"Hello Word\\\" and $MyStringA has value \\\"Hello\\\". The source is unchanged. But, if we set the source to the output<\/p>\n\t Now $MyString becomes \\\"Hello\\\" and the original value is lost (overwritten by the new one). This distinction is one to bear in mind when using .replace() with $Text.<\/p>\n Using .replace() with $Text and formatting operators<\/b><\/p>\n When applied to $Text, .replace() allows style operators to be applied to the replacement argument. For example,<\/p>\n\t will embolden all lines beginning with “From:”.<\/p>\n If using style operators, do not place operator-modified back-reference within quotes. To re-use the example from above, consider $Text containing \\\"I do not like green eggs and ham\\\":<\/p>\n\t gives \\\"I do not like eggs<\/b> Multiple, but differing replacements<\/b><\/p>\n Although multiple matches can be replaced with the same string, to replace multiple matches with different strings requires chained .replace() calls. Consider formatting a large number to Continental style. This means inserting spaces as the group delimiter and a comma for the decimal delimiter. Assume $MyNumber\\'s value is 1234567.89:<\/p>\n\t Now, 1234567.89 becomes \\\"1 234 567,89\\\".<\/p>\n Some comma-delimited formats use straight double quotes for all\/some values and demand that if this character appears in a value that is it escaped by doubling the character. If $Text is<\/p>\n\t Then it could be escaped for CSV export like so:<\/p>\n\t That exports:<\/p>\n\t Note that in this instance using a single straight quote (instead of the more normal straight double quote) to contain the find and replace regexs works just fine. Also, there is no need to escape typographic double quotes, i.e. \\'smart\\' or \\'curly\\' quotes in this context.<\/p>\n This function respects existing rich text styling.<\/p>\n Short form for deletions<\/b><\/p>\n If the replacement <\/b>string is omitted, the one-argument form $MyString.replace(regex) returns a copy of $MyString in which every occurrence of the regex is removed.<\/p>\n Trimming leading\/trailing whitespace<\/b><\/p>\n\t The \\' +\\' means one or more space characters<\/i>. The first replace finds such a sub-string immediately following the start of the whole string ^), whilst the second does the same for a sub-string immediately before the end of the string ($). If applied to multi-paragraph string, e.g. with line breaks such as in $Text, every<\/i> paragraph is trimmed. Likely this is what is desired, but care is needed in more specialist situations. So, testing sample strings\/texts is a good idea before changing actual data of value. If working with List or Sets a slightly different code<\/a> is needed.<\/p>\n Trimming leading\/trailing quotes<\/b><\/p>\n Because Tinderbox cannot escape quote characters (i.e. \\\\\" or \\\\' do not<\/i> escape the quote), use String.substr()<\/a> to trim enclosing quotes on a string. Note that the latter, working on location in the string and not character type, cannot work on paragraphs within a string, such as in the example above.<\/p>\n Dealing with inline quote characters<\/b><\/p>\n Because regex<\/b> is parsed for regular expressions<\/a>, it may be possible to use the \\'\\xNN\\' form of character encoding described here <\/a>to work around the lack of escaping from single double quotes within strings.<\/p>\n Handling changes to $Text including link anchors<\/b><\/p>\n When using .replace is used on a note\\'s $Text, the replaced text also updates the position of pre-existing text link anchor text.<\/p>\n Working with styled text<\/b><\/p>\n This operator is capable of worthing with StyledString operators: StyledString.bold<\/a>, StyledString.fontSize()<\/a>, StyledString.italic<\/a> and StyledString.strike<\/a>.<\/p>",
"date_published": "2010-10-20T23:09:00+01:00",
"date_modified": "2024-04-11T10:08:29+01:00"
},
{
"id": "1712843834",
"url": "https://www.atbref.com/atbref95/index/Windows/Document_Window/Text_pane/Text_tab/Displayed_Attributes_table.html",
"title": "Displayed Attributes table",
"content_html": " NOTE: \\'Displayed Attributes\\' replace the old now-deprecated \\'Key Attributes\\'—see explanation<\/a>.<\/p>\n A note\\'s \\'Displayed Attributes<\/a>\\' are an optional display of a user-defined tabular layout of attribute title\/value cells. A Displayed Attribute is a display feature and has no effect on inheritance and does not accord an attribute any special status<\/i> other than being easily viewed\/edited for a note\\'s text pane.<\/p>\n Attribute names are shown in the left column, attribute values in the right column. The width of the first column of the Displayed Attribute table adjusts itself to accommodate long attribute names. The list can be re-ordered, items deleted and attribute value edited. An item is added by:<\/p>\n The vertical order of displayed (key) attributes can be altered via drag-drop of the attribute name label (left column cell), or altering the order of the list stored in $DisplayedAttributes. An item can be deleted from the Displayed Attribute display by dragging its label cell out of the table and dropping onto the $Text pane.<\/p>\n Row height. From v9.5.2, String-type (only) attributes can have a bigger line height. The default row hight for String-type attributes remains one line, but this can be extended to a maximum of seven lines. Within that space line breaks in the String\\'s value are honoured but any overflow is clipped (i.e. more content cannot be scrolled). Line height is set per-attribute using The Document Inspector\\'s System<\/a> and User<\/a> tabs. From v9.6.0, multi-line attributes are also permitted for Sets and Lists as well as String type attributes.<\/p>\n Items in bold are set locally for the note. Items in lighter colour are read-only (normally dynamically calculated values like $ChildCount; pre v6 these were in italics). All other rows in normal text use the default or inherited value. The full meaning of the styling of different rows (bold, strikethrough, etc.) is explained here<\/a>.<\/p>\n This pop-up can be called via the View<\/a> menu as well as from the text pane.<\/p>\n At the extreme the right of the panel each String, List or Set attribute has a pop-up list of values<\/a>, allowing quick setting of values already in use for that attribute (or suggested values<\/a>, if defined).<\/p>\n When a user attribute is renamed, Displayed Attributes referring to the new attribute are updated to use the new attribute (and attribute values are transferred).<\/p>\n Some per-data-type specific points to note:<\/p>\n A note\\'s title ($Name) can be edited directly via the title bar above the Displayed Attributes table so there is no need to add it to the table.<\/p>\n Displayed Attributes are sometimes referred to with the shorthand abbreviation \\'DA\\' in help forums, etc.<\/p>\n The attribute $ReadOnly<\/a> is exempted from being read-only, even when set to From v9.7.3, if $WordCount is a displayed attribute, editing the text pane periodically updates the displayed word count<\/p>\n Show\/Hide Displayed Attributes<\/b><\/p>\n A disclosure triangle allows the visibility Displayed Attributes table to be toggled, e.g. to allow more space for showing $Text. The control is not shown if there are no Displayed Attributes for the current note. The \\'add Displayed Attributes\\' button still remains available. The show\/hide state is stored in $HideDisplayedAttributes<\/a>.<\/p>\n Cycling\/Editing Displayed Attributes via keyboard<\/b><\/p>\n To cycle through Displayed Attributes, use the Return<\/b> key (↩). Using the Return<\/b> key on a selected row sets that item in edit mode. Clicking Return<\/b> again closes the edit and selects the next item in the table (looping to the top when the bottom is reached). When a boolean item is selected and in edit mode, use the Spacebar<\/b> key to toggle the If the Return key has not yet been used since the note was selected, the Up-Arrow<\/b> (↑) and Down-Arrow<\/b> (↓)keys can be used to move the selection in the table (but the selection does not loop at top bottom). If Return<\/b> key has been used the Up<\/b>\/Down<\/b> arrow keys simply select the table row above or below and set it in edit mode.<\/p>\n To cycle between the Displayed Attributes table, the $Text are and the View pane, use the Opt<\/b>+Tab<\/b> keys (⌥+ ⇥). <\/p>\n In Outline\/Chart\/Treemap view, to move the View pane selection (i.e. change the contents of the text pane) up or down one item in $OutlineOrder use Cmd<\/b>+Opt<\/b>+Up-Arrow<\/b> ( ⌘+⌥+↑) or Cmd<\/b>+Opt<\/b>+Down-Arrow<\/b> ( ⌘+⌥+↓).<\/p>\n Editing Displayed Attributes values<\/b><\/p>\n Once a row in the table has focus (either via keyboard, as above)or by a direct trackpad\/mouse-click the value box in the right column can be edited:<\/p>\n Displayed Attribute characteristics such as enabling or disabling the URL and File buttons are updated after editing the Displayed Attribute\\'s textual value.<\/p>\n Changing the text of a Displayed Attribute immediately updates that Displayed Attribute\\'s pulldown value menu.<\/p>\n When a Boolean attribute is selected in the Displayed Attributes table, pressing the spacebar will toggle its value.<\/p>\n The table displays an ellipsis (…) if the text value extends to multiple lines, even if the visible line is not truncated.<\/p>\n The menu commands Format ▸ Text<\/a> ▸ Insert Date\/Time\/Date and Time now insert the requested text at the insertion point, rather than replacing the current value with the requested text.<\/p>\n Number of Displayed Attributes shown<\/b><\/p>\n The height of the Displayed Attributes table can grow to as much as half the height of the text panel, reducing the need to scroll long lists of Displayed Attributes if using a sufficiently-large display. As previously, the table shows scroll bars if not all Displayed Attributes can be accommodated. In older versions, scroll bars show if there are over 15 Displayed Attributes, regardless of text pane height. If needing larger numbers of Displayed Attributes see further below<\/p>\n Resetting default\/inherited values<\/b><\/p>\n For displayed String\/Set\/List data typed attributes only, the default value can be reset by using their pop-up value lists<\/a>, by selecting the value \\'normal\\'. For all other data types, to repair inheritance select the note in question and do either one of:<\/p>\n Font\/Font Size for the Displayed Attributes table<\/b><\/p>\n The Displayed Attributes table can be set to a user specified font, for attribute names and their values, via $DisplayedAttributesFont<\/a>.<\/p>\n The font size used to render the current note\\'s table can be altered via the Displayed Attributes replace Displayed Attributes sub-menu of the Window menu. The latter offers a small range of suggested sizes (default is 11pt). The actual size is stored is the point size number, i.e. Evaluating an attribute<\/b><\/p>\n The current value of the Displayed Attributes can be evaluated (as action code) and written back as the attribute\\'s value. The Evaluate function is accessed via the table\\'s pop-up context menu<\/a>.<\/p>\n Changes to Displayed Attributes affect $Modified<\/b><\/p>\n Changing an attribute value in the displayed attributes table or in Get Info\\'s attributes<\/a> tab updates $Modified<\/a>. Changing an attribute value in a stamp<\/a> (including Quickstamp<\/a>) or an action does not update $Modified.<\/p>\n Needing to show even more Displayed Attributes?<\/p>\n<\/b> The maximum number of table items equates to c.50% of the $Text area\\'s height, so dragging a taller overall document window can help. Other approaches to consider:<\/p>\n Called from the badge control of main view note icons, this picker gives a visual picker for available badges. The badge selection is stored, via its string name, in $Badge<\/a>.<\/p>\n From v9.7.3, the Badge Picker gains a Search<\/b> field. When using the search field, Tinderbox displays badges from any family that match the string typed in the search field. Clear the search field to view badges by family. In addition to matching the name of the badge, the picker also searches for words semantically related to the searched-for (English) word. Thus, searching for \\\"flight\\\" will locate the badge \\\"airplane\\\".<\/p>\n The range of badges shown depends on the built-in sets and any added by the user. The pickers tabs are (left to right):<\/p>\n Click on any badge to set the note\\'s $Badge. Clicking the first (blank) tile in any set resets the Badge to the default inherited state.<\/p>\n Place the mouse cursor over any icon, without clicking, and after a brief pause the icon\\'s name is shown as a tool-tip. Names are case-sensitive and all built-in badges use all-lowercase.<\/p>\n To close the pop-over click anywhere outside it.<\/p>\n The Badge Picker adopts the prevailing background colour in dark mode. Monochrome icon families are drawn in white over a dark background, and in black over a light background; colour families are drawn normally.<\/p>",
"date_published": "2007-07-05T04:33:57+01:00",
"date_modified": "2024-04-11T10:27:51+01:00"
},
{
"id": "1712843814",
"url": "https://www.atbref.com/atbref95/index/Dialogs/Make_Web_Link_pop-over.html",
"title": "Make Web Link pop-over",
"content_html": " This pop-over dialog is invoked from the Note menu or via a shortcut (⌃<\/b>+<\/b>⌥<\/b>+ <\/b>⌘<\/b>+L<\/b>).<\/p>\n The pop-over opens in collapsed state showing only the link type, link type selector, and URL inputs, whose purposes are described below.<\/p>\n The pop-over contains the following controls:<\/p>\n From v9.7.3, the popover now remembers its expansion state and opens with the focus on the URL fields. If the URL is populated but the Title field is empty, Tinderbox now attempts to obtain the title from the destination web server. If the title field is not empty, the existing title will not be changed.<\/p>",
"date_published": "2024-02-14T20:56:13+01:00",
"date_modified": "2024-04-11T10:24:22+01:00"
},
{
"id": "1712843813",
"url": "https://www.atbref.com/atbref95/index/Change_Log/v9_7_3b673_10_Apr_2024.html",
"title": "v9.7.3b673 (10 Apr 2024)",
"content_html": " Released 10 Apr 2024. Build number is 673.<\/p>\n Eastgate release page for this version is here<\/a>.<\/p>\n Minor changes not necessarily warranting explicit mention in an aTbRef note:<\/p>\n This version is cited in the following notes:<\/p>\n Since first publishing, up to and including the current baseline Tinderbox has had 157 public releases up to the current baseline v9.5.0 released never. Below are their dates, where known. For the 8 releases since the baseline, see the Change Log<\/a>. Details of changes since the current baseline can be researched via the Change Log and the app\\'s Release Notes<\/a>.<\/p>\n Previous Tinderbox releases prior to current baseline:<\/p>\n\ttrue<\/code>.<\/p>\n\/.~<\/code>) are also allowed in export filenames. <\/p>\n^<\/code>) characters in $Name are omitted<\/i> from the exported filename as this caused issues re export code parsing (carets themselves are not illegal in a URL, but not generally meaningful).<\/p>\neval($HTMLExportFileName)<\/code>; an exception is if this attribute already has an explicitly set value. The workaround is to use ^file()^, noting that the latter returns both file name and<\/i> extension rather than just the name portion.<\/p>\n[space] \/ \\ ? % * : | \\' \\\" < > . & + ( ) ! #<\/code> <\/p>\n$MyString = $MyString.replace(\\\"Hello\\\",\\\"Goodbye\\\");<\/code> <\/p>\n$MyString.replace(\\\"Spenser\\\",\\\"Spencer\\\");<\/code> <\/p>\n$MyString.replace(\\\"(a|e|i|o|u)\\\",\\\"\\\");<\/code> <\/p>\n$MyString = \\\"I do not like green eggs\\\".replace(\\\"(green) (eggs)\\\",\\\"$2 $1\\\");<\/code> <\/p>\n$Text=$Text.replace(\\\"From: (.+)@(.*)\\\",\\\"——$1——\\n$2\\\");<\/code> <\/p>\nFrom: mark@example.com<\/code> <\/p>\n\t——mark——\n\texample.com<\/code><\/pre>\n$MyStringA = $MyString.replace(\\\" World\\\");<\/code> <\/p>\n$MyString = $MyString.replace(\\\" World\\\");<\/code> <\/p>\nreplace(\\\"^ from: .*\\\",$0.bold)<\/code> <\/p>\n$Text = \\\"$Text.replace(\\\"(green) (eggs)\\\",$2.bold+\\\" \\\"+ $1.strike);<\/code> <\/p>\ngreen<\/strike> and ham\\\".<\/p>\n$MyString = $MyNumber.replace(\\\"(\\d)(?=(?:\\d{3})+([^\\d]))\\\",\\\"$1 \\\").replace(\\\"\\.\\\",\\\",\\\");<\/code> <\/p>\nHe shouted \\\"Hello!\\\" at the top of his voice.<\/code> <\/p>\n…,\\\"^value($Text.replace(\\'\\\"\\',\\'\\\"\\\"\\'))^\\\",…<\/code> <\/p>\n…,\\\"He shouted \\\"\\\"Hello!\\\"\\\" at the top of his voice.\\\",…<\/code> <\/p>\n$MyString = $MyString.replace(\\\"^ +\\\",\\\"\\\").replace(\\\" +$\\\",\\\"\\\");<\/code> <\/p>\ntrue<\/code>, un-ticked to false<\/code>.<\/li>\n0.000001<\/code> can be entered as 1e-06<\/code>.<\/li>\ntrue<\/code>. This allows you to turn off ReadOnly from the displayed attributes table or from Get Info ▸ attributes<\/a> tab.<\/p>\ntrue\/false<\/code> setting, otherwise other data types are editing via normal keyboard input.<\/p>\n11<\/code> for the default in $DisplayedAttributesFontSize<\/a>. It is possible to set values not available in the menu by editing the attribute value directly. To change the value for the entire document, use the Document Inspector General tab to alter the the default value for $DisplayedAttributesFontSize.<\/p>\nTarget<\/code> attribute. This tells a web browser in which window the retrieved data is to be shown. Default is empty, meaning the destination page loads in the current window, replacing the calling page.<\/li>\nTitle<\/code> attribute.<\/li>\nClass<\/code> attribute, for CSS use.<\/li><\/ul>\n