From 435e042ae97e72969c111cb718661fc4c7f59b29 Mon Sep 17 00:00:00 2001 From: zadam Date: Sun, 25 Dec 2022 13:03:22 +0100 Subject: [PATCH] fix docs --- docs/backend_api/AbstractEntity.html | 2 +- docs/backend_api/Attribute.html | 2 +- docs/backend_api/BackendScriptApi.html | 202 ++++++- docs/backend_api/Branch.html | 2 +- docs/backend_api/EtapiToken.html | 2 +- docs/backend_api/Note.html | 2 +- docs/backend_api/NoteRevision.html | 2 +- docs/backend_api/Option.html | 2 +- docs/backend_api/RecentNote.html | 2 +- .../becca_entities_abstract_entity.js.html | 2 +- .../becca_entities_attribute.js.html | 2 +- .../backend_api/becca_entities_branch.js.html | 2 +- .../becca_entities_etapi_token.js.html | 2 +- docs/backend_api/becca_entities_note.js.html | 2 +- .../becca_entities_note_revision.js.html | 2 +- .../backend_api/becca_entities_option.js.html | 2 +- .../becca_entities_recent_note.js.html | 2 +- docs/backend_api/global.html | 539 +++++++----------- docs/backend_api/index.html | 2 +- docs/backend_api/module-sql.html | 2 +- .../services_backend_script_api.js.html | 3 +- docs/backend_api/services_sql.js.html | 2 +- 22 files changed, 425 insertions(+), 357 deletions(-) diff --git a/docs/backend_api/AbstractEntity.html b/docs/backend_api/AbstractEntity.html index abff0dbe9..2e07d3086 100644 --- a/docs/backend_api/AbstractEntity.html +++ b/docs/backend_api/AbstractEntity.html @@ -985,7 +985,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/Attribute.html b/docs/backend_api/Attribute.html index 449fb9eac..193b65b71 100644 --- a/docs/backend_api/Attribute.html +++ b/docs/backend_api/Attribute.html @@ -1898,7 +1898,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/BackendScriptApi.html b/docs/backend_api/BackendScriptApi.html index fb74b0d73..fed5a5872 100644 --- a/docs/backend_api/BackendScriptApi.html +++ b/docs/backend_api/BackendScriptApi.html @@ -185,7 +185,7 @@
Source:
@@ -735,7 +735,7 @@
Source:
@@ -1743,7 +1743,7 @@ JSON MIME type. See also createNewNote() for more options.
Source:
@@ -2460,7 +2460,7 @@ JSON MIME type. See also createNewNote() for more options.
Source:
@@ -2566,7 +2566,7 @@ JSON MIME type. See also createNewNote() for more options.
Source:
@@ -5150,7 +5150,7 @@ if some action needs to happen on only one specific instance.
Source:
@@ -5258,7 +5258,7 @@ if some action needs to happen on only one specific instance.
Source:
@@ -5850,7 +5850,187 @@ This method looks similar to toggleNoteInParent() but differs because we're look
Source:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

sortNotes(parentNoteId, sortConfigopt)

