From 40971afe4f50bd3a2157cf6618ec25a94d1d18ad Mon Sep 17 00:00:00 2001 From: zadam 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 9ad79dac6..a053dfecd 100644 --- a/docs/backend_api/AbstractBeccaEntity.html +++ b/docs/backend_api/AbstractBeccaEntity.html @@ -828,7 +828,9 @@
- 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.
diff --git a/docs/backend_api/BAttachment.html b/docs/backend_api/BAttachment.html index 1ab7b403f..26cf922cb 100644 --- a/docs/backend_api/BAttachment.html +++ b/docs/backend_api/BAttachment.html @@ -30,7 +30,8 @@

BAttachment()

-
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.
+
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.
@@ -2220,7 +2221,9 @@
- 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.
diff --git a/docs/backend_api/BAttribute.html b/docs/backend_api/BAttribute.html index cc67f7642..b505943bb 100644 --- a/docs/backend_api/BAttribute.html +++ b/docs/backend_api/BAttribute.html @@ -30,7 +30,8 @@

BAttribute()

-
Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)
+
Attribute is an abstract concept which has two real uses - label (key - value pair) +and relation (representing named relationship between source and target note)
@@ -1735,7 +1736,9 @@
- 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.
diff --git a/docs/backend_api/BBranch.html b/docs/backend_api/BBranch.html index b1ad91429..610e66e66 100644 --- a/docs/backend_api/BBranch.html +++ b/docs/backend_api/BBranch.html @@ -30,7 +30,11 @@

BBranch()

-
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.
+
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.
@@ -417,7 +421,11 @@
- 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.
@@ -1842,7 +1850,9 @@
- 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.
diff --git a/docs/backend_api/BEtapiToken.html b/docs/backend_api/BEtapiToken.html index 4fc677120..8d33387fa 100644 --- a/docs/backend_api/BEtapiToken.html +++ b/docs/backend_api/BEtapiToken.html @@ -30,7 +30,13 @@

BEtapiToken()

-
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 "_". This is also called "authToken" to distinguish it from tokenHash and token.
+
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 "_". This is also called "authToken" to distinguish it +from tokenHash and token.
@@ -1287,7 +1293,9 @@
- 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.
diff --git a/docs/backend_api/BNote.html b/docs/backend_api/BNote.html index e7eef679a..b4173c71f 100644 --- a/docs/backend_api/BNote.html +++ b/docs/backend_api/BNote.html @@ -1325,7 +1325,8 @@
- 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.
@@ -1896,7 +1897,8 @@
- 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.
@@ -2376,7 +2378,17 @@
- 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.
@@ -3627,7 +3639,8 @@
- 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.
@@ -3845,7 +3858,8 @@
- 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)
@@ -5008,7 +5022,9 @@
- This is used for: - fast searching - note similarity evaluation + This is used for: +- fast searching +- note similarity evaluation
@@ -5187,7 +5203,8 @@
- - 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
@@ -6045,7 +6062,9 @@
- 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()
@@ -6263,7 +6282,8 @@
- 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)
@@ -12101,7 +12121,9 @@
- 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.
diff --git a/docs/backend_api/BOption.html b/docs/backend_api/BOption.html index 5c7ef66ae..bcc6b2168 100644 --- a/docs/backend_api/BOption.html +++ b/docs/backend_api/BOption.html @@ -1151,7 +1151,9 @@
- 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.
diff --git a/docs/backend_api/BRecentNote.html b/docs/backend_api/BRecentNote.html index ff83f10a1..329ebdce6 100644 --- a/docs/backend_api/BRecentNote.html +++ b/docs/backend_api/BRecentNote.html @@ -1083,7 +1083,9 @@
- 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.
diff --git a/docs/backend_api/BRevision.html b/docs/backend_api/BRevision.html index d34781be5..c665ebda1 100644 --- a/docs/backend_api/BRevision.html +++ b/docs/backend_api/BRevision.html @@ -30,7 +30,8 @@

BRevision()

