mirror of
				https://github.com/zadam/trilium.git
				synced 2025-11-04 05:28:59 +01:00 
			
		
		
		
	docs: Use nicer links to Wiki
This commit is contained in:
		
							parent
							
								
									e2bdfbbedb
								
							
						
					
					
						commit
						280f9a98c4
					
				@ -48,7 +48,7 @@ paths:
 | 
			
		||||
        - name: search
 | 
			
		||||
          in: query
 | 
			
		||||
          required: true
 | 
			
		||||
          description: search query string as described in https://github.com/TriliumNext/Docs/blob/main/Wiki/search.md
 | 
			
		||||
          description: search query string as described in https://triliumnext.github.io/Docs/Wiki/search.html
 | 
			
		||||
          schema:
 | 
			
		||||
            type: string
 | 
			
		||||
          examples:
 | 
			
		||||
 | 
			
		||||
@ -249,7 +249,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * 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/TriliumNext/Docs/blob/main/Wiki/search.md
 | 
			
		||||
     * "#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html
 | 
			
		||||
     *
 | 
			
		||||
     * @method
 | 
			
		||||
     * @param {string} searchString
 | 
			
		||||
@ -261,7 +261,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * 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/TriliumNext/Docs/blob/main/Wiki/search.md
 | 
			
		||||
     * "#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html
 | 
			
		||||
     *
 | 
			
		||||
     * @method
 | 
			
		||||
     * @param {string} searchString
 | 
			
		||||
@ -558,7 +558,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
 | 
			
		||||
    this.getYearNote = dateNotesService.getYearNote;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Hoist note in the current tab. See https://github.com/TriliumNext/Docs/blob/main/Wiki/note-hoisting.md
 | 
			
		||||
     * Hoist note in the current tab. See https://triliumnext.github.io/Docs/Wiki/note-hoisting.html
 | 
			
		||||
     *
 | 
			
		||||
     * @method
 | 
			
		||||
     * @param {string} noteId - set hoisted note. 'root' will effectively unhoist
 | 
			
		||||
 | 
			
		||||
