Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-09-19 10:15:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(in-app-help): render documentation

Browse Source
This commit is contained in:
Elian Doran 2025-02-02 15:34:44 +02:00
parent 61ee15cc01
commit 7c34a6178a
No known key found for this signature in database
2 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/public/app/widgets/type_widgets/doc.ts
View File

@ -39,7 +39,8 @@ export default class DocTypeWidget extends TypeWidget {
if (docName) { if (docName) {
// find doc based on language // find doc based on language
const lng = i18next.language; const lng = i18next.language;
this.$content.load(`${window.glob.appPath}/doc_notes/${lng}/${docName}.html`, (response, status) => { const url = `${window.glob.appPath}/doc_notes/${lng}/${docName}.html`.replaceAll(" ", "%20");
this.$content.load(url, (response, status) => {
// fallback to english doc if no translation available // fallback to english doc if no translation available
if (status === "error") { if (status === "error") {
this.$content.load(`${window.glob.appPath}/doc_notes/en/${docName}.html`); this.$content.load(`${window.glob.appPath}/doc_notes/en/${docName}.html`);

25
src/services/in_app_help.ts
View File

@ -26,21 +26,36 @@ function parseNoteMetaFile(noteMetaFile: NoteMetaFile): HiddenSubtreeItem[] {
return []; return [];
} }
const metaRoot = parseNoteMeta(noteMetaFile.files[0]); const metaRoot = noteMetaFile.files[0];
return metaRoot.children ?? []; const parsedMetaRoot = parseNoteMeta(metaRoot, "/" + (metaRoot.dirFileName ?? ""));
console.log(JSON.stringify(parsedMetaRoot, null, 4));
return parsedMetaRoot.children ?? [];
} }
function parseNoteMeta(noteMeta: NoteMeta): HiddenSubtreeItem { function parseNoteMeta(noteMeta: NoteMeta, docNameRoot: string): HiddenSubtreeItem {
const item: HiddenSubtreeItem = { const item: HiddenSubtreeItem = {
id: `_help_${noteMeta.noteId}`, id: `_help_${noteMeta.noteId}`,
title: noteMeta.title, title: noteMeta.title,
type: "doc" type: "doc",
attributes: []
}; };
// Handle text notes
if (noteMeta.type === "text" && noteMeta.dataFileName) {
const docPath = `${docNameRoot}/${path.basename(noteMeta.dataFileName, ".html")}`
.substring(1);
item.attributes?.push({
type: "label",
name: "docName",
value: docPath
});
}
if (noteMeta.children) { if (noteMeta.children) {
const children: HiddenSubtreeItem[] = []; const children: HiddenSubtreeItem[] = [];
for (const childMeta of noteMeta.children) { for (const childMeta of noteMeta.children) {
children.push(parseNoteMeta(childMeta)); let newDocNameRoot = (noteMeta.dirFileName ? `${docNameRoot}/${noteMeta.dirFileName}` : docNameRoot);
children.push(parseNoteMeta(childMeta, newDocNameRoot));
} }
item.children = children; item.children = children;