+ + + + + + +
+ Sort child notes of a given note. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parentNoteId + + +string + + + + + + + + + + this note's child notes will be sorted
sortConfig + + +SortConfig + + + + + + <optional>
+ + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -6347,7 +6527,7 @@ exists, then we'll use that transaction.
Source:
@@ -6502,7 +6682,7 @@ exists, then we'll use that transaction.
Source:
@@ -6570,7 +6750,7 @@ exists, then we'll use that transaction.
diff --git a/docs/backend_api/Branch.html b/docs/backend_api/Branch.html index 1151de586..fd3cba371 100644 --- a/docs/backend_api/Branch.html +++ b/docs/backend_api/Branch.html @@ -1907,7 +1907,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/EtapiToken.html b/docs/backend_api/EtapiToken.html index a528c2e76..5f7b1e1e5 100644 --- a/docs/backend_api/EtapiToken.html +++ b/docs/backend_api/EtapiToken.html @@ -1455,7 +1455,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/Note.html b/docs/backend_api/Note.html index 35153382b..c14d61cdc 100644 --- a/docs/backend_api/Note.html +++ b/docs/backend_api/Note.html @@ -12065,7 +12065,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/NoteRevision.html b/docs/backend_api/NoteRevision.html index 51b0ff5e4..5bb9a2eb3 100644 --- a/docs/backend_api/NoteRevision.html +++ b/docs/backend_api/NoteRevision.html @@ -2168,7 +2168,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/Option.html b/docs/backend_api/Option.html index 57f1da0aa..f31eaf5e9 100644 --- a/docs/backend_api/Option.html +++ b/docs/backend_api/Option.html @@ -1313,7 +1313,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/RecentNote.html b/docs/backend_api/RecentNote.html index 6578477ae..62c311b5e 100644 --- a/docs/backend_api/RecentNote.html +++ b/docs/backend_api/RecentNote.html @@ -1245,7 +1245,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/becca_entities_abstract_entity.js.html b/docs/backend_api/becca_entities_abstract_entity.js.html index 4b266040c..b7b47377a 100644 --- a/docs/backend_api/becca_entities_abstract_entity.js.html +++ b/docs/backend_api/becca_entities_abstract_entity.js.html @@ -203,7 +203,7 @@ module.exports = AbstractEntity;
diff --git a/docs/backend_api/becca_entities_attribute.js.html b/docs/backend_api/becca_entities_attribute.js.html index a374f1d37..e2084c5ff 100644 --- a/docs/backend_api/becca_entities_attribute.js.html +++ b/docs/backend_api/becca_entities_attribute.js.html @@ -268,7 +268,7 @@ module.exports = Attribute;
diff --git a/docs/backend_api/becca_entities_branch.js.html b/docs/backend_api/becca_entities_branch.js.html index 5e2bd010f..2ace41813 100644 --- a/docs/backend_api/becca_entities_branch.js.html +++ b/docs/backend_api/becca_entities_branch.js.html @@ -295,7 +295,7 @@ module.exports = Branch;
diff --git a/docs/backend_api/becca_entities_etapi_token.js.html b/docs/backend_api/becca_entities_etapi_token.js.html index 1c3e98802..064d6494b 100644 --- a/docs/backend_api/becca_entities_etapi_token.js.html +++ b/docs/backend_api/becca_entities_etapi_token.js.html @@ -114,7 +114,7 @@ module.exports = EtapiToken;
diff --git a/docs/backend_api/becca_entities_note.js.html b/docs/backend_api/becca_entities_note.js.html index aacf52e87..6dd861f70 100644 --- a/docs/backend_api/becca_entities_note.js.html +++ b/docs/backend_api/becca_entities_note.js.html @@ -1471,7 +1471,7 @@ module.exports = Note;
diff --git a/docs/backend_api/becca_entities_note_revision.js.html b/docs/backend_api/becca_entities_note_revision.js.html index 816bac361..701317705 100644 --- a/docs/backend_api/becca_entities_note_revision.js.html +++ b/docs/backend_api/becca_entities_note_revision.js.html @@ -229,7 +229,7 @@ module.exports = NoteRevision;
diff --git a/docs/backend_api/becca_entities_option.js.html b/docs/backend_api/becca_entities_option.js.html index cbd6a639b..f63984cec 100644 --- a/docs/backend_api/becca_entities_option.js.html +++ b/docs/backend_api/becca_entities_option.js.html @@ -83,7 +83,7 @@ module.exports = Option;
diff --git a/docs/backend_api/becca_entities_recent_note.js.html b/docs/backend_api/becca_entities_recent_note.js.html index f8c6007d4..5d6268cb2 100644 --- a/docs/backend_api/becca_entities_recent_note.js.html +++ b/docs/backend_api/becca_entities_recent_note.js.html @@ -71,7 +71,7 @@ module.exports = RecentNote;
diff --git a/docs/backend_api/global.html b/docs/backend_api/global.html index df505dcb5..cefbb83e3 100644 --- a/docs/backend_api/global.html +++ b/docs/backend_api/global.html @@ -95,330 +95,6 @@ - -

Methods

- - - - - - - -

SortConfig(parentNoteId, sortConfigopt)

- - - - - - - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
parentNoteId - - -string - - - - - - - - - - this note's child notes will be sorted
sortConfig - - -SortConfig - - - - - - <optional>
- - - - - -
- - - - - - -
Properties:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
sortBy - - -string - - - - - - <optional>
- - - - 		- - 'title', 'dateCreated', 'dateModified' or a label name - see https://github.com/zadam/trilium/wiki/Sorting for details.
reverse - - -boolean - - - - - - <optional>
- - - - 		- - false - -
foldersFirst - - -boolean - - - - - - <optional>
- - - - 		- - false - - /** -Sort child notes of a given note.
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - @@ -1792,7 +1468,218 @@ Sort child notes of a given note.
Source:
+ + + + + + + +
+ + + + + + + + +

SortConfig

+ + + + + + +
Type:
+ + + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
sortBy + + +string + + + + + + <optional>
+ + + + 		+ + 'title', 'dateCreated', 'dateModified' or a label name + see https://github.com/zadam/trilium/wiki/Sorting for details.
reverse + + +boolean + + + + + + <optional>
+ + + + 		+ + false + +
foldersFirst + + +boolean + + + + + + <optional>
+ + + + 		+ + false + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -1822,7 +1709,7 @@ Sort child notes of a given note.
diff --git a/docs/backend_api/index.html b/docs/backend_api/index.html index 5f75f0c21..afc8c4960 100644 --- a/docs/backend_api/index.html +++ b/docs/backend_api/index.html @@ -50,7 +50,7 @@
diff --git a/docs/backend_api/module-sql.html b/docs/backend_api/module-sql.html index 5f1fdfe81..58ca58289 100644 --- a/docs/backend_api/module-sql.html +++ b/docs/backend_api/module-sql.html @@ -1294,7 +1294,7 @@
diff --git a/docs/backend_api/services_backend_script_api.js.html b/docs/backend_api/services_backend_script_api.js.html index 2209b292b..c9d76bd3c 100644 --- a/docs/backend_api/services_backend_script_api.js.html +++ b/docs/backend_api/services_backend_script_api.js.html @@ -431,6 +431,7 @@ function BackendScriptApi(currentNote, apiParams) { * see https://github.com/zadam/trilium/wiki/Sorting for details. * @property {boolean} [reverse=false] * @property {boolean} [foldersFirst=false] + */ /** * Sort child notes of a given note. @@ -610,7 +611,7 @@ module.exports = BackendScriptApi;
diff --git a/docs/backend_api/services_sql.js.html b/docs/backend_api/services_sql.js.html index 809fd1349..91b2d3863 100644 --- a/docs/backend_api/services_sql.js.html +++ b/docs/backend_api/services_sql.js.html @@ -404,7 +404,7 @@ module.exports = {