@ -245,7 +245,7 @@ const ATTR_HELP = {
 | 
			
		||||
                            <li><code>Log for \${now.format('YYYY-MM-DD HH:mm:ss')}</code></li>
 | 
			
		||||
                        </ul>
 | 
			
		||||
                        
 | 
			
		||||
                        See <a href="https://github.com/TriliumNext/Docs/blob/main/Wiki/default-note-title.md">wiki with details</a>, API docs for <a href="https://zadam.github.io/trilium/backend_api/Note.html">parentNote</a> and <a href="https://day.js.org/docs/en/display/format">now</a> for details.`,
 | 
			
		||||
                        See <a href="https://triliumnext.github.io/Docs/Wiki/default-note-title.html">wiki with details</a>, API docs for <a href="https://zadam.github.io/trilium/backend_api/Note.html">parentNote</a> and <a href="https://day.js.org/docs/en/display/format">now</a> for details.`,
 | 
			
		||||
        "template": "This note will appear in the selection of available template when creating new note",
 | 
			
		||||
        "toc": "<code>#toc</code> or <code>#toc=show</code> will force the Table of Contents to be shown, <code>#toc=hide</code> will force hiding it. If the label doesn't exist, the global setting is observed",
 | 
			
		||||
        "color": "defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f",
 | 
			
		||||
 | 
			
		||||
@ -23,7 +23,7 @@ const TPL = `
 | 
			
		||||
                                    <li><kbd>UP</kbd>, <kbd>DOWN</kbd> - go up/down in the list of notes</li>
 | 
			
		||||
                                    <li><kbd>LEFT</kbd>, <kbd>RIGHT</kbd> - collapse/expand node</li>
 | 
			
		||||
                                    <li><kbd data-command="backInNoteHistory">not set</kbd>, <kbd data-command="forwardInNoteHistory">not set</kbd> - go back / forwards in the history</li>
 | 
			
		||||
                                    <li><kbd data-command="jumpToNote">not set</kbd> - show <a class="external" href="https://github.com/TriliumNext/Docs/blob/main/Wiki/note-navigation.md#jump-to-note">"Jump to" dialog</a></li>
 | 
			
		||||
                                    <li><kbd data-command="jumpToNote">not set</kbd> - show <a class="external" href="https://triliumnext.github.io/Docs/Wiki/note-navigation.html#jump-to-note">"Jump to" dialog</a></li>
 | 
			
		||||
                                    <li><kbd data-command="scrollToActiveNote">not set</kbd> - scroll to active note</li>
 | 
			
		||||
                                    <li><kbd>Backspace</kbd> - jump to parent note</li>
 | 
			
		||||
                                    <li><kbd data-command="collapseTree">not set</kbd> - collapse whole note tree</li>
 | 
			
		||||
@ -61,7 +61,7 @@ const TPL = `
 | 
			
		||||
                                <ul>
 | 
			
		||||
                                    <li><kbd data-command="createNoteAfter">not set</kbd> - create new note after the active note</li>
 | 
			
		||||
                                    <li><kbd data-command="createNoteInto">not set</kbd> - create new sub-note into active note</li>
 | 
			
		||||
                                    <li><kbd data-command="editBranchPrefix">not set</kbd> - edit <a class="external" href="https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md#prefix">prefix</a> of active note clone</li>
 | 
			
		||||
                                    <li><kbd data-command="editBranchPrefix">not set</kbd> - edit <a class="external" href="https://triliumnext.github.io/Docs/Wiki/tree-concepts.html#prefix">prefix</a> of active note clone</li>
 | 
			
		||||
                                </ul>
 | 
			
		||||
                            </p>
 | 
			
		||||
                        </div>
 | 
			
		||||
@ -78,7 +78,7 @@ const TPL = `
 | 
			
		||||
                                    <li><kbd data-command="addNoteAboveToSelection">not set</kbd>, <kbd data-command="addNoteBelowToSelection">not set</kbd> - multi-select note above/below</li>
 | 
			
		||||
                                    <li><kbd data-command="selectAllNotesInParent">not set</kbd> - select all notes in the current level</li>
 | 
			
		||||
                                    <li><kbd>Shift+click</kbd> - select note</li>
 | 
			
		||||
                                    <li><kbd data-command="copyNotesToClipboard">not set</kbd> - copy active note (or current selection) into clipboard (used for <a class="external" href="https://github.com/TriliumNext/Docs/blob/main/Wiki/cloning-notes.md">cloning</a>)</li>
 | 
			
		||||
                                    <li><kbd data-command="copyNotesToClipboard">not set</kbd> - copy active note (or current selection) into clipboard (used for <a class="external" href="https://triliumnext.github.io/Docs/Wiki/cloning-notes.html#cloning-notes.md">cloning</a>)</li>
 | 
			
		||||
                                    <li><kbd data-command="cutNotesToClipboard">not set</kbd> - cut current (or current selection) note into clipboard (used for moving notes)</li>
 | 
			
		||||
                                    <li><kbd data-command="pasteNotesFromClipboard">not set</kbd> - paste note(s) as sub-note into active note (which is either move or clone depending on whether it was copied or cut into clipboard)</li>
 | 
			
		||||
                                    <li><kbd data-command="deleteNotes">not set</kbd> - delete note / sub-tree</li>
 | 
			
		||||
@ -107,7 +107,7 @@ const TPL = `
 | 
			
		||||
 | 
			
		||||
                    <div class="card">
 | 
			
		||||
                        <div class="card-body">
 | 
			
		||||
                            <h5 class="card-title"><a class="external" href="https://github.com/TriliumNext/Docs/blob/main/Wiki/text-notes.md#markdown--autoformat">Markdown-like autoformatting</a></h5>
 | 
			
		||||
                            <h5 class="card-title"><a class="external" href="https://triliumnext.github.io/Docs/Wiki/text-notes.html#markdown--autoformat">Markdown-like autoformatting</a></h5>
 | 
			
		||||
 | 
			
		||||
                            <p class="card-text">
 | 
			
		||||
                                <ul>
 | 
			
		||||
 | 
			
		||||
@ -13,7 +13,7 @@ const TPL = `
 | 
			
		||||
        }
 | 
			
		||||
    </style>
 | 
			
		||||
    
 | 
			
		||||
    <span class="shared-text"></span> <a class="shared-link external"></a>. For help visit <a href="https://github.com/TriliumNext/Docs/blob/main/Wiki/sharing.md">wiki</a>.
 | 
			
		||||
    <span class="shared-text"></span> <a class="shared-link external"></a>. For help visit <a href="https://triliumnext.github.io/Docs/Wiki/sharing.html">wiki</a>.
 | 
			
		||||
</div>`;
 | 
			
		||||
 | 
			
		||||
export default class SharedInfoWidget extends NoteContextAwareWidget {
 | 
			
		||||
 | 
			
		||||
@ -13,7 +13,7 @@ const TPL = `
 | 
			
		||||
    </style>
 | 
			
		||||
 | 
			
		||||
    <div class="note-detail-book-empty-help alert alert-warning" style="margin: 50px; padding: 20px;">
 | 
			
		||||
        This note of type Book doesn't have any child notes so there's nothing to display. See <a href="https://github.com/TriliumNext/Docs/blob/main/Wiki/book-note.md">wiki</a> for details.
 | 
			
		||||
        This note of type Book doesn't have any child notes so there's nothing to display. See <a href="https://triliumnext.github.io/Docs/Wiki/book-note.html">wiki</a> for details.
 | 
			
		||||
    </div>
 | 
			
		||||
</div>`;
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -8,7 +8,7 @@ const TPL = `
 | 
			
		||||
    <h4>ETAPI</h4>
 | 
			
		||||
    
 | 
			
		||||
    <p>ETAPI is a REST API used to access Trilium instance programmatically, without UI. <br/>
 | 
			
		||||
       See more details on <a href="https://github.com/TriliumNext/Docs/blob/main/Wiki/etapi.md">wiki</a> and <a onclick="window.open('etapi/etapi.openapi.yaml')" href="etapi/etapi.openapi.yaml">ETAPI OpenAPI spec</a>.</p>
 | 
			
		||||
       See more details on <a href="https://triliumnext.github.io/Docs/Wiki/etapi.html">wiki</a> and <a onclick="window.open('etapi/etapi.openapi.yaml')" href="etapi/etapi.openapi.yaml">ETAPI OpenAPI spec</a>.</p>
 | 
			
		||||
    
 | 
			
		||||
    <button type="button" class="create-etapi-token btn btn-sm">Create new ETAPI token</button>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -4,7 +4,7 @@ const TPL = `
 | 
			
		||||
<div class="options-section">
 | 
			
		||||
    <h4>Note Revisions Snapshot Interval</h4>
 | 
			
		||||
 | 
			
		||||
    <p>Note revision snapshot time interval is time in seconds after which a new note revision will be created for the note. See <a href="https://github.com/TriliumNext/Docs/blob/main/Wiki/note-revisions.md" class="external">wiki</a> for more info.</p>
 | 
			
		||||
    <p>Note revision snapshot time interval is time in seconds after which a new note revision will be created for the note. See <a href="https://triliumnext.github.io/Docs/Wiki/note-revisions.html" class="external">wiki</a> for more info.</p>
 | 
			
		||||
 | 
			
		||||
    <div class="form-group">
 | 
			
		||||
        <label>Note revision snapshot time interval (in seconds)</label>
 | 
			
		||||
 | 
			
		||||
@ -37,7 +37,7 @@ const TPL = `
 | 
			
		||||
    <h4>Protected Session Timeout</h4>
 | 
			
		||||
 | 
			
		||||
    <p>Protected session timeout is a time period after which the protected session is wiped from
 | 
			
		||||
        the browser's memory. This is measured from the last interaction with protected notes. See <a href="https://github.com/TriliumNext/Docs/blob/main/Wiki/protected-notes.md" class="external">wiki</a> for more info.</p>
 | 
			
		||||
        the browser's memory. This is measured from the last interaction with protected notes. See <a href="https://triliumnext.github.io/Docs/Wiki/protected-notes.html" class="external">wiki</a> for more info.</p>
 | 
			
		||||
 | 
			
		||||
    <div class="form-group">
 | 
			
		||||
        <label>Protected session timeout (in seconds)</label>
 | 
			
		||||
 | 
			
		||||
@ -12,7 +12,7 @@ const TPL = `
 | 
			
		||||
    <div class="note-detail-render-help alert alert-warning" style="margin: 50px; padding: 20px;">
 | 
			
		||||
        <p><strong>This help note is shown because this note of type Render HTML doesn't have required relation to function properly.</strong></p>
 | 
			
		||||
 | 
			
		||||
        <p>Render HTML note type is used for <a class="external" href="https://github.com/TriliumNext/Docs/blob/main/Wiki/scripts.md">scripting</a>. In short, you have a HTML code note (optionally with some JavaScript) and this note will render it. To make it work, you need to define a <a class="external" href="https://github.com/TriliumNext/Docs/blob/main/Wiki/attributes.md">relation</a> called "renderNote" pointing to the HTML note to render.</p>
 | 
			
		||||
        <p>Render HTML note type is used for <a class="external" href="https://triliumnext.github.io/Docs/Wiki/scripts.html">scripting</a>. In short, you have a HTML code note (optionally with some JavaScript) and this note will render it. To make it work, you need to define a <a class="external" href="https://triliumnext.github.io/Docs/Wiki/attributes.html">relation</a> called "renderNote" pointing to the HTML note to render.</p>
 | 
			
		||||
    </div>
 | 
			
		||||
 | 
			
		||||
    <div class="note-detail-render-content"></div>
 | 
			
		||||
 | 
			
		||||
@ -114,13 +114,13 @@ interface Api {
 | 
			
		||||
    
 | 
			
		||||
    /**
 | 
			
		||||
     * This is a powerful search method - you can search by attributes and their values, e.g.:
 | 
			
		||||
     * "#dateModified =* MONTH AND #log". See {@link https://github.com/TriliumNext/Docs/blob/main/Wiki/search.md} for full documentation for all options
 | 
			
		||||
     * "#dateModified =* MONTH AND #log". See {@link https://triliumnext.github.io/Docs/Wiki/search.html} for full documentation for all options
 | 
			
		||||
     */
 | 
			
		||||
    searchForNotes(query: string, searchParams: SearchParams): BNote[];
 | 
			
		||||
    
 | 
			
		||||
    /**
 | 
			
		||||
     * This is a powerful search method - you can search by attributes and their values, e.g.:
 | 
			
		||||
     * "#dateModified =* MONTH AND #log". See {@link https://github.com/TriliumNext/Docs/blob/main/Wiki/search.md} for full documentation for all options
 | 
			
		||||
     * "#dateModified =* MONTH AND #log". See {@link https://triliumnext.github.io/Docs/Wiki/search.html} for full documentation for all options
 | 
			
		||||
     */
 | 
			
		||||
    searchForNote(query: string, searchParams: SearchParams): BNote | null;
 | 
			
		||||
    
 | 
			
		||||
@ -251,7 +251,7 @@ interface Api {
 | 
			
		||||
     */
 | 
			
		||||
    sortNotes(parentNoteId: string, sortConfig: {
 | 
			
		||||
        /** 'title', 'dateCreated', 'dateModified' or a label name
 | 
			
		||||
          * See {@link https://github.com/TriliumNext/Docs/blob/main/Wiki/sorting.md} for details. */
 | 
			
		||||
          * See {@link https://triliumnext.github.io/Docs/Wiki/sorting.html} for details. */
 | 
			
		||||
        sortBy?: string;
 | 
			
		||||
        reverse?: boolean;
 | 
			
		||||
        foldersFirst?: boolean;
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user