API docs build

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>
 
 

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 forlarger 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>
 
 

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>
 
 

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 multipleparents.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 purposeof 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>
 
 

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 clientsThe format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish itfrom 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>
 
 

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 andreturned.
+    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 sessionCurrently, 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>
 
 

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>
 
 

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>
 
 

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>