-
Revision represents a snapshot of note's title and content at some point in the past. It's used for seamless note versioning.
+
Revision represents a snapshot of note's title and content at some point in the past. +It's used for seamless note versioning.
@@ -2076,7 +2077,9 @@
- 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.
diff --git a/docs/backend_api/BackendScriptApi.html b/docs/backend_api/BackendScriptApi.html index fb7f79735..e75f1082c 100644 --- a/docs/backend_api/BackendScriptApi.html +++ b/docs/backend_api/BackendScriptApi.html @@ -49,7 +49,8 @@
-

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. api.log(api.startNote.title);

+

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. api.log(api.startNote.title);

@@ -239,7 +240,7 @@
Source:
@@ -781,7 +782,8 @@
- 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.
@@ -2290,7 +2292,10 @@ - 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) + 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) @@ -4213,7 +4218,8 @@
- 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.
@@ -6160,6 +6166,191 @@ +

runOnFrontend(script, params) → {undefined}

+ + + + + + +
+ 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. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
script + + +string + + + + script to be executed on the frontend
params + + +Array.<?> + + + + list of parameters to the anonymous function to be sent to frontend
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ - no return value is provided. +
+ + + +
+
+ Type +
+
+ +undefined + + +
+
+ + + + + + + + + + + + +

searchForNote(query, searchParamsopt) → {BNote|null}

@@ -6168,7 +6359,8 @@
- This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See https://github.com/zadam/trilium/wiki/Search 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 https://github.com/zadam/trilium/wiki/Search for full documentation for all options
@@ -6369,7 +6561,8 @@
- This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See https://github.com/zadam/trilium/wiki/Search 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 https://github.com/zadam/trilium/wiki/Search for full documentation for all options
@@ -6567,7 +6760,10 @@
- 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.
@@ -6930,7 +7126,8 @@ - 'title', 'dateCreated', 'dateModified' or a label name See https://github.com/zadam/trilium/wiki/Sorting for details. + 'title', 'dateCreated', 'dateModified' or a label name + See https://github.com/zadam/trilium/wiki/Sorting for details. @@ -7342,7 +7539,8 @@
- 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.
diff --git a/docs/backend_api/global.html b/docs/backend_api/global.html index afe7a2b2a..4232520c4 100644 --- a/docs/backend_api/global.html +++ b/docs/backend_api/global.html @@ -448,7 +448,9 @@
- 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.
diff --git a/docs/frontend_api/BasicWidget.html b/docs/frontend_api/BasicWidget.html index 72d278e0d..5383fc3b3 100644 --- a/docs/frontend_api/BasicWidget.html +++ b/docs/frontend_api/BasicWidget.html @@ -30,7 +30,9 @@

BasicWidget()

-
This is the base widget for all other widgets. For information on using widgets, see the tutorial widget_basics.
+
This is the base widget for all other widgets. + +For information on using widgets, see the tutorial widget_basics.
@@ -316,7 +318,9 @@
- Method used for rendering the widget. Your class should override this method. + Method used for rendering the widget. + +Your class should override this method.
diff --git a/docs/frontend_api/FAttachment.html b/docs/frontend_api/FAttachment.html index 0c3cc8a79..50127636a 100644 --- a/docs/frontend_api/FAttachment.html +++ b/docs/frontend_api/FAttachment.html @@ -30,7 +30,8 @@

FAttachment()

-
Attachment is a file directly tied into a note without being a hidden child.
+
Attachment is a file directly tied into a note without +being a hidden child.
diff --git a/docs/frontend_api/FAttribute.html b/docs/frontend_api/FAttribute.html index 4ef3ae3ee..7c3103627 100644 --- a/docs/frontend_api/FAttribute.html +++ b/docs/frontend_api/FAttribute.html @@ -30,7 +30,8 @@

FAttribute()

-
Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)
+
Attribute is an abstract concept which has two real uses - label (key - value pair) +and relation (representing named relationship between source and target note)
diff --git a/docs/frontend_api/FBranch.html b/docs/frontend_api/FBranch.html index 45783d3c1..7446e66da 100644 --- a/docs/frontend_api/FBranch.html +++ b/docs/frontend_api/FBranch.html @@ -30,7 +30,8 @@

