From 40971afe4f50bd3a2157cf6618ec25a94d1d18ad Mon Sep 17 00:00:00 2001 From: zadam <zadam.apps@gmail.com> Date: Wed, 6 Sep 2023 09:25:00 +0200 Subject: [PATCH] API docs build --- docs/backend_api/AbstractBeccaEntity.html | 4 +- docs/backend_api/BAttachment.html | 7 +- docs/backend_api/BAttribute.html | 7 +- docs/backend_api/BBranch.html | 16 +- docs/backend_api/BEtapiToken.html | 12 +- docs/backend_api/BNote.html | 42 +++- docs/backend_api/BOption.html | 4 +- docs/backend_api/BRecentNote.html | 4 +- docs/backend_api/BRevision.html | 7 +- docs/backend_api/BackendScriptApi.html | 218 +++++++++++++++++- docs/backend_api/global.html | 4 +- docs/frontend_api/BasicWidget.html | 8 +- docs/frontend_api/FAttachment.html | 3 +- docs/frontend_api/FAttribute.html | 3 +- docs/frontend_api/FBranch.html | 3 +- docs/frontend_api/FNote.html | 106 ++++----- docs/frontend_api/FrontendScriptApi.html | 155 +++++++++---- docs/frontend_api/NoteContextAwareWidget.html | 7 +- docs/frontend_api/RightPanelWidget.html | 7 +- docs/frontend_api/global.html | 4 +- .../services_frontend_script_api.js.html | 6 +- 21 files changed, 488 insertions(+), 139 deletions(-) diff --git a/docs/backend_api/AbstractBeccaEntity.html b/docs/backend_api/AbstractBeccaEntity.html index 9ad79dac68..a053dfecdd 100644 --- a/docs/backend_api/AbstractBeccaEntity.html +++ b/docs/backend_api/AbstractBeccaEntity.html @@ -828,7 +828,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BAttachment.html b/docs/backend_api/BAttachment.html index 1ab7b403f9..26cf922cb9 100644 --- a/docs/backend_api/BAttachment.html +++ b/docs/backend_api/BAttachment.html @@ -30,7 +30,8 @@ <h1 class="page-title">Class: BAttachment</h1> <h2><span class="attribs"><span class="type-signature"></span></span>BAttachment<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for larger amounts of data and generally not accessible to the user.</div> + <div class="class-description">Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for +larger amounts of data and generally not accessible to the user.</div> </header> @@ -2220,7 +2221,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BAttribute.html b/docs/backend_api/BAttribute.html index cc67f76422..b505943bb7 100644 --- a/docs/backend_api/BAttribute.html +++ b/docs/backend_api/BAttribute.html @@ -30,7 +30,8 @@ <h1 class="page-title">Class: BAttribute</h1> <h2><span class="attribs"><span class="type-signature"></span></span>BAttribute<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)</div> + <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair) +and relation (representing named relationship between source and target note)</div> </header> @@ -1735,7 +1736,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BBranch.html b/docs/backend_api/BBranch.html index b1ad91429e..610e66e660 100644 --- a/docs/backend_api/BBranch.html +++ b/docs/backend_api/BBranch.html @@ -30,7 +30,11 @@ <h1 class="page-title">Class: BBranch</h1> <h2><span class="attribs"><span class="type-signature"></span></span>BBranch<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple parents. Note that you should not rely on the branch's identity, since it can change easily with a note's move. Always check noteId instead.</div> + <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple +parents. + +Note that you should not rely on the branch's identity, since it can change easily with a note's move. +Always check noteId instead.</div> </header> @@ -417,7 +421,11 @@ <h4 class="name" id="isWeak"><span class="type-signature"></span>isWeak<span cla <div class="description"> - Branch is weak when its existence should not hinder deletion of its note. As a result, note with only weak branches should be immediately deleted. An example is shared or bookmarked clones - they are created automatically and exist for technical reasons, not as user-intended actions. From user perspective, they don't count as real clones and for the purpose of deletion should not act as a clone. + Branch is weak when its existence should not hinder deletion of its note. +As a result, note with only weak branches should be immediately deleted. +An example is shared or bookmarked clones - they are created automatically and exist for technical reasons, +not as user-intended actions. From user perspective, they don't count as real clones and for the purpose +of deletion should not act as a clone. </div> @@ -1842,7 +1850,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BEtapiToken.html b/docs/backend_api/BEtapiToken.html index 4fc6771204..8d33387fa8 100644 --- a/docs/backend_api/BEtapiToken.html +++ b/docs/backend_api/BEtapiToken.html @@ -30,7 +30,13 @@ <h1 class="page-title">Class: BEtapiToken</h1> <h2><span class="attribs"><span class="type-signature"></span></span>BEtapiToken<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications. Used by: - Trilium Sender - ETAPI clients The format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish it from tokenHash and token.</div> + <div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications. +Used by: +- Trilium Sender +- ETAPI clients + +The format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish it +from tokenHash and token.</div> </header> @@ -1287,7 +1293,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BNote.html b/docs/backend_api/BNote.html index e7eef679a5..b4173c71fa 100644 --- a/docs/backend_api/BNote.html +++ b/docs/backend_api/BNote.html @@ -1325,7 +1325,8 @@ <h4 class="name" id="addAttribute"><span class="type-signature"></span>addAttrib <div class="description"> - Adds a new attribute to this note. The attribute is saved and returned. See addLabel, addRelation for more specific methods. + Adds a new attribute to this note. The attribute is saved and returned. +See addLabel, addRelation for more specific methods. </div> @@ -1896,7 +1897,8 @@ <h4 class="name" id="addRelation"><span class="type-signature"></span>addRelatio <div class="description"> - Adds a new relation to this note. The relation attribute is saved and returned. + Adds a new relation to this note. The relation attribute is saved and +returned. </div> @@ -2376,7 +2378,17 @@ <h4 class="name" id="convertToParentAttachment"><span class="type-signature"></s <div class="description"> - Some notes are eligible for conversion into an attachment of its parent, note must have these properties: - it has exactly one target relation - it has a relation from its parent note - it has no children - it has no clones - the parent is of type text - both notes are either unprotected or user is in protected session Currently, works only for image notes. In the future, this functionality might get more generic and some of the requirements relaxed. + Some notes are eligible for conversion into an attachment of its parent, note must have these properties: +- it has exactly one target relation +- it has a relation from its parent note +- it has no children +- it has no clones +- the parent is of type text +- both notes are either unprotected or user is in protected session + +Currently, works only for image notes. + +In the future, this functionality might get more generic and some of the requirements relaxed. </div> @@ -3627,7 +3639,8 @@ <h5>Returns:</h5> <div class="param-desc"> - attribute of the given type and name. If there are more such attributes, first is returned. Returns null if there's no such attribute belonging to this note. + attribute of the given type and name. If there are more such attributes, first is returned. + Returns null if there's no such attribute belonging to this note. </div> @@ -3845,7 +3858,8 @@ <h4 class="name" id="getAttributes"><span class="type-signature"></span>getAttri <div class="description"> - Beware that the method must not create a copy of the array, but actually returns its internal array (for performance reasons) + Beware that the method must not create a copy of the array, but actually returns its internal array +(for performance reasons) </div> @@ -5008,7 +5022,9 @@ <h4 class="name" id="getFlatText"><span class="type-signature"></span>getFlatTex <div class="description"> - This is used for: - fast searching - note similarity evaluation + This is used for: +- fast searching +- note similarity evaluation </div> @@ -5187,7 +5203,8 @@ <h5>Returns:</h5> <div class="param-desc"> - - returns only notes which are templated, does not include their subtrees in effect returns notes which are influenced by note's non-inheritable attributes + - returns only notes which are templated, does not include their subtrees + in effect returns notes which are influenced by note's non-inheritable attributes </div> @@ -6045,7 +6062,9 @@ <h5>Returns:</h5> <div class="param-desc"> - attribute belonging to this specific note (excludes inherited attributes) This method can be significantly faster than the getAttribute() + attribute belonging to this specific note (excludes inherited attributes) + +This method can be significantly faster than the getAttribute() </div> @@ -6263,7 +6282,8 @@ <h4 class="name" id="getOwnedAttributes"><span class="type-signature"></span>get <div class="description"> - Beware that the method must not create a copy of the array, but actually returns its internal array (for performance reasons) + Beware that the method must not create a copy of the array, but actually returns its internal array +(for performance reasons) </div> @@ -12101,7 +12121,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BOption.html b/docs/backend_api/BOption.html index 5c7ef66ae8..bcc6b21688 100644 --- a/docs/backend_api/BOption.html +++ b/docs/backend_api/BOption.html @@ -1151,7 +1151,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BRecentNote.html b/docs/backend_api/BRecentNote.html index ff83f10a1b..329ebdce69 100644 --- a/docs/backend_api/BRecentNote.html +++ b/docs/backend_api/BRecentNote.html @@ -1083,7 +1083,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BRevision.html b/docs/backend_api/BRevision.html index d34781be5c..c665ebda19 100644 --- a/docs/backend_api/BRevision.html +++ b/docs/backend_api/BRevision.html @@ -30,7 +30,8 @@ <h1 class="page-title">Class: BRevision</h1> <h2><span class="attribs"><span class="type-signature"></span></span>BRevision<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">Revision represents a snapshot of note's title and content at some point in the past. It's used for seamless note versioning.</div> + <div class="class-description">Revision represents a snapshot of note's title and content at some point in the past. +It's used for seamless note versioning.</div> </header> @@ -2076,7 +2077,9 @@ <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDe <div class="description"> - Mark the entity as (soft) deleted. It will be completely erased later. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. + Mark the entity as (soft) deleted. It will be completely erased later. + +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. </div> diff --git a/docs/backend_api/BackendScriptApi.html b/docs/backend_api/BackendScriptApi.html index fb7f797354..e75f1082c4 100644 --- a/docs/backend_api/BackendScriptApi.html +++ b/docs/backend_api/BackendScriptApi.html @@ -49,7 +49,8 @@ <h4 class="name" id="BackendScriptApi"><span class="type-signature"></span>new B <div class="description"> - <p>This is the main backend API interface for scripts. All the properties and methods are published in the "api" object available in the JS backend notes. You can use e.g. <code>api.log(api.startNote.title);</code></p> + <p>This is the main backend API interface for scripts. All the properties and methods are published in the "api" object +available in the JS backend notes. You can use e.g. <code>api.log(api.startNote.title);</code></p> </div> @@ -239,7 +240,7 @@ <h5 class="subsection-title">Properties:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line566">line 566</a> + <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line608">line 608</a> </li></ul></dd> @@ -781,7 +782,8 @@ <h4 class="name" id="createDataNote"><span class="type-signature"></span>createD <div class="description"> - Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and JSON MIME type. See also createNewNote() for more options. + Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and +JSON MIME type. See also createNewNote() for more options. </div> @@ -2290,7 +2292,10 @@ <h6>Properties</h6> </td> - <td class="description last">one of * "note" - activating the launcher will navigate to the target note (specified in targetNoteId param) * "script" - activating the launcher will execute the script (specified in scriptNoteId param) * "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param)</td> + <td class="description last">one of + * "note" - activating the launcher will navigate to the target note (specified in targetNoteId param) + * "script" - activating the launcher will execute the script (specified in scriptNoteId param) + * "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param)</td> </tr> @@ -4213,7 +4218,8 @@ <h4 class="name" id="getInstanceName"><span class="type-signature"></span>getIns <div class="description"> - Instance name identifies particular Trilium instance. It can be useful for scripts if some action needs to happen on only one specific instance. + Instance name identifies particular Trilium instance. It can be useful for scripts +if some action needs to happen on only one specific instance. </div> @@ -6160,6 +6166,191 @@ <h5>Returns:</h5> + <h4 class="name" id="runOnFrontend"><span class="type-signature"></span>runOnFrontend<span class="signature">(script, params)</span><span class="type-signature"> → {undefined}</span></h4> + + + + + + +<div class="description"> + Executes given anonymous function on the frontend(s). +Internally this serializes the anonymous function into string and sends it to frontend(s) via WebSocket. +Note that there can be multiple connected frontend instances (e.g. in different tabs). In such case, all +instances execute the given function. +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>script</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last">script to be executed on the frontend</td> + </tr> + + + + <tr> + + <td class="name"><code>params</code></td> + + + <td class="type"> + + +<span class="param-type">Array.<?></span> + + + + </td> + + + + + + <td class="description last">list of parameters to the anonymous function to be sent to frontend</td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line572">line 572</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + - no return value is provided. +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">undefined</span> + + + </dd> +</dl> + + + + + + + + + + + + + <h4 class="name" id="searchForNote"><span class="type-signature"></span>searchForNote<span class="signature">(query, searchParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="BNote.html">BNote</a>|null}</span></h4> @@ -6168,7 +6359,8 @@ <h4 class="name" id="searchForNote"><span class="type-signature"></span>searchFo <div class="description"> - This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See <a href="https://github.com/zadam/trilium/wiki/Search">https://github.com/zadam/trilium/wiki/Search</a> for full documentation for all options + This is a powerful search method - you can search by attributes and their values, e.g.: +"#dateModified =* MONTH AND #log". See <a href="https://github.com/zadam/trilium/wiki/Search">https://github.com/zadam/trilium/wiki/Search</a> for full documentation for all options </div> @@ -6369,7 +6561,8 @@ <h4 class="name" id="searchForNotes"><span class="type-signature"></span>searchF <div class="description"> - This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See <a href="https://github.com/zadam/trilium/wiki/Search">https://github.com/zadam/trilium/wiki/Search</a> for full documentation for all options + This is a powerful search method - you can search by attributes and their values, e.g.: +"#dateModified =* MONTH AND #log". See <a href="https://github.com/zadam/trilium/wiki/Search">https://github.com/zadam/trilium/wiki/Search</a> for full documentation for all options </div> @@ -6567,7 +6760,10 @@ <h4 class="name" id="setNoteToParent"><span class="type-signature"></span>setNot <div class="description"> - This method finds note by its noteId and prefix and either sets it to the given parentNoteId or removes the branch (if parentNoteId is not given). This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix. + This method finds note by its noteId and prefix and either sets it to the given parentNoteId +or removes the branch (if parentNoteId is not given). + +This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix. </div> @@ -6930,7 +7126,8 @@ <h6>Properties</h6> </td> - <td class="description last">'title', 'dateCreated', 'dateModified' or a label name See <a href="https://github.com/zadam/trilium/wiki/Sorting">https://github.com/zadam/trilium/wiki/Sorting</a> for details.</td> + <td class="description last">'title', 'dateCreated', 'dateModified' or a label name + See <a href="https://github.com/zadam/trilium/wiki/Sorting">https://github.com/zadam/trilium/wiki/Sorting</a> for details.</td> </tr> @@ -7342,7 +7539,8 @@ <h4 class="name" id="transactional"><span class="type-signature"></span>transact <div class="description"> - This functions wraps code which is supposed to be running in transaction. If transaction already exists, then we'll use that transaction. + This functions wraps code which is supposed to be running in transaction. If transaction already +exists, then we'll use that transaction. </div> diff --git a/docs/backend_api/global.html b/docs/backend_api/global.html index afe7a2b2a8..4232520c47 100644 --- a/docs/backend_api/global.html +++ b/docs/backend_api/global.html @@ -448,7 +448,9 @@ <h4 class="name" id="NoteType">NoteType</h4> <div class="description"> - There are many different Note types, some of which are entirely opaque to the end user. Those types should be used only for checking against, they are not for direct use. + There are many different Note types, some of which are entirely opaque to the +end user. Those types should be used only for checking against, they are +not for direct use. </div> diff --git a/docs/frontend_api/BasicWidget.html b/docs/frontend_api/BasicWidget.html index 72d278e0df..5383fc3b31 100644 --- a/docs/frontend_api/BasicWidget.html +++ b/docs/frontend_api/BasicWidget.html @@ -30,7 +30,9 @@ <h1 class="page-title">Class: BasicWidget</h1> <h2><span class="attribs"><span class="type-signature"></span></span>BasicWidget<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">This is the base widget for all other widgets. For information on using widgets, see the tutorial widget_basics.</div> + <div class="class-description">This is the base widget for all other widgets. + +For information on using widgets, see the tutorial widget_basics.</div> </header> @@ -316,7 +318,9 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span <div class="description"> - Method used for rendering the widget. Your class should override this method. + Method used for rendering the widget. + +Your class should override this method. </div> diff --git a/docs/frontend_api/FAttachment.html b/docs/frontend_api/FAttachment.html index 0c3cc8a79d..50127636a5 100644 --- a/docs/frontend_api/FAttachment.html +++ b/docs/frontend_api/FAttachment.html @@ -30,7 +30,8 @@ <h1 class="page-title">Class: FAttachment</h1> <h2><span class="attribs"><span class="type-signature"></span></span>FAttachment<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">Attachment is a file directly tied into a note without being a hidden child.</div> + <div class="class-description">Attachment is a file directly tied into a note without +being a hidden child.</div> </header> diff --git a/docs/frontend_api/FAttribute.html b/docs/frontend_api/FAttribute.html index 4ef3ae3ee1..7c31036274 100644 --- a/docs/frontend_api/FAttribute.html +++ b/docs/frontend_api/FAttribute.html @@ -30,7 +30,8 @@ <h1 class="page-title">Class: FAttribute</h1> <h2><span class="attribs"><span class="type-signature"></span></span>FAttribute<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)</div> + <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair) +and relation (representing named relationship between source and target note)</div> </header> diff --git a/docs/frontend_api/FBranch.html b/docs/frontend_api/FBranch.html index 45783d3c1c..7446e66dab 100644 --- a/docs/frontend_api/FBranch.html +++ b/docs/frontend_api/FBranch.html @@ -30,7 +30,8 @@ <h1 class="page-title">Class: FBranch</h1> <h2><span class="attribs"><span class="type-signature"></span></span>FBranch<span class="signature">()</span><span class="type-signature"></span></h2> - <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple parents.</div> + <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple +parents.</div> </header> diff --git a/docs/frontend_api/FNote.html b/docs/frontend_api/FNote.html index c5db332ba5..92b8be652a 100644 --- a/docs/frontend_api/FNote.html +++ b/docs/frontend_api/FNote.html @@ -1172,7 +1172,7 @@ <h4 class="name" id="getAllNotePaths"><span class="type-signature"></span>getAll <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line373">line 373</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line372">line 372</a> </li></ul></dd> @@ -1278,7 +1278,7 @@ <h4 class="name" id="getAttachmentById"><span class="type-signature">(async) </s <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line260">line 260</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line259">line 259</a> </li></ul></dd> @@ -1380,7 +1380,7 @@ <h4 class="name" id="getAttachments"><span class="type-signature">(async) </span <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line251">line 251</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line250">line 250</a> </li></ul></dd> @@ -1554,7 +1554,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line636">line 636</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line635">line 635</a> </li></ul></dd> @@ -1732,7 +1732,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line658">line 658</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line657">line 657</a> </li></ul></dd> @@ -1932,7 +1932,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line307">line 307</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line306">line 306</a> </li></ul></dd> @@ -2111,7 +2111,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line429">line 429</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line428">line 428</a> </li></ul></dd> @@ -2290,7 +2290,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line439">line 439</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line438">line 438</a> </li></ul></dd> @@ -2396,7 +2396,7 @@ <h4 class="name" id="getBlob"><span class="type-signature">(async) </span>getBlo <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line883">line 883</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line882">line 882</a> </li></ul></dd> @@ -2500,7 +2500,7 @@ <h4 class="name" id="getBranchIds"><span class="type-signature"></span>getBranch <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line172">line 172</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line171">line 171</a> </li></ul></dd> @@ -2604,7 +2604,7 @@ <h4 class="name" id="getBranches"><span class="type-signature"></span>getBranche <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line189">line 189</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line188">line 188</a> </li></ul></dd> @@ -2706,7 +2706,7 @@ <h4 class="name" id="getChildBranches"><span class="type-signature"></span>getCh <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line199">line 199</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line198">line 198</a> </li></ul></dd> @@ -2808,7 +2808,7 @@ <h4 class="name" id="getChildNoteIds"><span class="type-signature"></span>getChi <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line241">line 241</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line240">line 240</a> </li></ul></dd> @@ -2910,7 +2910,7 @@ <h4 class="name" id="getChildNotes"><span class="type-signature">(async) </span> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line246">line 246</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line245">line 245</a> </li></ul></dd> @@ -3061,7 +3061,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line712">line 712</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line711">line 711</a> </li></ul></dd> @@ -3216,7 +3216,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line736">line 736</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line735">line 735</a> </li></ul></dd> @@ -3383,7 +3383,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line522">line 522</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line521">line 521</a> </li></ul></dd> @@ -3491,7 +3491,7 @@ <h4 class="name" id="getNoteComplement"><span class="type-signature">(async) </s <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line878">line 878</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line877">line 877</a> </li></ul></dd> @@ -3593,7 +3593,7 @@ <h4 class="name" id="getNotesToInheritAttributesFrom"><span class="type-signatur <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line778">line 778</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line777">line 777</a> </li></ul></dd> @@ -3767,7 +3767,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line625">line 625</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line624">line 624</a> </li></ul></dd> @@ -3945,7 +3945,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line647">line 647</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line646">line 646</a> </li></ul></dd> @@ -4145,7 +4145,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line294">line 294</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line293">line 293</a> </li></ul></dd> @@ -4300,7 +4300,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line706">line 706</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line705">line 705</a> </li></ul></dd> @@ -4455,7 +4455,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line730">line 730</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line729">line 729</a> </li></ul></dd> @@ -4622,7 +4622,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line514">line 514</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line513">line 513</a> </li></ul></dd> @@ -4777,7 +4777,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line718">line 718</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line717">line 717</a> </li></ul></dd> @@ -4932,7 +4932,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line742">line 742</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line741">line 741</a> </li></ul></dd> @@ -5099,7 +5099,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line588">line 588</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line587">line 587</a> </li></ul></dd> @@ -5205,7 +5205,7 @@ <h4 class="name" id="getParentBranchIds"><span class="type-signature"></span>get <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line164">line 164</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line163">line 163</a> </li></ul></dd> @@ -5307,7 +5307,7 @@ <h4 class="name" id="getParentBranches"><span class="type-signature"></span>getP <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line179">line 179</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line178">line 178</a> </li></ul></dd> @@ -5409,7 +5409,7 @@ <h4 class="name" id="getParentNoteIds"><span class="type-signature"></span>getPa <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line207">line 207</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line206">line 206</a> </li></ul></dd> @@ -5511,7 +5511,7 @@ <h4 class="name" id="getParentNotes"><span class="type-signature"></span>getPare <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line212">line 212</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line211">line 211</a> </li></ul></dd> @@ -5662,7 +5662,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line724">line 724</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line723">line 723</a> </li></ul></dd> @@ -5817,7 +5817,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line754">line 754</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line753">line 753</a> </li></ul></dd> @@ -5987,7 +5987,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line764">line 764</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line763">line 763</a> </li></ul></dd> @@ -6138,7 +6138,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line748">line 748</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line747">line 747</a> </li></ul></dd> @@ -6305,7 +6305,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line596">line 596</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line595">line 595</a> </li></ul></dd> @@ -6411,7 +6411,7 @@ <h4 class="name" id="getScriptEnv"><span class="type-signature"></span>getScript <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line927">line 927</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line926">line 926</a> </li></ul></dd> @@ -6589,7 +6589,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line395">line 395</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line394">line 394</a> </li></ul></dd> @@ -6695,7 +6695,7 @@ <h4 class="name" id="getTargetRelationSourceNotes"><span class="type-signature"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line868">line 868</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line867">line 867</a> </li></ul></dd> @@ -6801,7 +6801,7 @@ <h4 class="name" id="getTargetRelations"><span class="type-signature"></span>get <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line858">line 858</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line857">line 857</a> </li></ul></dd> @@ -6975,7 +6975,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line605">line 605</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line604">line 604</a> </li></ul></dd> @@ -7081,7 +7081,7 @@ <h4 class="name" id="hasChildren"><span class="type-signature"></span>hasChildre <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line194">line 194</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line193">line 193</a> </li></ul></dd> @@ -7232,7 +7232,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line674">line 674</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line673">line 673</a> </li></ul></dd> @@ -7410,7 +7410,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line616">line 616</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line615">line 615</a> </li></ul></dd> @@ -7565,7 +7565,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line668">line 668</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line667">line 667</a> </li></ul></dd> @@ -7720,7 +7720,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line694">line 694</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line693">line 693</a> </li></ul></dd> @@ -7875,7 +7875,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line700">line 700</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line699">line 699</a> </li></ul></dd> @@ -7983,7 +7983,7 @@ <h4 class="name" id="invalidateAttributeCache"><span class="type-signature"></sp <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line851">line 851</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line850">line 850</a> </li></ul></dd> @@ -8067,7 +8067,7 @@ <h4 class="name" id="isHiddenCompletely"><span class="type-signature"></span>isH <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line448">line 448</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line447">line 447</a> </li></ul></dd> @@ -8161,7 +8161,7 @@ <h4 class="name" id="isHtml"><span class="type-signature"></span>isHtml<span cla <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line922">line 922</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line921">line 921</a> </li></ul></dd> @@ -8267,7 +8267,7 @@ <h4 class="name" id="isJavaScript"><span class="type-signature"></span>isJavaScr <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line914">line 914</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line913">line 913</a> </li></ul></dd> @@ -8524,7 +8524,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line680">line 680</a> + <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line679">line 679</a> </li></ul></dd> diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html index d949cb13fe..0d31af9d89 100644 --- a/docs/frontend_api/FrontendScriptApi.html +++ b/docs/frontend_api/FrontendScriptApi.html @@ -49,7 +49,8 @@ <h4 class="name" id="FrontendScriptApi"><span class="type-signature"></span>new <div class="description"> - <p>This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object available in the JS frontend notes. You can use e.g. <code>api.showMessage(api.startNote.title);</code></p> + <p>This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object +available in the JS frontend notes. You can use e.g. <code>api.showMessage(api.startNote.title);</code></p> </div> @@ -461,7 +462,7 @@ <h4 class="name" id="createNoteLink"><span class="type-signature"></span>createN <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line338">line 338</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line340">line 340</a> </li></ul></dd> @@ -557,7 +558,8 @@ <h4 class="name" id="dayjs"><span class="type-signature"></span>dayjs<span class <div class="description"> - day.js library for date manipulation. See <a href="https://day.js.org">https://day.js.org</a> for documentation + day.js library for date manipulation. +See <a href="https://day.js.org">https://day.js.org</a> for documentation </div> @@ -1273,7 +1275,8 @@ <h6>Properties</h6> - <td class="description last">id of the button, used to identify the old instances of this button to be replaced ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.</td> + <td class="description last">id of the button, used to identify the old instances of this button to be replaced + ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.</td> </tr> @@ -1375,7 +1378,8 @@ <h6>Properties</h6> - <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>you can now create/modify launchers in the top-left Menu -> Configure Launchbar for special needs there's also backend API's createOrUpdateLauncher()</li></ul></dd> + <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>you can now create/modify launchers in the top-left Menu -> Configure Launchbar + for special needs there's also backend API's createOrUpdateLauncher()</li></ul></dd> @@ -1526,7 +1530,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line346">line 346</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line348">line 348</a> </li></ul></dd> @@ -1692,7 +1696,8 @@ <h5>Parameters:</h5> - <td class="description last">specify namespace of the handler for the cases where call for bind may be repeated. If a handler with this ID exists, it's replaced by the new handler.</td> + <td class="description last">specify namespace of the handler for the cases where call for bind may be repeated. + If a handler with this ID exists, it's replaced by the new handler.</td> </tr> @@ -1733,7 +1738,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line488">line 488</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line490">line 490</a> </li></ul></dd> @@ -1787,7 +1792,7 @@ <h5>Returns:</h5> - <h4 class="name" id="createLink"><span class="type-signature"></span>createLink<span class="signature">(notePath, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + <h4 class="name" id="createLink"><span class="type-signature"></span>createLink<span class="signature">(notePath, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {jQuery}</span></h4> @@ -2058,6 +2063,43 @@ <h6>Properties</h6> + </td> + + + + <td class="default"> + + </td> + + + <td class="description last">custom link tile with note's title as default</td> + </tr> + + + + <tr> + + <td class="name"><code>title=</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + </td> @@ -2115,7 +2157,7 @@ <h6>Properties</h6> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line335">line 335</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line337">line 337</a> </li></ul></dd> @@ -2140,6 +2182,28 @@ <h6>Properties</h6> +<h5>Returns:</h5> + + +<div class="param-desc"> + - jQuery element with the link (wrapped in <span>) +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">jQuery</span> + + + </dd> +</dl> + + @@ -2405,7 +2469,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line532">line 532</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line534">line 534</a> </li></ul></dd> @@ -2560,7 +2624,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line524">line 524</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line526">line 526</a> </li></ul></dd> @@ -2670,7 +2734,7 @@ <h4 class="name" id="getActiveContextCodeEditor"><span class="type-signature"></ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line368">line 368</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line370">line 370</a> </li></ul></dd> @@ -2776,7 +2840,7 @@ <h4 class="name" id="getActiveContextNote"><span class="type-signature"></span>g <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line352">line 352</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line354">line 354</a> </li></ul></dd> @@ -2882,7 +2946,7 @@ <h4 class="name" id="getActiveContextNotePath"><span class="type-signature"></sp <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line383">line 383</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line385">line 385</a> </li></ul></dd> @@ -2992,7 +3056,7 @@ <h4 class="name" id="getActiveContextTextEditor"><span class="type-signature"></ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line360">line 360</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line362">line 362</a> </li></ul></dd> @@ -3058,7 +3122,8 @@ <h4 class="name" id="getActiveNoteDetailWidget"><span class="type-signature"></s <div class="description"> - Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the implementation of actual widget type. + Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the +implementation of actual widget type. </div> @@ -3102,7 +3167,7 @@ <h4 class="name" id="getActiveNoteDetailWidget"><span class="type-signature"></s <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line377">line 377</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line379">line 379</a> </li></ul></dd> @@ -3257,7 +3322,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line392">line 392</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line394">line 394</a> </li></ul></dd> @@ -3412,7 +3477,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line436">line 436</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line438">line 438</a> </li></ul></dd> @@ -3474,7 +3539,8 @@ <h4 class="name" id="getInstanceName"><span class="type-signature"></span>getIns <div class="description"> - Instance name identifies particular Trilium instance. It can be useful for scripts if some action needs to happen on only one specific instance. + Instance name identifies particular Trilium instance. It can be useful for scripts +if some action needs to happen on only one specific instance. </div> @@ -3673,7 +3739,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line454">line 454</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line456">line 456</a> </li></ul></dd> @@ -3735,7 +3801,8 @@ <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span c <div class="description"> - Returns note by given noteId. If note is missing from the cache, it's loaded. * + Returns note by given noteId. If note is missing from the cache, it's loaded. +* </div> @@ -3890,7 +3957,10 @@ <h4 class="name" id="getNotes"><span class="type-signature"></span>getNotes<span <div class="description"> - Returns list of notes. If note is missing from the cache, it's loaded. This is often used to bulk-fill the cache with notes which would have to be picked one by one otherwise (by e.g. createLink()) + Returns list of notes. If note is missing from the cache, it's loaded. + +This is often used to bulk-fill the cache with notes which would have to be picked one by one +otherwise (by e.g. createLink()) </div> @@ -4132,7 +4202,7 @@ <h4 class="name" id="getTodayNote"><span class="type-signature"></span>getTodayN <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line427">line 427</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line429">line 429</a> </li></ul></dd> @@ -4287,7 +4357,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line445">line 445</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line447">line 447</a> </li></ul></dd> @@ -4442,7 +4512,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line463">line 463</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line465">line 465</a> </li></ul></dd> @@ -4592,7 +4662,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line543">line 543</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line545">line 545</a> </li></ul></dd> @@ -5277,7 +5347,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line407">line 407</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line409">line 409</a> </li></ul></dd> @@ -5451,7 +5521,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line417">line 417</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line419">line 419</a> </li></ul></dd> @@ -5606,7 +5676,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line517">line 517</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line519">line 519</a> </li></ul></dd> @@ -5760,7 +5830,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line508">line 508</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line510">line 510</a> </li></ul></dd> @@ -5959,7 +6029,8 @@ <h4 class="name" id="runOnBackend"><span class="type-signature"></span>runOnBack <div class="description"> - Executes given anonymous function on the backend. Internally this serializes the anonymous function into string and sends it to backend via AJAX. + Executes given anonymous function on the backend. +Internally this serializes the anonymous function into string and sends it to backend via AJAX. </div> @@ -6144,7 +6215,8 @@ <h4 class="name" id="searchForNote"><span class="type-signature"></span>searchFo <div class="description"> - This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search + This is a powerful search method - you can search by attributes and their values, e.g.: +"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search </div> @@ -6299,7 +6371,8 @@ <h4 class="name" id="searchForNotes"><span class="type-signature"></span>searchF <div class="description"> - This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search + This is a powerful search method - you can search by attributes and their values, e.g.: +"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search </div> @@ -6547,7 +6620,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line472">line 472</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line474">line 474</a> </li></ul></dd> @@ -6698,7 +6771,7 @@ <h5>Parameters:</h5> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line399">line 399</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line401">line 401</a> </li></ul></dd> @@ -7354,7 +7427,11 @@ <h4 class="name" id="waitUntilSynced"><span class="type-signature"></span>waitUn <div class="description"> - Trilium runs in a backend and frontend process, when something is changed on the backend from a script, frontend will get asynchronously synchronized. This method returns a promise which resolves once all the backend -> frontend synchronization is finished. Typical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it. + Trilium runs in a backend and frontend process, when something is changed on the backend from a script, +frontend will get asynchronously synchronized. + +This method returns a promise which resolves once all the backend -> frontend synchronization is finished. +Typical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it. </div> @@ -7398,7 +7475,7 @@ <h4 class="name" id="waitUntilSynced"><span class="type-signature"></span>waitUn <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line500">line 500</a> + <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line502">line 502</a> </li></ul></dd> diff --git a/docs/frontend_api/NoteContextAwareWidget.html b/docs/frontend_api/NoteContextAwareWidget.html index 32692483d1..3c5675db50 100644 --- a/docs/frontend_api/NoteContextAwareWidget.html +++ b/docs/frontend_api/NoteContextAwareWidget.html @@ -636,7 +636,9 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span <div class="description"> - Method used for rendering the widget. Your class should override this method. + Method used for rendering the widget. + +Your class should override this method. </div> @@ -857,7 +859,8 @@ <h4 class="name" id="refreshWithNote"><span class="type-signature">(async) </spa <div class="description"> - Override this method to be able to refresh your widget with each note. + Override this method to be able to refresh your +widget with each note. </div> diff --git a/docs/frontend_api/RightPanelWidget.html b/docs/frontend_api/RightPanelWidget.html index eaa4626708..a6bea6e25c 100644 --- a/docs/frontend_api/RightPanelWidget.html +++ b/docs/frontend_api/RightPanelWidget.html @@ -816,7 +816,9 @@ <h4 class="name" id="doRenderBody"><span class="type-signature">(async) </span>d <div class="description"> - Method used for rendering the body of the widget. Your class should override this method. + Method used for rendering the body of the widget. + +Your class should override this method. </div> @@ -1037,7 +1039,8 @@ <h4 class="name" id="refreshWithNote"><span class="type-signature">(async) </spa <div class="description"> - Override this method to be able to refresh your widget with each note. + Override this method to be able to refresh your +widget with each note. </div> diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html index 6d15487aa2..9c8dcdc9df 100644 --- a/docs/frontend_api/global.html +++ b/docs/frontend_api/global.html @@ -471,7 +471,9 @@ <h4 class="name" id="NoteType">NoteType</h4> <div class="description"> - There are many different Note types, some of which are entirely opaque to the end user. Those types should be used only for checking against, they are not for direct use. + There are many different Note types, some of which are entirely opaque to the +end user. Those types should be used only for checking against, they are +not for direct use. </div> diff --git a/docs/frontend_api/services_frontend_script_api.js.html b/docs/frontend_api/services_frontend_script_api.js.html index 7780bc7a55..22934874b1 100644 --- a/docs/frontend_api/services_frontend_script_api.js.html +++ b/docs/frontend_api/services_frontend_script_api.js.html @@ -62,7 +62,7 @@ <h1 class="page-title">Source: services/frontend_script_api.js</h1> * @constructor */ function FrontendScriptApi(startNote, currentNote, originEntity = null, $container = null) { - /** + /** * Container of all the rendered script content * @type {jQuery} * */ @@ -79,7 +79,7 @@ <h1 class="page-title">Source: services/frontend_script_api.js</h1> * @type {FNote} */ this.currentNote = currentNote; - /** + /** * Entity whose event triggered this execution * @type {object|null} */ @@ -359,6 +359,8 @@ <h1 class="page-title">Source: services/frontend_script_api.js</h1> * @param {boolean} [params.showNotePath=false] - show also whole note's path as part of the link * @param {boolean} [params.showNoteIcon=false] - show also note icon before the title * @param {string} [params.title] - custom link tile with note's title as default + * @param {string} [params.title=] - custom link tile with note's title as default + * @returns {jQuery} - jQuery element with the link (wrapped in <span>) */ this.createLink = linkService.createLink;