Attribute Reference
+ +
+
+ Labels
+
+
+
+
+ | Label | +Description | +
|---|---|
disableVersioning
+ |
+ Disables automatic creation of Note Revisions. + Useful for e.g. large, but unimportant notes - e.g. large JS libraries + used for scripting. | +
calendarRoot
+ |
+ Marks the note which should be used as root for Day Notes. Only one + should be marked as such. | +
archived
+ |
+ Hides notes from default search results and dialogs. Archived notes can + optionally be hidden in the Note Tree. | +
excludeFromExport
+ |
+ Notes (with their sub-tree) won't be included when exporting. | +
run
+ |
+
+ Defines on which events script should run. Possible values are: +
|
+
runOnInstance
+ |
+ Define which trilium instance should run this on. Default to all instances. | +
runAtHour
+ |
+ On which hour should this run. Should be used together with #run=hourly.
+ Can be defined multiple times for more runs during the day. |
+
disableInclusion
+ |
+ Scripts with this label won't be included into parent script execution. | +
sorted
+ |
+
+ Keeps child notes sorted by title alphabetically. +When given a value, it will sort by the value of another label instead. + If one of the child notes doesn't have the specified label, the title will + be used for them instead. + |
+
sortDirection
+ |
+
+ If
|
+
sortFoldersFirst
+ |
+ If sorted is applied, folders (notes with children) will be
+ sorted as a group at the top, and the rest will be sorted. |
+
top
+ |
+ If sorted is applied to the parent note, keeps given note on
+ top in its parent. |
+
hidePromotedAttributes
+ |
+ Hide Promoted Attributes on + this note. | +
readOnly
+ |
+ Marks a note to be always be read-only, + if it's a supported note (text, code, mermaid). | +
autoReadOnlyDisabled
+ |
+ text/code notes can be set automatically into read mode when they are + too large. You can disable this behavior on per-note basis by adding this + label to the note | +
appCss
+ |
+ marks CSS notes which are loaded into the Trilium application and can + thus be used to modify Trilium's looks. | +
appTheme
+ |
+ marks CSS notes which are full Trilium themes and are thus available in + Trilium options. | +
appThemeBase
+ |
+ Set to next, next-light, or next-dark to
+ use the corresponding TriliumNext theme (auto, light or dark) as the base
+ for a custom theme, instead of the legacy one. See Customize the Next theme for
+ more information. |
+
cssClass
+ |
+ value of this label is then added as CSS class to the node representing + given note in the tree. This can be useful for advanced theming. Can be + used in template notes. | +
iconClass
+ |
+ value of this label is added as a CSS class to the icon on the tree which + can help visually distinguish the notes in the tree. Example might be bx + bx-home - icons are taken from boxicons. Can be used in template notes. | +
pageSize
+ |
+ number of items per page in note listing | +
customRequestHandler
+ |
+ See Custom Request Handler. | +
customResourceProvider
+ |
+ See Custom Resource Providers. | +
widget
+ |
+ marks this note as a custom widget which will be added to the Trilium + component tree. See Custom Widgets for + more information. | +
workspace
+ |
+ marks this note as a workspace which allows easy hoisting | +
workspaceIconClass
+ |
+ defines box icon CSS class which will be used in tab when hoisted to this + note | +
workspaceTabBackgroundColor
+ |
+ CSS color used in the note tab when hoisted to this note | +
workspaceCalendarRoot
+ |
+ Defines per-workspace calendar root | +
workspaceTemplate
+ |
+ This note will appear in the selection of available template when creating + new note, but only when hoisted into a workspace containing this template | +
searchHome
+ |
+ new search notes will be created as children of this note | +
workspaceSearchHome
+ |
+ new search notes will be created as children of this note when hoisted + to some ancestor of this workspace note | +
inbox
+ |
+ default inbox location for new notes - when you create a note using new note button
+ in the sidebar, notes will be created as child notes in the note marked
+ as with #inbox label. |
+
workspaceInbox
+ |
+ default inbox location for new notes when hoisted to some ancestor of + this workspace note | +
sqlConsoleHome
+ |
+ default location of SQL Console notes | +
bookmarkFolder
+ |
+ note with this label will appear in bookmarks as folder (allowing access + to its children) | +
shareHiddenFromTree
+ |
+ this note is hidden from left navigation tree, but still accessible with + its URL | +
shareExternalLink
+ |
+ note will act as a link to an external website in the share tree | +
shareAlias
+ |
+ define an alias using which the note will be available under https://your_trilium_host/share/[your_alias]
+ |
+
shareOmitDefaultCss
+ |
+ default share page CSS will be omitted. Use when you make extensive styling + changes. | +
shareRoot
+ |
+ marks note which is served on /share root. | +
shareDescription
+ |
+ define text to be added to the HTML meta tag for description | +
shareRaw
+ |
+ note will be served in its raw format, without HTML wrapper | +
shareDisallowRobotIndexing
+ |
+ will forbid robot indexing of this note by setting the X-Robots-Tag: noindex HTTP
+ header. |
+
shareCredentials
+ |
+ require credentials to access this shared note. Value is expected to be
+ in format username:password. Don't forget to make this inheritable
+ to apply to child-notes/images. |
+
shareIndex
+ |
+ note with this label will list all roots of shared notes | +
displayRelations
+ |
+ comma delimited names of relations which should be displayed. All other + ones will be hidden. | +
hideRelations
+ |
+ comma delimited names of relations which should be hidden. All other ones + will be displayed. | +
titleTemplate
+ |
+
+ Default title of notes created as children of this note. This value is
+ evaluated as a JavaScript string and thus can be enriched with dynamic
+ content via the injected Examples: +
|
+
template
+ |
+ This note will appear in the selection of available template when creating + new note | +
toc
+ |
+ Controls the display of the Table of contents for
+ a given note. #toc or #toc=show to always display
+ the table of contents, #toc=false to always hide it. |
+
color
+ |
+ defines color of the note in note tree, links etc. Use any valid CSS color + value like 'red' or #a13d5f | +
keyboardShortcut
+ |
+ Defines a keyboard shortcut which will immediately jump to this note. + Example: 'ctrl+alt+e'. Requires frontend reload for the change to take + effect. | +
keepCurrentHoisting
+ |
+ Opening this link won't change hoisting even if the note is not displayable + in the current hoisted subtree. | +
executeButton
+ |
+ Title of the button which will execute the current code note | +
executeDescription
+ |
+ Longer description of the current code note displayed together with the + execute button | +
excludeFromNoteMap
+ |
+ Notes with this label will be hidden from the Note Map. | +
newNotesOnTop
+ |
+ New notes will be created at the top of the parent note, not on the bottom. | +
hideHighlightWidget
+ |
+ Hide Highlight List widget | +
printLandscape
+ |
+ When exporting to PDF, changes the orientation of the page to landscape + instead of portrait. | +
printPageSize
+ |
+ When exporting to PDF, changes the size of the page. Supported values: A0, A1, A2, A3, A4, A5, A6, Legal, Letter, Tabloid, Ledger. |
+
Relations
+
+
+
+
+ | Label | +Description | +
|---|---|
runOnNoteCreation
+ |
+ executes when note is created on backend. Use this relation if you want + to run the script for all notes created under a specific subtree. In that + case, create it on the subtree root note and make it inheritable. A new + note created within the subtree (any depth) will trigger the script. | +
runOnChildNoteCreation
+ |
+ executes when new note is created under the note where this relation is + defined | +
runOnNoteTitleChange
+ |
+ executes when note title is changed (includes note creation as well) | +
runOnNoteContentChange
+ |
+ executes when note content is changed (includes note creation as well). | +
runOnNoteChange
+ |
+ executes when note is changed (includes note creation as well). Does not + include content changes | +
runOnNoteDeletion
+ |
+ executes when note is being deleted | +
runOnBranchCreation
+ |
+ executes when a branch is created. Branch is a link between parent note + and child note and is created e.g. when cloning or moving note. | +
runOnBranchChange
+ |
+ executes when a branch is updated. | +
runOnBranchDeletion
+ |
+ executes when a branch is deleted. Branch is a link between parent note + and child note and is deleted e.g. when moving note (old branch/link is + deleted). | +
runOnAttributeCreation
+ |
+ executes when new attribute is created for the note which defines this + relation | +
runOnAttributeChange
+ |
+ executes when the attribute is changed of a note which defines this relation. + This is triggered also when the attribute is deleted | +
template
+ |
+ note's attributes will be inherited even without a parent-child relationship, + note's content and subtree will be added to instance notes if empty. See + documentation for details. | +
inherit
+ |
+ note's attributes will be inherited even without a parent-child relationship. + See Templates for + a similar concept. See Attribute Inheritance in + the documentation. | +
renderNote
+ |
+ notes of type Render Note will + be rendered using a code note (HTML or script) and it is necessary to point + using this relation to which note should be rendered | +
widget_relation
+ |
+ target of this relation will be executed and rendered as a widget in the + sidebar | +
shareCss
+ |
+ CSS note which will be injected into the share page. CSS note must be
+ in the shared sub-tree as well. Consider using share_hidden_from_tree and share_omit_default_css as
+ well. |
+
shareJs
+ |
+ JavaScript note which will be injected into the share page. JS note must
+ be in the shared sub-tree as well. Consider using share_hidden_from_tree. |
+
shareTemplate
+ |
+ Embedded JavaScript note that will be used as the template for displaying
+ the shared note. Falls back to the default template. Consider using share_hidden_from_tree. |
+
shareFavicon
+ |
+ Favicon note to be set in the shared page. Typically you want to set it
+ to share root and make it inheritable. Favicon note must be in the shared
+ sub-tree as well. Consider using share_hidden_from_tree. |
+
+
-
+
disableVersioning: Disables automatic versioning, ideal for + large, unimportant notes like script libraries
+ versioningLimit: Used to limit the number of revisions for + a single note
+ calendarRoot: Marks the note as the root for Day Notes. Only one + note should carry this label.
+ excludeFromExport: Excludes notes and their subtrees from + export operations
+ run: Specifies events to trigger scripts (e.g.,frontendStartup,hourly)
+ runAtHour: Defines specific hours for scripts to run, used + with#run=hourly+
+ disableInclusion: Prevents a script from being included in + parent script executions
+ sorted: Automatically sorts child notes alphabetically by + title
+ top: Keeps the note at the top of its parent's list, useful + withsorted+
+ hidePromotedAttributes: Hides certain attributes in the note's + display
+ readOnly: Sets the note to read-only mode, applicable to + text and code notes
+ autoReadOnlyDisabled: Disables automatic read-only mode for + large notes
+ appCss: Marks CSS notes used to modify Trilium’s appearance
+ appTheme: Marks full CSS themes available in Trilium's options
+ cssClass: Adds a CSS class to the note's representation in + the tree
+ iconClass: Adds a CSS class to the note's icon, useful for + distinguishing notes visually. See Note Icons.
+ pageSize: Specifies the number of items per page in note + listings
+ customRequestHandlerandcustomResourceProvider: + Refer to Custom Request Handler +
+ widget: Marks a note as a custom widget, added to Trilium's + component tree
+ workspaceand related attributes: See + Workspace for more details
+ searchHome: Specifies the parent for new search notes
+ inbox: Designates a default location for new notes created + via the sidebar
+ sqlConsoleHome: Default location for SQL console notes
+ bookmarkedandbookmarkFolder: + See Bookmarks +
+ share:[…]: See Sharing +
+ keyboardShortcut: Assigns a keyboard shortcut to open the + note
+ displayRelationsandhideRelations: + Manages the display of note relations
+ titleTemplate: See Default Note Title +
+ template: Makes the note available as a template
+ toc: Controls the visibility of the table of contents
+ color: Defines the color of the note in the tree and links
+ hideChildrenOverview: Hides child notes in the parent note's + editor
+ viewType: Sets the view of child notes (grid or list)
+