From 280f9a98c4ab13511ebfb39d9ff6796bcbb236ff Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Fri, 9 Aug 2024 23:44:41 +0300 Subject: [PATCH] docs: Use nicer links to Wiki --- src/etapi/etapi.openapi.yaml | 2 +- src/public/app/services/frontend_script_api.js | 6 +++--- .../app/widgets/attribute_widgets/attribute_detail.js | 2 +- src/public/app/widgets/dialogs/help.js | 8 ++++---- src/public/app/widgets/shared_info.js | 2 +- src/public/app/widgets/type_widgets/book.js | 2 +- src/public/app/widgets/type_widgets/options/etapi.js | 2 +- .../options/other/revisions_snapshot_interval.js | 2 +- src/public/app/widgets/type_widgets/options/password.js | 2 +- src/public/app/widgets/type_widgets/render.js | 2 +- src/services/backend_script_api.ts | 6 +++--- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/etapi/etapi.openapi.yaml b/src/etapi/etapi.openapi.yaml index b53bfb01c..97a8977de 100644 --- a/src/etapi/etapi.openapi.yaml +++ b/src/etapi/etapi.openapi.yaml @@ -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: diff --git a/src/public/app/services/frontend_script_api.js b/src/public/app/services/frontend_script_api.js index f0e8cc30b..1cc79e10f 100644 --- a/src/public/app/services/frontend_script_api.js +++ b/src/public/app/services/frontend_script_api.js @@ -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 diff --git a/src/public/app/widgets/attribute_widgets/attribute_detail.js b/src/public/app/widgets/attribute_widgets/attribute_detail.js index fa4dc724d..2a70d23c9 100644 --- a/src/public/app/widgets/attribute_widgets/attribute_detail.js +++ b/src/public/app/widgets/attribute_widgets/attribute_detail.js @@ -245,7 +245,7 @@ const ATTR_HELP = {
  • Log for \${now.format('YYYY-MM-DD HH:mm:ss')}
    • - See wiki with details, API docs for parentNote and now for details.`, + See wiki with details, API docs for parentNote and now for details.`, "template": "This note will appear in the selection of available template when creating new note", "toc": "#toc or #toc=show will force the Table of Contents to be shown, #toc=hide 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", diff --git a/src/public/app/widgets/dialogs/help.js b/src/public/app/widgets/dialogs/help.js index 2b39ef5c3..a249e16b1 100644 --- a/src/public/app/widgets/dialogs/help.js +++ b/src/public/app/widgets/dialogs/help.js @@ -23,7 +23,7 @@ const TPL = `
  • UP, DOWN - go up/down in the list of notes
  • LEFT, RIGHT - collapse/expand node
  • not set, not set - go back / forwards in the history
    • -
  • not set - show "Jump to" dialog
    • +
  • not set - show "Jump to" dialog
  • not set - scroll to active note
  • Backspace - jump to parent note
  • not set - collapse whole note tree
    • @@ -61,7 +61,7 @@ const TPL = `

    @@ -78,7 +78,7 @@ const TPL = `
  • not set, not set - multi-select note above/below
  • not set - select all notes in the current level
  • Shift+click - select note
    • -
  • not set - copy active note (or current selection) into clipboard (used for cloning)
    • +
  • not set - copy active note (or current selection) into clipboard (used for cloning)
  • not set - cut current (or current selection) note into clipboard (used for moving notes)
  • not set - 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)
  • not set - delete note / sub-tree
    • @@ -107,7 +107,7 @@ const TPL = `
    -
    Markdown-like autoformatting
    +
    Markdown-like autoformatting

      diff --git a/src/public/app/widgets/shared_info.js b/src/public/app/widgets/shared_info.js index 560b4866a..9183a5c2c 100644 --- a/src/public/app/widgets/shared_info.js +++ b/src/public/app/widgets/shared_info.js @@ -13,7 +13,7 @@ const TPL = ` } - . For help visit wiki. + . For help visit wiki.
    `; export default class SharedInfoWidget extends NoteContextAwareWidget { diff --git a/src/public/app/widgets/type_widgets/book.js b/src/public/app/widgets/type_widgets/book.js index 5b7d615f2..07dbec31c 100644 --- a/src/public/app/widgets/type_widgets/book.js +++ b/src/public/app/widgets/type_widgets/book.js @@ -13,7 +13,7 @@ const TPL = `
    - This note of type Book doesn't have any child notes so there's nothing to display. See wiki for details. + This note of type Book doesn't have any child notes so there's nothing to display. See wiki for details.
    `; diff --git a/src/public/app/widgets/type_widgets/options/etapi.js b/src/public/app/widgets/type_widgets/options/etapi.js index b96fd7b8b..58e956aa3 100644 --- a/src/public/app/widgets/type_widgets/options/etapi.js +++ b/src/public/app/widgets/type_widgets/options/etapi.js @@ -8,7 +8,7 @@ const TPL = `

    ETAPI

    ETAPI is a REST API used to access Trilium instance programmatically, without UI.
    - See more details on wiki and ETAPI OpenAPI spec.

    + See more details on wiki and ETAPI OpenAPI spec.

    diff --git a/src/public/app/widgets/type_widgets/options/other/revisions_snapshot_interval.js b/src/public/app/widgets/type_widgets/options/other/revisions_snapshot_interval.js index a959c5b7b..53ff8d630 100644 --- a/src/public/app/widgets/type_widgets/options/other/revisions_snapshot_interval.js +++ b/src/public/app/widgets/type_widgets/options/other/revisions_snapshot_interval.js @@ -4,7 +4,7 @@ const TPL = `

    Note Revisions Snapshot Interval

    -

    Note revision snapshot time interval is time in seconds after which a new note revision will be created for the note. See wiki for more info.

    +

    Note revision snapshot time interval is time in seconds after which a new note revision will be created for the note. See wiki for more info.

    diff --git a/src/public/app/widgets/type_widgets/options/password.js b/src/public/app/widgets/type_widgets/options/password.js index ca18cc248..7b42fb064 100644 --- a/src/public/app/widgets/type_widgets/options/password.js +++ b/src/public/app/widgets/type_widgets/options/password.js @@ -37,7 +37,7 @@ const TPL = `

    Protected Session Timeout

    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 wiki for more info.

    + the browser's memory. This is measured from the last interaction with protected notes. See wiki for more info.

    diff --git a/src/public/app/widgets/type_widgets/render.js b/src/public/app/widgets/type_widgets/render.js index 9c694385f..70523248a 100644 --- a/src/public/app/widgets/type_widgets/render.js +++ b/src/public/app/widgets/type_widgets/render.js @@ -12,7 +12,7 @@ const TPL = `

    This help note is shown because this note of type Render HTML doesn't have required relation to function properly.

    -

    Render HTML note type is used for scripting. 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 relation called "renderNote" pointing to the HTML note to render.

    +

    Render HTML note type is used for scripting. 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 relation called "renderNote" pointing to the HTML note to render.

    diff --git a/src/services/backend_script_api.ts b/src/services/backend_script_api.ts index 0147cbec9..19f6ba784 100644 --- a/src/services/backend_script_api.ts +++ b/src/services/backend_script_api.ts @@ -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;