FBranch()

-
Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple parents.
+
Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple +parents.
diff --git a/docs/frontend_api/FNote.html b/docs/frontend_api/FNote.html index c5db332ba..92b8be652 100644 --- a/docs/frontend_api/FNote.html +++ b/docs/frontend_api/FNote.html @@ -1172,7 +1172,7 @@
Source:
@@ -1278,7 +1278,7 @@
Source:
@@ -1380,7 +1380,7 @@
Source:
@@ -1554,7 +1554,7 @@
Source:
@@ -1732,7 +1732,7 @@
Source:
@@ -1932,7 +1932,7 @@
Source:
@@ -2111,7 +2111,7 @@
Source:
@@ -2290,7 +2290,7 @@
Source:
@@ -2396,7 +2396,7 @@
Source:
@@ -2500,7 +2500,7 @@
Source:
@@ -2604,7 +2604,7 @@
Source:
@@ -2706,7 +2706,7 @@
Source:
@@ -2808,7 +2808,7 @@
Source:
@@ -2910,7 +2910,7 @@
Source:
@@ -3061,7 +3061,7 @@
Source:
@@ -3216,7 +3216,7 @@
Source:
@@ -3383,7 +3383,7 @@
Source:
@@ -3491,7 +3491,7 @@
Source:
@@ -3593,7 +3593,7 @@
Source:
@@ -3767,7 +3767,7 @@
Source:
@@ -3945,7 +3945,7 @@
Source:
@@ -4145,7 +4145,7 @@
Source:
@@ -4300,7 +4300,7 @@
Source:
@@ -4455,7 +4455,7 @@
Source:
@@ -4622,7 +4622,7 @@
Source:
@@ -4777,7 +4777,7 @@
Source:
@@ -4932,7 +4932,7 @@
Source:
@@ -5099,7 +5099,7 @@
Source:
@@ -5205,7 +5205,7 @@
Source:
@@ -5307,7 +5307,7 @@
Source:
@@ -5409,7 +5409,7 @@
Source:
@@ -5511,7 +5511,7 @@
Source:
@@ -5662,7 +5662,7 @@
Source:
@@ -5817,7 +5817,7 @@
Source:
@@ -5987,7 +5987,7 @@
Source:
@@ -6138,7 +6138,7 @@
Source:
@@ -6305,7 +6305,7 @@
Source:
@@ -6411,7 +6411,7 @@
Source:
@@ -6589,7 +6589,7 @@
Source:
@@ -6695,7 +6695,7 @@
Source:
@@ -6801,7 +6801,7 @@
Source:
@@ -6975,7 +6975,7 @@
Source:
@@ -7081,7 +7081,7 @@
Source:
@@ -7232,7 +7232,7 @@
Source:
@@ -7410,7 +7410,7 @@
Source:
@@ -7565,7 +7565,7 @@
Source:
@@ -7720,7 +7720,7 @@
Source:
@@ -7875,7 +7875,7 @@
Source:
@@ -7983,7 +7983,7 @@
Source:
@@ -8067,7 +8067,7 @@
Source:
@@ -8161,7 +8161,7 @@
Source:
@@ -8267,7 +8267,7 @@
Source:
@@ -8524,7 +8524,7 @@
Source:
diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html index d949cb13f..0d31af9d8 100644 --- a/docs/frontend_api/FrontendScriptApi.html +++ b/docs/frontend_api/FrontendScriptApi.html @@ -49,7 +49,8 @@
-

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. api.showMessage(api.startNote.title);

+

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. api.showMessage(api.startNote.title);

@@ -461,7 +462,7 @@
Source:
@@ -557,7 +558,8 @@
- day.js library for date manipulation. See https://day.js.org for documentation + day.js library for date manipulation. +See https://day.js.org for documentation
@@ -1273,7 +1275,8 @@ - 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. + 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. @@ -1375,7 +1378,8 @@ -
Deprecated:
+
Deprecated:
@@ -1526,7 +1530,7 @@
Source:
@@ -1692,7 +1696,8 @@ - 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. + 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. @@ -1733,7 +1738,7 @@
Source:
@@ -1787,7 +1792,7 @@ - + @@ -2058,6 +2063,43 @@ + + + + + + + + + + custom link tile with note's title as default + + + + + + + title= + + + + + +string + + + + + + + + + <optional>
+ + + + + @@ -2115,7 +2157,7 @@
Source:
@@ -2140,6 +2182,28 @@ +
Returns:
+ + +
+ - jQuery element with the link (wrapped in ) +
+ + + +
+
+ Type +
+
+ +jQuery + + +
+
+ + @@ -2405,7 +2469,7 @@
Source:
@@ -2560,7 +2624,7 @@
Source:
@@ -2670,7 +2734,7 @@
Source:
@@ -2776,7 +2840,7 @@
Source:
@@ -2882,7 +2946,7 @@
Source:
@@ -2992,7 +3056,7 @@
Source:
@@ -3058,7 +3122,8 @@
- 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.
@@ -3102,7 +3167,7 @@
Source:
@@ -3257,7 +3322,7 @@
Source:
@@ -3412,7 +3477,7 @@
Source:
@@ -3474,7 +3539,8 @@
- 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.
@@ -3673,7 +3739,7 @@
Source:
@@ -3735,7 +3801,8 @@
- 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. +*
@@ -3890,7 +3957,10 @@
- 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())
@@ -4132,7 +4202,7 @@
Source:
@@ -4287,7 +4357,7 @@
Source:
@@ -4442,7 +4512,7 @@
Source:
@@ -4592,7 +4662,7 @@
Source:
@@ -5277,7 +5347,7 @@
Source:
@@ -5451,7 +5521,7 @@
Source:
@@ -5606,7 +5676,7 @@
Source:
@@ -5760,7 +5830,7 @@
Source:
@@ -5959,7 +6029,8 @@
- 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.
@@ -6144,7 +6215,8 @@
- 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
@@ -6299,7 +6371,8 @@
- 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
@@ -6547,7 +6620,7 @@
Source:
@@ -6698,7 +6771,7 @@
Source:
@@ -7354,7 +7427,11 @@
- 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.
@@ -7398,7 +7475,7 @@
Source:
diff --git a/docs/frontend_api/NoteContextAwareWidget.html b/docs/frontend_api/NoteContextAwareWidget.html index 32692483d..3c5675db5 100644 --- a/docs/frontend_api/NoteContextAwareWidget.html +++ b/docs/frontend_api/NoteContextAwareWidget.html @@ -636,7 +636,9 @@
- Method used for rendering the widget. Your class should override this method. + Method used for rendering the widget. + +Your class should override this method.
@@ -857,7 +859,8 @@
- 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.
diff --git a/docs/frontend_api/RightPanelWidget.html b/docs/frontend_api/RightPanelWidget.html index eaa462670..a6bea6e25 100644 --- a/docs/frontend_api/RightPanelWidget.html +++ b/docs/frontend_api/RightPanelWidget.html @@ -816,7 +816,9 @@
- 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.
@@ -1037,7 +1039,8 @@
- 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.
diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html index 6d15487aa..9c8dcdc9d 100644 --- a/docs/frontend_api/global.html +++ b/docs/frontend_api/global.html @@ -471,7 +471,9 @@
- 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.
diff --git a/docs/frontend_api/services_frontend_script_api.js.html b/docs/frontend_api/services_frontend_script_api.js.html index 7780bc7a5..22934874b 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 @@ import shortcutService from "./shortcuts.js"; * @constructor */ function FrontendScriptApi(startNote, currentNote, originEntity = null, $container = null) { - /** + /** * Container of all the rendered script content * @type {jQuery} * */ @@ -79,7 +79,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain * @type {FNote} */ this.currentNote = currentNote; - /** + /** * Entity whose event triggered this execution * @type {object|null} */ @@ -359,6 +359,8 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain * @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;