Kanban board v3 (#7753)

This commit is contained in:
Elian Doran 2025-11-15 16:36:39 +02:00 committed by GitHub
commit 13c8ff5cb3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
45 changed files with 1177 additions and 550 deletions

View File

@ -804,6 +804,16 @@ export default class FNote {
return this.getAttributeValue(LABEL, name); return this.getAttributeValue(LABEL, name);
} }
getLabelOrRelation(nameWithPrefix: string) {
if (nameWithPrefix.startsWith("#")) {
return this.getLabelValue(nameWithPrefix.substring(1));
} else if (nameWithPrefix.startsWith("~")) {
return this.getRelationValue(nameWithPrefix.substring(1));
} else {
return this.getLabelValue(nameWithPrefix);
}
}
/** /**
* @param name - relation name * @param name - relation name
* @returns relation value if relation exists, null otherwise * @returns relation value if relation exists, null otherwise

View File

@ -22,6 +22,15 @@ export async function setLabel(noteId: string, name: string, value: string = "",
}); });
} }
export async function setRelation(noteId: string, name: string, value: string = "", isInheritable = false) {
await server.put(`notes/${noteId}/set-attribute`, {
type: "relation",
name: name,
value: value,
isInheritable
});
}
async function removeAttributeById(noteId: string, attributeId: string) { async function removeAttributeById(noteId: string, attributeId: string) {
await server.remove(`notes/${noteId}/attributes/${attributeId}`); await server.remove(`notes/${noteId}/attributes/${attributeId}`);
} }
@ -51,6 +60,23 @@ function removeOwnedLabelByName(note: FNote, labelName: string) {
return false; return false;
} }
/**
* Removes a relation identified by its name from the given note, if it exists. Note that the relation must be owned, i.e.
* it will not remove inherited attributes.
*
* @param note the note from which to remove the relation.
* @param relationName the name of the relation to remove.
* @returns `true` if an attribute was identified and removed, `false` otherwise.
*/
function removeOwnedRelationByName(note: FNote, relationName: string) {
const relation = note.getOwnedRelation(relationName);
if (relation) {
removeAttributeById(note.noteId, relation.attributeId);
return true;
}
return false;
}
/** /**
* Sets the attribute of the given note to the provided value if its truthy, or removes the attribute if the value is falsy. * Sets the attribute of the given note to the provided value if its truthy, or removes the attribute if the value is falsy.
* For an attribute with an empty value, pass an empty string instead. * For an attribute with an empty value, pass an empty string instead.
@ -116,8 +142,10 @@ function isAffecting(attrRow: AttributeRow, affectedNote: FNote | null | undefin
export default { export default {
addLabel, addLabel,
setLabel, setLabel,
setRelation,
setAttribute, setAttribute,
removeAttributeById, removeAttributeById,
removeOwnedLabelByName, removeOwnedLabelByName,
removeOwnedRelationByName,
isAffecting isAffecting
}; };

View File

@ -1,11 +1,21 @@
import type { AttachmentRow, EtapiTokenRow, OptionNames } from "@triliumnext/commons"; import type { AttachmentRow, EtapiTokenRow, NoteType, OptionNames } from "@triliumnext/commons";
import type { AttributeType } from "../entities/fattribute.js"; import type { AttributeType } from "../entities/fattribute.js";
import type { EntityChange } from "../server_types.js"; import type { EntityChange } from "../server_types.js";
// TODO: Deduplicate with server. // TODO: Deduplicate with server.
interface NoteRow { interface NoteRow {
blobId: string;
dateCreated: string;
dateModified: string;
isDeleted?: boolean; isDeleted?: boolean;
isProtected?: boolean;
mime: string;
noteId: string;
title: string;
type: NoteType;
utcDateCreated: string;
utcDateModified: string;
} }
// TODO: Deduplicate with BranchRow from `rows.ts`/ // TODO: Deduplicate with BranchRow from `rows.ts`/

View File

@ -77,11 +77,11 @@ function closePersistent(id: string) {
$(`#toast-${id}`).remove(); $(`#toast-${id}`).remove();
} }
function showMessage(message: string, delay = 2000) { function showMessage(message: string, delay = 2000, icon = "check") {
console.debug(utils.now(), "message:", message); console.debug(utils.now(), "message:", message);
toast({ toast({
icon: "check", icon,
message: message, message: message,
autohide: true, autohide: true,
delay delay

View File

@ -16,6 +16,10 @@
background-color: var(--root-background); background-color: var(--root-background);
} }
body.mobile #root-widget {
background-color: var(--main-background-color);
}
body { body {
--native-titlebar-darwin-x-offset: 10; --native-titlebar-darwin-x-offset: 10;
--native-titlebar-darwin-y-offset: 12 !important; --native-titlebar-darwin-y-offset: 12 !important;

View File

@ -2035,7 +2035,8 @@
"add-column": "Add Column", "add-column": "Add Column",
"add-column-placeholder": "Enter column name...", "add-column-placeholder": "Enter column name...",
"edit-note-title": "Click to edit note title", "edit-note-title": "Click to edit note title",
"edit-column-title": "Click to edit column title" "edit-column-title": "Click to edit column title",
"column-already-exists": "This column already exists on the board."
}, },
"presentation_view": { "presentation_view": {
"edit-slide": "Edit this slide", "edit-slide": "Edit this slide",

View File

@ -1,4 +1,4 @@
.promoted-attributes { .user-attributes {
display: flex; display: flex;
flex-wrap: wrap; flex-wrap: wrap;
gap: 8px; gap: 8px;
@ -6,7 +6,7 @@
margin-top: 8px; margin-top: 8px;
} }
.promoted-attributes .promoted-attribute { .user-attributes .user-attribute {
padding: 2px 10px; padding: 2px 10px;
border-radius: 9999px; border-radius: 9999px;
white-space: nowrap; white-space: nowrap;
@ -17,15 +17,15 @@
line-height: 1.2; line-height: 1.2;
} }
.promoted-attributes .promoted-attribute:hover { .user-attributes .user-attribute:hover {
background-color: var(--chip-bg-hover, rgba(0, 0, 0, 0.12)); background-color: var(--chip-bg-hover, rgba(0, 0, 0, 0.12));
border-color: var(--chip-border-hover, rgba(0, 0, 0, 0.22)); border-color: var(--chip-border-hover, rgba(0, 0, 0, 0.22));
} }
.promoted-attributes .promoted-attribute .name { .user-attributes .user-attribute .name {
font-weight: 600; font-weight: 600;
} }
.promoted-attributes .promoted-attribute .value { .user-attributes .user-attribute .value {
opacity: 0.9; opacity: 0.9;
} }

View File

@ -1,16 +1,16 @@
import { useState } from "preact/hooks"; import { useState } from "preact/hooks";
import FNote from "../../entities/fnote"; import FNote from "../../entities/fnote";
import "./PromotedAttributesDisplay.css"; import "./UserAttributesList.css";
import { useTriliumEvent } from "../react/hooks"; import { useTriliumEvent } from "../react/hooks";
import attributes from "../../services/attributes"; import attributes from "../../services/attributes";
import { DefinitionObject } from "../../services/promoted_attribute_definition_parser"; import { DefinitionObject } from "../../services/promoted_attribute_definition_parser";
import { formatDateTime } from "../../utils/formatters"; import { formatDateTime } from "../../utils/formatters";
import { ComponentChild, ComponentChildren, CSSProperties } from "preact"; import { ComponentChildren, CSSProperties } from "preact";
import Icon from "../react/Icon"; import Icon from "../react/Icon";
import NoteLink from "../react/NoteLink"; import NoteLink from "../react/NoteLink";
import { getReadableTextColor } from "../../services/css_class_manager"; import { getReadableTextColor } from "../../services/css_class_manager";
interface PromotedAttributesDisplayProps { interface UserAttributesListProps {
note: FNote; note: FNote;
ignoredAttributes?: string[]; ignoredAttributes?: string[];
} }
@ -23,39 +23,39 @@ interface AttributeWithDefinitions {
def: DefinitionObject; def: DefinitionObject;
} }
export default function PromotedAttributesDisplay({ note, ignoredAttributes }: PromotedAttributesDisplayProps) { export default function UserAttributesDisplay({ note, ignoredAttributes }: UserAttributesListProps) {
const promotedDefinitionAttributes = useNoteAttributesWithDefinitions(note, ignoredAttributes); const userAttributes = useNoteAttributesWithDefinitions(note, ignoredAttributes);
return promotedDefinitionAttributes?.length > 0 && ( return userAttributes?.length > 0 && (
<div className="promoted-attributes"> <div className="user-attributes">
{promotedDefinitionAttributes?.map(attr => buildPromotedAttribute(attr))} {userAttributes?.map(attr => buildUserAttribute(attr))}
</div> </div>
) )
} }
function useNoteAttributesWithDefinitions(note: FNote, attributesToIgnore: string[] = []): AttributeWithDefinitions[] { function useNoteAttributesWithDefinitions(note: FNote, attributesToIgnore: string[] = []): AttributeWithDefinitions[] {
const [ promotedDefinitionAttributes, setPromotedDefinitionAttributes ] = useState<AttributeWithDefinitions[]>(getAttributesWithDefinitions(note, attributesToIgnore)); const [ userAttributes, setUserAttributes ] = useState<AttributeWithDefinitions[]>(getAttributesWithDefinitions(note, attributesToIgnore));
useTriliumEvent("entitiesReloaded", ({ loadResults }) => { useTriliumEvent("entitiesReloaded", ({ loadResults }) => {
if (loadResults.getAttributeRows().some(attr => attributes.isAffecting(attr, note))) { if (loadResults.getAttributeRows().some(attr => attributes.isAffecting(attr, note))) {
setPromotedDefinitionAttributes(getAttributesWithDefinitions(note, attributesToIgnore)); setUserAttributes(getAttributesWithDefinitions(note, attributesToIgnore));
} }
}); });
return promotedDefinitionAttributes; return userAttributes;
} }
function PromotedAttribute({ attr, children, style }: { attr: AttributeWithDefinitions, children: ComponentChildren, style?: CSSProperties }) { function UserAttribute({ attr, children, style }: { attr: AttributeWithDefinitions, children: ComponentChildren, style?: CSSProperties }) {
const className = `${attr.type === "label" ? "label" + " " + attr.def.labelType : "relation"}`; const className = `${attr.type === "label" ? "label" + " " + attr.def.labelType : "relation"}`;
return ( return (
<span key={attr.friendlyName} className={`promoted-attribute type-${className}`} style={style}> <span key={attr.friendlyName} className={`user-attribute type-${className}`} style={style}>
{children} {children}
</span> </span>
) )
} }
function buildPromotedAttribute(attr: AttributeWithDefinitions): ComponentChildren { function buildUserAttribute(attr: AttributeWithDefinitions): ComponentChildren {
const defaultLabel = <><strong>{attr.friendlyName}:</strong>{" "}</>; const defaultLabel = <><strong>{attr.friendlyName}:</strong>{" "}</>;
let content: ComponentChildren; let content: ComponentChildren;
let style: CSSProperties | undefined; let style: CSSProperties | undefined;
@ -102,13 +102,13 @@ function buildPromotedAttribute(attr: AttributeWithDefinitions): ComponentChildr
content = <>{defaultLabel}<NoteLink notePath={attr.value} showNoteIcon /></>; content = <>{defaultLabel}<NoteLink notePath={attr.value} showNoteIcon /></>;
} }
return <PromotedAttribute attr={attr} style={style}>{content}</PromotedAttribute> return <UserAttribute attr={attr} style={style}>{content}</UserAttribute>
} }
function getAttributesWithDefinitions(note: FNote, attributesToIgnore: string[] = []): AttributeWithDefinitions[] { function getAttributesWithDefinitions(note: FNote, attributesToIgnore: string[] = []): AttributeWithDefinitions[] {
const promotedDefinitionAttributes = note.getAttributeDefinitions(); const attributeDefintions = note.getAttributeDefinitions();
const result: AttributeWithDefinitions[] = []; const result: AttributeWithDefinitions[] = [];
for (const attr of promotedDefinitionAttributes) { for (const attr of attributeDefintions) {
const def = attr.getDefinition(); const def = attr.getDefinition();
const [ type, name ] = attr.name.split(":", 2); const [ type, name ] = attr.name.split(":", 2);
const friendlyName = def?.promotedAlias || name; const friendlyName = def?.promotedAlias || name;

View File

@ -77,8 +77,8 @@ export function CustomNoteList<T extends object>({ note, isEnabled: shouldEnable
props = { props = {
note, noteIds, notePath, note, noteIds, notePath,
highlightedTokens, highlightedTokens,
viewConfig: viewModeConfig[0], viewConfig: viewModeConfig.config,
saveConfig: viewModeConfig[1], saveConfig: viewModeConfig.storeFn,
onReady: onReady ?? (() => {}), onReady: onReady ?? (() => {}),
...restProps ...restProps
} }
@ -192,7 +192,11 @@ export function useNoteIds(note: FNote | null | undefined, viewType: ViewTypeOpt
} }
export function useViewModeConfig<T extends object>(note: FNote | null | undefined, viewType: ViewTypeOptions | undefined) { export function useViewModeConfig<T extends object>(note: FNote | null | undefined, viewType: ViewTypeOptions | undefined) {
const [ viewConfig, setViewConfig ] = useState<[T | undefined, (data: T) => void]>(); const [ viewConfig, setViewConfig ] = useState<{
config: T | undefined;
storeFn: (data: T) => void;
note: FNote;
}>();
useEffect(() => { useEffect(() => {
if (!note || !viewType) return; if (!note || !viewType) return;
@ -200,12 +204,14 @@ export function useViewModeConfig<T extends object>(note: FNote | null | undefin
const viewStorage = new ViewModeStorage<T>(note, viewType); const viewStorage = new ViewModeStorage<T>(note, viewType);
viewStorage.restore().then(config => { viewStorage.restore().then(config => {
const storeFn = (config: T) => { const storeFn = (config: T) => {
setViewConfig([ config, storeFn ]); setViewConfig({ note, config, storeFn });
viewStorage.store(config); viewStorage.store(config);
}; };
setViewConfig([ config, storeFn ]); setViewConfig({ note, config, storeFn });
}); });
}, [ note, viewType ]); }, [ note, viewType ]);
// Only expose config for the current note, avoid leaking notes when switching between them.
if (viewConfig?.note !== note) return undefined;
return viewConfig; return viewConfig;
} }

View File

@ -1,3 +1,4 @@
import { BulkAction } from "@triliumnext/commons";
import { BoardViewData } from "."; import { BoardViewData } from ".";
import appContext from "../../../components/app_context"; import appContext from "../../../components/app_context";
import FNote from "../../../entities/fnote"; import FNote from "../../../entities/fnote";
@ -12,15 +13,25 @@ import { ColumnMap } from "./data";
export default class BoardApi { export default class BoardApi {
private isRelationMode: boolean;
statusAttribute: string;
constructor( constructor(
private byColumn: ColumnMap | undefined, private byColumn: ColumnMap | undefined,
public columns: string[], public columns: string[],
private parentNote: FNote, private parentNote: FNote,
readonly statusAttribute: string, statusAttribute: string,
private viewConfig: BoardViewData, private viewConfig: BoardViewData,
private saveConfig: (newConfig: BoardViewData) => void, private saveConfig: (newConfig: BoardViewData) => void,
private setBranchIdToEdit: (branchId: string | undefined) => void private setBranchIdToEdit: (branchId: string | undefined) => void
) {}; ) {
this.isRelationMode = statusAttribute.startsWith("~");
if (statusAttribute.startsWith("~") || statusAttribute.startsWith("#")) {
statusAttribute = statusAttribute.substring(1);
}
this.statusAttribute = statusAttribute;
};
async createNewItem(column: string, title: string) { async createNewItem(column: string, title: string) {
try { try {
@ -42,7 +53,11 @@ export default class BoardApi {
} }
async changeColumn(noteId: string, newColumn: string) { async changeColumn(noteId: string, newColumn: string) {
await attributes.setLabel(noteId, this.statusAttribute, newColumn); if (this.isRelationMode) {
await attributes.setRelation(noteId, this.statusAttribute, newColumn);
} else {
await attributes.setLabel(noteId, this.statusAttribute, newColumn);
}
} }
async addNewColumn(columnName: string) { async addNewColumn(columnName: string) {
@ -60,22 +75,20 @@ export default class BoardApi {
// Add the new column to persisted data if it doesn't exist // Add the new column to persisted data if it doesn't exist
const existingColumn = this.viewConfig.columns.find(col => col.value === columnName); const existingColumn = this.viewConfig.columns.find(col => col.value === columnName);
if (!existingColumn) { if (existingColumn) return false;
this.viewConfig.columns.push({ value: columnName }); this.viewConfig.columns.push({ value: columnName });
this.saveConfig(this.viewConfig); this.saveConfig(this.viewConfig);
} return true;
} }
async removeColumn(column: string) { async removeColumn(column: string) {
// Remove the value from the notes. // Remove the value from the notes.
const noteIds = this.byColumn?.get(column)?.map(item => item.note.noteId) || []; const noteIds = this.byColumn?.get(column)?.map(item => item.note.noteId) || [];
await executeBulkActions(noteIds, [
{
name: "deleteLabel",
labelName: this.statusAttribute
}
]);
const action: BulkAction = this.isRelationMode
? { name: "deleteRelation", relationName: this.statusAttribute }
: { name: "deleteLabel", labelName: this.statusAttribute }
await executeBulkActions(noteIds, [ action ]);
this.viewConfig.columns = (this.viewConfig.columns ?? []).filter(col => col.value !== column); this.viewConfig.columns = (this.viewConfig.columns ?? []).filter(col => col.value !== column);
this.saveConfig(this.viewConfig); this.saveConfig(this.viewConfig);
} }
@ -84,13 +97,10 @@ export default class BoardApi {
const noteIds = this.byColumn?.get(oldValue)?.map(item => item.note.noteId) || []; const noteIds = this.byColumn?.get(oldValue)?.map(item => item.note.noteId) || [];
// Change the value in the notes. // Change the value in the notes.
await executeBulkActions(noteIds, [ const action: BulkAction = this.isRelationMode
{ ? { name: "updateRelationTarget", relationName: this.statusAttribute, targetNoteId: newValue }
name: "updateLabelValue", : { name: "updateLabelValue", labelName: this.statusAttribute, labelValue: newValue }
labelName: this.statusAttribute, await executeBulkActions(noteIds, [ action ]);
labelValue: newValue
}
]);
// Rename the column in the persisted data. // Rename the column in the persisted data.
for (const column of this.viewConfig.columns || []) { for (const column of this.viewConfig.columns || []) {
@ -167,7 +177,11 @@ export default class BoardApi {
removeFromBoard(noteId: string) { removeFromBoard(noteId: string) {
const note = froca.getNoteFromCache(noteId); const note = froca.getNoteFromCache(noteId);
if (!note) return; if (!note) return;
return attributes.removeOwnedLabelByName(note, this.statusAttribute); if (this.isRelationMode) {
return attributes.removeOwnedRelationByName(note, this.statusAttribute);
} else {
return attributes.removeOwnedLabelByName(note, this.statusAttribute);
}
} }
async moveWithinBoard(noteId: string, sourceBranchId: string, sourceIndex: number, targetIndex: number, sourceColumn: string, targetColumn: string) { async moveWithinBoard(noteId: string, sourceBranchId: string, sourceIndex: number, targetIndex: number, sourceColumn: string, targetColumn: string) {

View File

@ -6,7 +6,8 @@ import { BoardViewContext, TitleEditor } from ".";
import { ContextMenuEvent } from "../../../menus/context_menu"; import { ContextMenuEvent } from "../../../menus/context_menu";
import { openNoteContextMenu } from "./context_menu"; import { openNoteContextMenu } from "./context_menu";
import { t } from "../../../services/i18n"; import { t } from "../../../services/i18n";
import PromotedAttributesDisplay from "../../attribute_widgets/PromotedAttributesDisplay"; import UserAttributesDisplay from "../../attribute_widgets/UserAttributesList";
import { useTriliumEvent } from "../../react/hooks";
export const CARD_CLIPBOARD_TYPE = "trilium/board-card"; export const CARD_CLIPBOARD_TYPE = "trilium/board-card";
@ -40,6 +41,13 @@ export default function Card({
const [ isVisible, setVisible ] = useState(true); const [ isVisible, setVisible ] = useState(true);
const [ title, setTitle ] = useState(note.title); const [ title, setTitle ] = useState(note.title);
useTriliumEvent("entitiesReloaded", ({ loadResults }) => {
const row = loadResults.getEntityRow("notes", note.noteId);
if (row) {
setTitle(row.title);
}
});
const handleDragStart = useCallback((e: DragEvent) => { const handleDragStart = useCallback((e: DragEvent) => {
e.dataTransfer!.effectAllowed = 'move'; e.dataTransfer!.effectAllowed = 'move';
const data: CardDragData = { noteId: note.noteId, branchId: branch.branchId, fromColumn: column, index }; const data: CardDragData = { noteId: note.noteId, branchId: branch.branchId, fromColumn: column, index };
@ -109,7 +117,7 @@ export default function Card({
title={t("board_view.edit-note-title")} title={t("board_view.edit-note-title")}
onClick={handleEdit} onClick={handleEdit}
/> />
<PromotedAttributesDisplay note={note} ignoredAttributes={[api.statusAttribute]} /> <UserAttributesDisplay note={note} ignoredAttributes={[api.statusAttribute]} />
</> </>
) : ( ) : (
<TitleEditor <TitleEditor
@ -119,7 +127,7 @@ export default function Card({
setTitle(newTitle); setTitle(newTitle);
}} }}
dismiss={() => api.dismissEditingTitle()} dismiss={() => api.dismissEditingTitle()}
multiline mode="multiline"
/> />
)} )}
</div> </div>

View File

@ -12,6 +12,7 @@ import Card, { CARD_CLIPBOARD_TYPE, CardDragData } from "./card";
import { JSX } from "preact/jsx-runtime"; import { JSX } from "preact/jsx-runtime";
import froca from "../../../services/froca"; import froca from "../../../services/froca";
import { DragData, TREE_CLIPBOARD_TYPE } from "../../note_tree"; import { DragData, TREE_CLIPBOARD_TYPE } from "../../note_tree";
import NoteLink from "../../react/NoteLink";
interface DragContext { interface DragContext {
column: string; column: string;
@ -27,12 +28,14 @@ export default function Column({
api, api,
onColumnHover, onColumnHover,
isAnyColumnDragging, isAnyColumnDragging,
isInRelationMode
}: { }: {
columnItems?: { note: FNote, branch: FBranch }[]; columnItems?: { note: FNote, branch: FBranch }[];
isDraggingColumn: boolean, isDraggingColumn: boolean,
api: BoardApi, api: BoardApi,
onColumnHover?: (index: number, mouseX: number, rect: DOMRect) => void, onColumnHover?: (index: number, mouseX: number, rect: DOMRect) => void,
isAnyColumnDragging?: boolean isAnyColumnDragging?: boolean,
isInRelationMode: boolean
} & DragContext) { } & DragContext) {
const [ isVisible, setVisible ] = useState(true); const [ isVisible, setVisible ] = useState(true);
const { columnNameToEdit, setColumnNameToEdit, dropTarget, draggedCard, dropPosition } = useContext(BoardViewContext)!; const { columnNameToEdit, setColumnNameToEdit, dropTarget, draggedCard, dropPosition } = useContext(BoardViewContext)!;
@ -103,7 +106,11 @@ export default function Column({
> >
{!isEditing ? ( {!isEditing ? (
<> <>
<span className="title">{column}</span> <span className="title">
{isInRelationMode
? <NoteLink notePath={column} showNoteIcon />
: column}
</span>
<span className="counter-badge">{columnItems?.length ?? 0}</span> <span className="counter-badge">{columnItems?.length ?? 0}</span>
<div className="spacer" /> <div className="spacer" />
<span <span
@ -117,6 +124,7 @@ export default function Column({
currentValue={column} currentValue={column}
save={newTitle => api.renameColumn(column, newTitle)} save={newTitle => api.renameColumn(column, newTitle)}
dismiss={() => setColumnNameToEdit?.(undefined)} dismiss={() => setColumnNameToEdit?.(undefined)}
mode={isInRelationMode ? "relation" : "normal"}
/> />
)} )}
</h3> </h3>
@ -180,7 +188,7 @@ function AddNewItem({ column, api }: { column: string, api: BoardApi }) {
placeholder={t("board_view.new-item-placeholder")} placeholder={t("board_view.new-item-placeholder")}
save={(title) => api.createNewItem(column, title)} save={(title) => api.createNewItem(column, title)}
dismiss={() => setIsCreatingNewItem(false)} dismiss={() => setIsCreatingNewItem(false)}
multiline isNewItem mode="multiline" isNewItem
/> />
)} )}
</div> </div>

View File

@ -57,7 +57,8 @@ export async function getBoardData(parentNote: FNote, groupByColumn: string, per
return { return {
byColumn, byColumn,
newPersistedData newPersistedData,
isInRelationMode: groupByColumn.startsWith("~")
}; };
} }
@ -70,7 +71,7 @@ async function recursiveGroupBy(branches: FBranch[], byColumn: ColumnMap, groupB
await recursiveGroupBy(note.getChildBranches(), byColumn, groupByColumn, includeArchived, seenNoteIds); await recursiveGroupBy(note.getChildBranches(), byColumn, groupByColumn, includeArchived, seenNoteIds);
} }
const group = note.getLabelValue(groupByColumn); const group = note.getLabelOrRelation(groupByColumn);
if (!group || seenNoteIds.has(note.noteId)) { if (!group || seenNoteIds.has(note.noteId)) {
continue; continue;
} }

View File

@ -9,6 +9,12 @@
--card-padding: 0.6em; --card-padding: 0.6em;
} }
body.mobile .board-view {
scroll-snap-type: x mandatory;
-webkit-overflow-scrolling: touch;
scroll-behavior: smooth;
}
.board-view-container { .board-view-container {
height: 100%; height: 100%;
display: flex; display: flex;
@ -31,6 +37,12 @@
flex-direction: column; flex-direction: column;
} }
body.mobile .board-view-container .board-column {
width: 75vw;
max-width: 300px;
scroll-snap-align: center;
}
.board-view-container .board-column.drag-over { .board-view-container .board-column.drag-over {
border-color: var(--main-text-color); border-color: var(--main-text-color);
background-color: var(--hover-item-background-color); background-color: var(--hover-item-background-color);
@ -53,6 +65,11 @@
align-items: center; align-items: center;
} }
.board-view-container .board-column h3 a {
text-decoration: none;
color: inherit;
}
.board-view-container .board-column h3 .counter-badge { .board-view-container .board-column h3 .counter-badge {
background-color: var(--muted-text-color); background-color: var(--muted-text-color);
color: var(--main-background-color); color: var(--main-background-color);

View File

@ -13,6 +13,8 @@ import Column from "./column";
import BoardApi from "./api"; import BoardApi from "./api";
import FormTextArea from "../../react/FormTextArea"; import FormTextArea from "../../react/FormTextArea";
import FNote from "../../../entities/fnote"; import FNote from "../../../entities/fnote";
import NoteAutocomplete from "../../react/NoteAutocomplete";
import toast from "../../../services/toast";
export interface BoardViewData { export interface BoardViewData {
columns?: BoardColumnData[]; columns?: BoardColumnData[];
@ -42,10 +44,11 @@ interface BoardViewContextData {
export const BoardViewContext = createContext<BoardViewContextData | undefined>(undefined); export const BoardViewContext = createContext<BoardViewContextData | undefined>(undefined);
export default function BoardView({ note: parentNote, noteIds, viewConfig, saveConfig }: ViewModeProps<BoardViewData>) { export default function BoardView({ note: parentNote, noteIds, viewConfig, saveConfig }: ViewModeProps<BoardViewData>) {
const [ statusAttribute ] = useNoteLabelWithDefault(parentNote, "board:groupBy", "status"); const [ statusAttributeWithPrefix ] = useNoteLabelWithDefault(parentNote, "board:groupBy", "status");
const [ includeArchived ] = useNoteLabelBoolean(parentNote, "includeArchived"); const [ includeArchived ] = useNoteLabelBoolean(parentNote, "includeArchived");
const [ byColumn, setByColumn ] = useState<ColumnMap>(); const [ byColumn, setByColumn ] = useState<ColumnMap>();
const [ columns, setColumns ] = useState<string[]>(); const [ columns, setColumns ] = useState<string[]>();
const [ isInRelationMode, setIsRelationMode ] = useState(false);
const [ draggedCard, setDraggedCard ] = useState<{ noteId: string, branchId: string, fromColumn: string, index: number } | null>(null); const [ draggedCard, setDraggedCard ] = useState<{ noteId: string, branchId: string, fromColumn: string, index: number } | null>(null);
const [ dropTarget, setDropTarget ] = useState<string | null>(null); const [ dropTarget, setDropTarget ] = useState<string | null>(null);
const [ dropPosition, setDropPosition ] = useState<{ column: string, index: number } | null>(null); const [ dropPosition, setDropPosition ] = useState<{ column: string, index: number } | null>(null);
@ -55,8 +58,8 @@ export default function BoardView({ note: parentNote, noteIds, viewConfig, saveC
const [ branchIdToEdit, setBranchIdToEdit ] = useState<string>(); const [ branchIdToEdit, setBranchIdToEdit ] = useState<string>();
const [ columnNameToEdit, setColumnNameToEdit ] = useState<string>(); const [ columnNameToEdit, setColumnNameToEdit ] = useState<string>();
const api = useMemo(() => { const api = useMemo(() => {
return new Api(byColumn, columns ?? [], parentNote, statusAttribute, viewConfig ?? {}, saveConfig, setBranchIdToEdit ); return new Api(byColumn, columns ?? [], parentNote, statusAttributeWithPrefix, viewConfig ?? {}, saveConfig, setBranchIdToEdit );
}, [ byColumn, columns, parentNote, statusAttribute, viewConfig, saveConfig, setBranchIdToEdit ]); }, [ byColumn, columns, parentNote, statusAttributeWithPrefix, viewConfig, saveConfig, setBranchIdToEdit ]);
const boardViewContext = useMemo<BoardViewContextData>(() => ({ const boardViewContext = useMemo<BoardViewContextData>(() => ({
api, api,
parentNote, parentNote,
@ -78,8 +81,9 @@ export default function BoardView({ note: parentNote, noteIds, viewConfig, saveC
]); ]);
function refresh() { function refresh() {
getBoardData(parentNote, statusAttribute, viewConfig ?? {}, includeArchived).then(({ byColumn, newPersistedData }) => { getBoardData(parentNote, statusAttributeWithPrefix, viewConfig ?? {}, includeArchived).then(({ byColumn, newPersistedData, isInRelationMode }) => {
setByColumn(byColumn); setByColumn(byColumn);
setIsRelationMode(isInRelationMode);
if (newPersistedData) { if (newPersistedData) {
viewConfig = { ...newPersistedData }; viewConfig = { ...newPersistedData };
@ -94,7 +98,7 @@ export default function BoardView({ note: parentNote, noteIds, viewConfig, saveC
}); });
} }
useEffect(refresh, [ parentNote, noteIds, viewConfig ]); useEffect(refresh, [ parentNote, noteIds, viewConfig, statusAttributeWithPrefix ]);
const handleColumnDrop = useCallback((fromIndex: number, toIndex: number) => { const handleColumnDrop = useCallback((fromIndex: number, toIndex: number) => {
const newColumns = api.reorderColumn(fromIndex, toIndex); const newColumns = api.reorderColumn(fromIndex, toIndex);
@ -110,7 +114,7 @@ export default function BoardView({ note: parentNote, noteIds, viewConfig, saveC
// Check if any changes affect our board // Check if any changes affect our board
const hasRelevantChanges = const hasRelevantChanges =
// React to changes in status attribute for notes in this board // React to changes in status attribute for notes in this board
loadResults.getAttributeRows().some(attr => attr.name === statusAttribute && noteIds.includes(attr.noteId!)) || loadResults.getAttributeRows().some(attr => attr.name === api.statusAttribute && noteIds.includes(attr.noteId!)) ||
// React to changes in note title // React to changes in note title
loadResults.getNoteIds().some(noteId => noteIds.includes(noteId)) || loadResults.getNoteIds().some(noteId => noteIds.includes(noteId)) ||
// React to changes in branches for subchildren (e.g., moved, added, or removed notes) // React to changes in branches for subchildren (e.g., moved, added, or removed notes)
@ -171,6 +175,7 @@ export default function BoardView({ note: parentNote, noteIds, viewConfig, saveC
<div className="column-drop-placeholder show" /> <div className="column-drop-placeholder show" />
)} )}
<Column <Column
isInRelationMode={isInRelationMode}
api={api} api={api}
column={column} column={column}
columnIndex={index} columnIndex={index}
@ -185,14 +190,14 @@ export default function BoardView({ note: parentNote, noteIds, viewConfig, saveC
<div className="column-drop-placeholder show" /> <div className="column-drop-placeholder show" />
)} )}
<AddNewColumn api={api} /> <AddNewColumn api={api} isInRelationMode={isInRelationMode} />
</div> </div>
</BoardViewContext.Provider> </BoardViewContext.Provider>
</div> </div>
) )
} }
function AddNewColumn({ api }: { api: BoardApi }) { function AddNewColumn({ api, isInRelationMode }: { api: BoardApi, isInRelationMode: boolean }) {
const [ isCreatingNewColumn, setIsCreatingNewColumn ] = useState(false); const [ isCreatingNewColumn, setIsCreatingNewColumn ] = useState(false);
const addColumnCallback = useCallback(() => { const addColumnCallback = useCallback(() => {
@ -209,22 +214,28 @@ function AddNewColumn({ api }: { api: BoardApi }) {
: ( : (
<TitleEditor <TitleEditor
placeholder={t("board_view.add-column-placeholder")} placeholder={t("board_view.add-column-placeholder")}
save={(columnName) => api.addNewColumn(columnName)} save={async (columnName) => {
const created = await api.addNewColumn(columnName);
if (!created) {
toast.showMessage(t("board_view.column-already-exists"), undefined, "bx bx-duplicate");
}
}}
dismiss={() => setIsCreatingNewColumn(false)} dismiss={() => setIsCreatingNewColumn(false)}
isNewItem isNewItem
mode={isInRelationMode ? "relation" : "normal"}
/> />
)} )}
</div> </div>
) )
} }
export function TitleEditor({ currentValue, placeholder, save, dismiss, multiline, isNewItem }: { export function TitleEditor({ currentValue, placeholder, save, dismiss, mode, isNewItem }: {
currentValue?: string; currentValue?: string;
placeholder?: string; placeholder?: string;
save: (newValue: string) => void; save: (newValue: string) => void;
dismiss: () => void; dismiss: () => void;
multiline?: boolean;
isNewItem?: boolean; isNewItem?: boolean;
mode?: "normal" | "multiline" | "relation";
}) { }) {
const inputRef = useRef<any>(null); const inputRef = useRef<any>(null);
const focusElRef = useRef<Element>(null); const focusElRef = useRef<Element>(null);
@ -232,13 +243,11 @@ export function TitleEditor({ currentValue, placeholder, save, dismiss, multilin
const shouldDismiss = useRef(false); const shouldDismiss = useRef(false);
useEffect(() => { useEffect(() => {
focusElRef.current = document.activeElement; focusElRef.current = document.activeElement !== document.body ? document.activeElement : null;
inputRef.current?.focus(); inputRef.current?.focus();
inputRef.current?.select(); inputRef.current?.select();
}, [ inputRef ]); }, [ inputRef ]);
const Element = multiline ? FormTextArea : FormTextBox;
useEffect(() => { useEffect(() => {
if (dismissOnNextRefreshRef.current) { if (dismissOnNextRefreshRef.current) {
dismiss(); dismiss();
@ -246,31 +255,62 @@ export function TitleEditor({ currentValue, placeholder, save, dismiss, multilin
} }
}); });
return ( const onKeyDown = (e: TargetedKeyboardEvent<HTMLInputElement | HTMLTextAreaElement> | KeyboardEvent) => {
<Element if (e.key === "Enter" || e.key === "Escape") {
inputRef={inputRef} e.preventDefault();
currentValue={currentValue ?? ""} e.stopPropagation();
placeholder={placeholder} if (focusElRef.current instanceof HTMLElement) {
autoComplete="trilium-title-entry" // forces the auto-fill off better than the "off" value. shouldDismiss.current = (e.key === "Escape");
rows={multiline ? 4 : undefined} focusElRef.current.focus();
onKeyDown={(e: TargetedKeyboardEvent<HTMLInputElement | HTMLTextAreaElement>) => { } else {
if (e.key === "Enter" || e.key === "Escape") { dismiss();
e.preventDefault(); }
e.stopPropagation(); }
shouldDismiss.current = (e.key === "Escape"); };
if (focusElRef.current instanceof HTMLElement) {
focusElRef.current.focus(); const onBlur = (newValue: string) => {
if (!shouldDismiss.current && newValue.trim() && (newValue !== currentValue || isNewItem)) {
save(newValue);
dismissOnNextRefreshRef.current = true;
} else {
dismiss();
}
};
if (mode !== "relation") {
const Element = mode === "multiline" ? FormTextArea : FormTextBox;
return (
<Element
inputRef={inputRef}
currentValue={currentValue ?? ""}
placeholder={placeholder}
autoComplete="trilium-title-entry" // forces the auto-fill off better than the "off" value.
rows={mode === "multiline" ? 4 : undefined}
onKeyDown={onKeyDown}
onBlur={onBlur}
/>
);
} else {
return (
<NoteAutocomplete
inputRef={inputRef}
noteId={currentValue ?? ""}
opts={{
hideAllButtons: true,
allowCreatingNotes: true
}}
onKeyDown={(e) => {
if (e.key === "Escape") {
dismiss();
} }
} }}
}} onBlur={() => dismiss()}
onBlur={(newValue) => { noteIdChanged={(newValue) => {
if (!shouldDismiss.current && newValue.trim() && (newValue !== currentValue || isNewItem)) {
save(newValue); save(newValue);
dismissOnNextRefreshRef.current = true;
} else {
dismiss(); dismiss();
} }}
}} />
/> );
); }
} }

View File

@ -5,7 +5,7 @@ import type { RefObject } from "preact";
import type { CSSProperties } from "preact/compat"; import type { CSSProperties } from "preact/compat";
import { useSyncedRef } from "./hooks"; import { useSyncedRef } from "./hooks";
interface NoteAutocompleteProps { interface NoteAutocompleteProps {
id?: string; id?: string;
inputRef?: RefObject<HTMLInputElement>; inputRef?: RefObject<HTMLInputElement>;
text?: string; text?: string;
@ -15,13 +15,15 @@ interface NoteAutocompleteProps {
opts?: Omit<Options, "container">; opts?: Omit<Options, "container">;
onChange?: (suggestion: Suggestion | null) => void; onChange?: (suggestion: Suggestion | null) => void;
onTextChange?: (text: string) => void; onTextChange?: (text: string) => void;
onKeyDown?: (e: KeyboardEvent) => void;
onBlur?: (newValue: string) => void;
noteIdChanged?: (noteId: string) => void; noteIdChanged?: (noteId: string) => void;
noteId?: string; noteId?: string;
} }
export default function NoteAutocomplete({ id, inputRef: externalInputRef, text, placeholder, onChange, onTextChange, container, containerStyle, opts, noteId, noteIdChanged }: NoteAutocompleteProps) { export default function NoteAutocomplete({ id, inputRef: externalInputRef, text, placeholder, onChange, onTextChange, container, containerStyle, opts, noteId, noteIdChanged, onKeyDown, onBlur }: NoteAutocompleteProps) {
const ref = useSyncedRef<HTMLInputElement>(externalInputRef); const ref = useSyncedRef<HTMLInputElement>(externalInputRef);
useEffect(() => { useEffect(() => {
if (!ref.current) return; if (!ref.current) return;
const $autoComplete = $(ref.current); const $autoComplete = $(ref.current);
@ -57,6 +59,12 @@ export default function NoteAutocomplete({ id, inputRef: externalInputRef, text,
if (onTextChange) { if (onTextChange) {
$autoComplete.on("input", () => onTextChange($autoComplete[0].value)); $autoComplete.on("input", () => onTextChange($autoComplete[0].value));
} }
if (onKeyDown) {
$autoComplete.on("keydown", (e) => e.originalEvent && onKeyDown(e.originalEvent));
}
if (onBlur) {
$autoComplete.on("blur", () => onBlur($autoComplete.getSelectedNoteId() ?? ""));
}
}, [opts, container?.current]); }, [opts, container?.current]);
useEffect(() => { useEffect(() => {
@ -81,4 +89,4 @@ export default function NoteAutocomplete({ id, inputRef: externalInputRef, text,
placeholder={placeholder ?? t("add_link.search_note")} /> placeholder={placeholder ?? t("add_link.search_note")} />
</div> </div>
); );
} }

View File

@ -1,6 +1,6 @@
import { useEffect, useRef, useState } from "preact/hooks"; import { useEffect, useRef, useState } from "preact/hooks";
import link, { ViewScope } from "../../services/link"; import link, { ViewScope } from "../../services/link";
import { useImperativeSearchHighlighlighting } from "./hooks"; import { useImperativeSearchHighlighlighting, useTriliumEvent } from "./hooks";
interface NoteLinkOpts { interface NoteLinkOpts {
className?: string; className?: string;
@ -19,9 +19,11 @@ interface NoteLinkOpts {
export default function NoteLink({ className, notePath, showNotePath, showNoteIcon, style, noPreview, noTnLink, highlightedTokens, title, viewScope, noContextMenu }: NoteLinkOpts) { export default function NoteLink({ className, notePath, showNotePath, showNoteIcon, style, noPreview, noTnLink, highlightedTokens, title, viewScope, noContextMenu }: NoteLinkOpts) {
const stringifiedNotePath = Array.isArray(notePath) ? notePath.join("/") : notePath; const stringifiedNotePath = Array.isArray(notePath) ? notePath.join("/") : notePath;
const noteId = stringifiedNotePath.split("/").at(-1);
const ref = useRef<HTMLSpanElement>(null); const ref = useRef<HTMLSpanElement>(null);
const [ jqueryEl, setJqueryEl ] = useState<JQuery<HTMLElement>>(); const [ jqueryEl, setJqueryEl ] = useState<JQuery<HTMLElement>>();
const highlightSearch = useImperativeSearchHighlighlighting(highlightedTokens); const highlightSearch = useImperativeSearchHighlighlighting(highlightedTokens);
const [ noteTitle, setNoteTitle ] = useState<string>();
useEffect(() => { useEffect(() => {
link.createLink(stringifiedNotePath, { link.createLink(stringifiedNotePath, {
@ -30,7 +32,7 @@ export default function NoteLink({ className, notePath, showNotePath, showNoteIc
showNoteIcon, showNoteIcon,
viewScope viewScope
}).then(setJqueryEl); }).then(setJqueryEl);
}, [ stringifiedNotePath, showNotePath, title, viewScope ]); }, [ stringifiedNotePath, showNotePath, title, viewScope, noteTitle ]);
useEffect(() => { useEffect(() => {
if (!ref.current || !jqueryEl) return; if (!ref.current || !jqueryEl) return;
@ -38,6 +40,16 @@ export default function NoteLink({ className, notePath, showNotePath, showNoteIc
highlightSearch(ref.current); highlightSearch(ref.current);
}, [ jqueryEl, highlightedTokens ]); }, [ jqueryEl, highlightedTokens ]);
useTriliumEvent("entitiesReloaded", ({ loadResults }) => {
// React to note title changes, but only if the title is not overwritten.
if (!title && noteId) {
const entityRow = loadResults.getEntityRow("notes", noteId);
if (entityRow) {
setNoteTitle(entityRow.title);
}
}
});
if (style) { if (style) {
jqueryEl?.css(style); jqueryEl?.css(style);
} }

View File

@ -5,14 +5,14 @@
<p>In Trilium, attributes are key-value pairs assigned to notes, providing <p>In Trilium, attributes are key-value pairs assigned to notes, providing
additional metadata or functionality. There are two primary types of attributes:</p> additional metadata or functionality. There are two primary types of attributes:</p>
<ol> <ol>
<li> <li data-list-item-id="ef9c097e5af906754a4056ace4d16dbee">
<p><a class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a>&nbsp;can <p><a class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a>&nbsp;can
be used for a variety of purposes, such as storing metadata or configuring be used for a variety of purposes, such as storing metadata or configuring
the behavior of notes. Labels are also searchable, enhancing note retrieval.</p> the behavior of notes. Labels are also searchable, enhancing note retrieval.</p>
<p>For more information, including predefined labels, see&nbsp;<a class="reference-link" <p>For more information, including predefined labels, see&nbsp;<a class="reference-link"
href="#root/_help_HI6GBBIduIgv">Labels</a>.</p> href="#root/_help_HI6GBBIduIgv">Labels</a>.</p>
</li> </li>
<li> <li data-list-item-id="e8416f6f5188a4d8a25917c610a1482c0">
<p><a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;define <p><a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;define
connections between notes, similar to links. These can be used for metadata connections between notes, similar to links. These can be used for metadata
and scripting purposes.</p> and scripting purposes.</p>
@ -23,6 +23,30 @@
</ol> </ol>
<p>These attributes play a crucial role in organizing, categorizing, and <p>These attributes play a crucial role in organizing, categorizing, and
enhancing the functionality of notes.</p> enhancing the functionality of notes.</p>
<h2>Types of attributes</h2>
<p>Conceptually there are two types of attributes (applying to both labels
and relations):</p>
<ol>
<li data-list-item-id="e778cee42c209e30e41f7d2c99895495d"><strong>System attributes</strong>
<br>As the name suggest, these attributes have a special meaning since they
are interpreted by Trilium. For example the <code>color</code> attribute
will change the color of the note as displayed in the&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and
links, and <code>iconClass</code> will change the icon of a note.
<br>&nbsp;</li>
<li data-list-item-id="e0ca0ab889b471e7c18e3d4f6ae6a61e0"><strong>User-defined attributes</strong>
<br>These are free-form labels or relations that can be used by the user.
They can be used purely for categorization purposes (especially if combined
with&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_eIg8jdvaoNNd">Search</a>),
or they can be given meaning through the use of&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/_help_CdNpE2pqjmI6">Scripting</a>.</li>
</ol>
<p>In practice, Trilium makes no direct distinction of whether an attribute
is a system one or a user-defined one. A label or relation is considered
a system attribute if it matches one of the built-in names (e.g. like the
aforementioned <code>iconClass</code>). Keep this in mind when creating
&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;in
order not to accidentally alter a system attribute (unless intended).</p>
<h2>Viewing the list of attributes</h2> <h2>Viewing the list of attributes</h2>
<p>Both the labels and relations for the current note are displayed in the <em>Owned Attributes</em> section <p>Both the labels and relations for the current note are displayed in the <em>Owned Attributes</em> section
of the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>, of the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
@ -31,13 +55,15 @@
only be viewed.</p> only be viewed.</p>
<p>In the list of attributes, labels are prefixed with the <code>#</code> character <p>In the list of attributes, labels are prefixed with the <code>#</code> character
whereas relations are prefixed with the <code>~</code> character.</p> whereas relations are prefixed with the <code>~</code> character.</p>
<h2>Attribute Definitions and Promoted Attributes</h2>
<p><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;create
a form-like editing experience for attributes, which makes it easy to enhancing
the organization and management of attributes</p>
<h2>Multiplicity</h2> <h2>Multiplicity</h2>
<p>Attributes in Trilium can be "multi-valued", meaning multiple attributes <p>Attributes in Trilium can be "multi-valued", meaning multiple attributes
with the same name can co-exist.</p> with the same name can co-exist. This can be combined with&nbsp;<a class="reference-link"
<h2>Attribute Definitions and Promoted Attributes</h2> href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to
<p>Special labels create "label/attribute" definitions, enhancing the organization easily add them.</p>
and management of attributes. For more details, see&nbsp;<a class="reference-link"
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>.</p>
<h2>Attribute Inheritance</h2> <h2>Attribute Inheritance</h2>
<p>Trilium supports attribute inheritance, allowing child notes to inherit <p>Trilium supports attribute inheritance, allowing child notes to inherit
attributes from their parents. For more information, see&nbsp;<a class="reference-link" attributes from their parents. For more information, see&nbsp;<a class="reference-link"

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

View File

@ -1,31 +1,118 @@
<figure class="image image_resized" style="width:61.4%;">
<img style="aspect-ratio:938/368;" src="Promoted Attributes_image.png"
width="938" height="368">
</figure>
<p>Promoted attributes are <a href="#root/_help_zEY4DaJG4YT5">attributes</a> which <p>Promoted attributes are <a href="#root/_help_zEY4DaJG4YT5">attributes</a> which
are considered important and thus are "promoted" onto the main note UI. are displayed prominently in the UI which allow them to be easily viewed
See example below:</p> and edited.</p>
<p> <p>One way of seeing promoted attributes is as a kind of form with several
<img src="Promoted Attributes_promot.png"> fields. Each field is just regular attribute, the only difference is that
</p> they appear on the note itself.</p>
<p>You can see the note having kind of form with several fields. Each of
these is just regular attribute, the only difference is that they appear
on the note itself.</p>
<p>Attributes can be pretty useful since they allow for querying and script <p>Attributes can be pretty useful since they allow for querying and script
automation etc. but they are also inconveniently hidden. This allows you automation etc. but they are also inconveniently hidden. This allows you
to select few of the important ones and push them to the front of the user.</p> to select few of the important ones and push them to the front of the user.</p>
<p>Now, how do we make attribute to appear on the UI?</p>
<h2>Attribute definition</h2> <h2>Attribute definition</h2>
<p>Attribute is always name-value pair where both name and value are strings.</p> <p>In order to have promoted attributes, there needs to be a way to define
<p><em>Attribute definition</em> specifies how should this value be interpreted them.</p>
- is it just string, or is it a date? Should we allow multiple values or <figure class="image image-style-align-right image_resized" style="width:38.82%;">
note? And importantly, should we <em>promote</em> the attribute or not?</p> <img style="aspect-ratio:492/346;" src="1_Promoted Attributes_image.png"
<p> width="492" height="346">
<img src="Promoted Attributes_image.png"> </figure>
</p> <p>Technically, attributes are only name-value pairs where both name and
<p>You can notice tag attribute definition. These "definition" attributes value are strings.</p>
define how the "value" attributes should behave.</p> <p>The <em>Attribute definition</em> specifies how should this value be interpreted:</p>
<ul>
<li data-list-item-id="e73e2d8dffca4fe59d009bfc5a245da88">Is it just string, or is it a date?</li>
<li data-list-item-id="e115a58c2d81149f481c385479cf06965">Should we allow multiple values or note?</li>
<li data-list-item-id="eb8cab0b2fdcefb7af9128f63b3b9f4ee">Should we <em>promote</em> the attribute or not?</li>
</ul>
<h2>Creating a new promoted attribute definition</h2>
<p>To create a new promoted attribute:</p>
<ol>
<li data-list-item-id="e118d34c98d285e3a7492876f73a49ed5">Go to a note.</li>
<li data-list-item-id="e480cc90d938f7f728011679df29f6ce0">Go to <em>Owned Attributes</em> in the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>.</li>
<li
data-list-item-id="e40a26a8a32714572e670d8c7c18d1355">Press the + button.</li>
<li data-list-item-id="e5ba4dcc8ae48c7f043de2c8fc5ec1c2c">Select either <em>Add new label definition</em> or <em>Add new relation definition</em>.</li>
<li
data-list-item-id="e14e894cf6d207a410adbe87c56143799">Select the name which will be name of the label or relation that will
be created when the promoted attribute is edited.</li>
<li data-list-item-id="e5d803cd5a37a7169a5aa770d769f2dd4">Ensure <em>Promoted</em> is checked in order to display it at the top of
notes.</li>
<li data-list-item-id="e50c81da6343840b2a06b46a20e21181e">Optionally, choose an <em>Alias</em> which will be displayed next to the
promoted attribute instead of the attribute name. Generally it's best to
choose a “user-friendly” name since it can contain spaces and other characters
which are not supported as attribute names.</li>
<li data-list-item-id="e0e08c63296b88ea8ec8ae17104eed366">Check <em>Inheritable</em> to apply it to this note and all its descendants.
To keep it only for the current note, un-check it.</li>
<li data-list-item-id="ededc09be314b651d919aebd026cc5b86">Press “Save &amp; Close” to apply the changes.</li>
</ol>
<h2>How attribute definitions actually work</h2>
<p>When a new promoted attribute definition is created, it creates a corresponding
label prefixed with either <code>label</code> or <code>relation</code>, depending
on the definition type:</p><pre><code class="language-text-x-trilium-auto">#label:myColor(inheritable)="promoted,alias=Color,multi,color"</code></pre>
<p>The only purpose of the attribute definition is to set up a template.
If the attribute was marked as promoted, then it's also displayed to the
user for easy editing.</p>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:47.64%;">
<col style="width:52.36%;">
</colgroup>
<tbody>
<tr>
<td>
<figure class="image">
<img style="aspect-ratio:495/157;" src="2_Promoted Attributes_image.png"
width="495" height="157">
</figure>
</td>
<td>Notice how the promoted attribute definition only creates a “Due date”
box above the text content.</td>
</tr>
<tr>
<td>
<figure class="image">
<img style="aspect-ratio:663/160;" src="3_Promoted Attributes_image.png"
width="663" height="160">
</figure>
</td>
<td>Once a value is set by the user, a new label (or relation, depending on
the type) is created. The name of the attribute matches one set when creating
the promoted attribute.</td>
</tr>
</tbody>
</table>
</figure>
<p>So there's one attribute for value and one for definition. But notice <p>So there's one attribute for value and one for definition. But notice
how definition attribute is <a href="#root/_help_bwZpz2ajCEwO">Inheritable</a>, how an definition attribute can be made <a href="#root/_help_bwZpz2ajCEwO">Inheritable</a>,
meaning that it's also applied to all descendant note. So in a way, this meaning that it's also applied to all descendant notes. In this case, the
definition is used for the whole subtree while "value" attributes are applied definition used for the whole sub-tree while "value" attributes are for
only for this note.</p> each not individually.</p>
<h2>Using system attributes</h2>
<p>It's possible to create promoted attributes out of system attributes,
to be able to easily alter them.</p>
<p>Here are a few practical examples:</p>
<ul>
<li data-list-item-id="eb7e4e362b582d6bf480375d1e5648ac3"><a class="reference-link" href="#root/pOsGYCXsbNQG/_help_GTwFsgaA0lCt">Collections</a>&nbsp;already
make use of this practice, for example:
<ul>
<li data-list-item-id="e0831925d935c7a90f90bd5fed94d089e">Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as
promoted attributes. These map to system attributes such as <code>startDate</code> which
are then interpreted by the calendar view.</li>
<li data-list-item-id="e4a235f12a7934803ba7706e309511c82"><a class="reference-link" href="#root/pOsGYCXsbNQG/GTwFsgaA0lCt/_help_zP3PMqaG71Ct">Presentation</a>&nbsp;adds
a “Background” promoted attribute for each of the slide to easily be able
to customize.</li>
</ul>
</li>
<li data-list-item-id="e9069ad779c177b7ed0d3ece786e73cd3">The Trilium documentation (which is edited in Trilium) uses a promoted
attribute to be able to easily edit the <code>#shareAlias</code> (see&nbsp;
<a
class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_R9pX4DGra2Vt">Sharing</a>) in order to form clean URLs.</li>
<li data-list-item-id="ed14685a7279b42a1769be97ffe7f5e8f">If you always edit a particular system attribute such as <code>#color</code>,
simply create a promoted attribute for it to make it easier.</li>
</ul>
<h3>Inverse relation</h3> <h3>Inverse relation</h3>
<p>Some relations always occur in pairs - my favorite example is on the family. <p>Some relations always occur in pairs - my favorite example is on the family.
If you have a note representing husband and note representing wife, then If you have a note representing husband and note representing wife, then
@ -33,7 +120,7 @@
This is bidirectional relationship - meaning that if a relation is pointing This is bidirectional relationship - meaning that if a relation is pointing
from husband to wife then there should be always another relation pointing from husband to wife then there should be always another relation pointing
from wife to husband.</p> from wife to husband.</p>
<p>Another example is with parent - child relationship. Again these always <p>Another example is with parent-child relationship. Again these always
occur in pairs, but in this case it's not exact same relation - the one occur in pairs, but in this case it's not exact same relation - the one
going from parent to child might be called <code>isParentOf</code> and the going from parent to child might be called <code>isParentOf</code> and the
other one going from child to parent might be called <code>isChildOf</code>.</p> other one going from child to parent might be called <code>isChildOf</code>.</p>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -1,8 +1,11 @@
<aside class="admonition important"> <aside class="admonition important">
<p>Starting with Trilium v0.97.0, the geo map has been converted from a standalone <p><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_zEY4DaJG4YT5">Attributes</a>
<a <a
href="#root/_help_KSZ04uQ2D1St">note type</a>to a type of view for the&nbsp;<a class="reference-link" class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_zEY4DaJG4YT5">Attributes</a>Starting
href="#root/_help_0ESUbbAxVnoK">Note List</a>.&nbsp;</p> with Trilium v0.97.0, the geo map has been converted from a standalone
<a
href="#root/_help_KSZ04uQ2D1St">note type</a>to a type of view for the&nbsp;<a class="reference-link"
href="#root/_help_0ESUbbAxVnoK">Note List</a>.&nbsp;</p>
</aside> </aside>
<figure class="image image-style-align-center"> <figure class="image image-style-align-center">
<img style="aspect-ratio:892/675;" src="9_Geo Map_image.png" <img style="aspect-ratio:892/675;" src="9_Geo Map_image.png"
@ -12,121 +15,127 @@
on an attribute. It is also possible to add new notes at a specific location on an attribute. It is also possible to add new notes at a specific location
using the built-in interface.</p> using the built-in interface.</p>
<h2>Creating a new geo map</h2> <h2>Creating a new geo map</h2>
<table> <figure class="table">
<thead> <table>
<tr> <thead>
<th></th> <tr>
<th></th> <th>&nbsp;</th>
<th></th> <th>&nbsp;</th>
</tr> <th>&nbsp;</th>
</thead> </tr>
<tbody> </thead>
<tr> <tbody>
<td>1</td> <tr>
<td> <td>1</td>
<figure class="image"> <td>
<img style="aspect-ratio:483/413;" src="15_Geo Map_image.png" <figure class="image">
width="483" height="413"> <img style="aspect-ratio:483/413;" src="15_Geo Map_image.png"
</figure> width="483" height="413">
</td> </figure>
<td>Right click on any note on the note tree and select <em>Insert child note</em><em>Geo Map (beta)</em>.</td> </td>
</tr> <td>Right click on any note on the note tree and select <em>Insert child note</em><em>Geo Map (beta)</em>.</td>
<tr> </tr>
<td>2</td> <tr>
<td> <td>2</td>
<figure class="image image-style-align-center image_resized" style="width:53.44%;"> <td>
<img style="aspect-ratio:1720/1396;" src="8_Geo Map_image.png" <figure class="image image-style-align-center image_resized" style="width:53.44%;">
width="1720" height="1396"> <img style="aspect-ratio:1720/1396;" src="8_Geo Map_image.png"
</figure> width="1720" height="1396">
</td> </figure>
<td>By default the map will be empty and will show the entire world.</td> </td>
</tr> <td>By default the map will be empty and will show the entire world.</td>
</tbody> </tr>
</table> </tbody>
</table>
</figure>
<h2>Repositioning the map</h2> <h2>Repositioning the map</h2>
<ul> <ul>
<li>Click and drag the map in order to move across the map.</li> <li data-list-item-id="ec3df228f80922b4531e2dd1a977d81b8">Click and drag the map in order to move across the map.</li>
<li>Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons <li data-list-item-id="ee505c643c5bacffffc42119cc2f19c60">Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
on the top-left to adjust the zoom.</li> on the top-left to adjust the zoom.</li>
</ul> </ul>
<p>The position on the map and the zoom are saved inside the map note and <p>The position on the map and the zoom are saved inside the map note and
restored when visiting again the note.</p> restored when visiting again the note.</p>
<h2>Adding a marker using the map</h2> <h2>Adding a marker using the map</h2>
<h3>Adding a new note using the plus button</h3> <h3>Adding a new note using the plus button</h3>
<table> <figure class="table">
<thead> <table>
<tr> <thead>
<th></th> <tr>
<th></th> <th>&nbsp;</th>
<th></th> <th>&nbsp;</th>
</tr> <th>&nbsp;</th>
</thead> </tr>
<tbody> </thead>
<tr> <tbody>
<td>1</td> <tr>
<td>To create a marker, first navigate to the desired point on the map. Then <td>1</td>
press the <td>To create a marker, first navigate to the desired point on the map. Then
<img src="10_Geo Map_image.png">button in the&nbsp;<a href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;(top-right) press the
area.&nbsp;&nbsp;&nbsp; <img src="10_Geo Map_image.png">button in the&nbsp;<a href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;(top-right)
<br> area.&nbsp;&nbsp;&nbsp;&nbsp;
<br>If the button is not visible, make sure the button section is visible <br>
by pressing the chevron button ( <br>If the button is not visible, make sure the button section is visible
<img src="17_Geo Map_image.png">) in the top-right of the map.</td> by pressing the chevron button (
<td></td> <img src="17_Geo Map_image.png">) in the top-right of the map.</td>
</tr> <td>&nbsp;</td>
<tr> </tr>
<td>2</td> <tr>
<td> <td>2</td>
<img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map_image.png" <td>
width="1730" height="416"> <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map_image.png"
</td> width="1730" height="416">
<td>Once pressed, the map will enter in the insert mode, as illustrated by </td>
the notification.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <td>Once pressed, the map will enter in the insert mode, as illustrated by
<br> the notification.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>Simply click the point on the map where to place the marker, or the Escape <br>
key to cancel.</td> <br>Simply click the point on the map where to place the marker, or the Escape
</tr> key to cancel.</td>
<tr> </tr>
<td>3</td> <tr>
<td> <td>3</td>
<img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map_image.png" <td>
width="1586" height="404"> <img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map_image.png"
</td> width="1586" height="404">
<td>Enter the name of the marker/note to be created.</td> </td>
</tr> <td>Enter the name of the marker/note to be created.</td>
<tr> </tr>
<td>4</td> <tr>
<td> <td>4</td>
<img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map_image.png" <td>
width="1696" height="608"> <img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map_image.png"
</td> width="1696" height="608">
<td>Once confirmed, the marker will show up on the map and it will also be </td>
displayed as a child note of the map.</td> <td>Once confirmed, the marker will show up on the map and it will also be
</tr> displayed as a child note of the map.</td>
</tbody> </tr>
</table> </tbody>
</table>
</figure>
<h3>Adding a new note using the contextual menu</h3> <h3>Adding a new note using the contextual menu</h3>
<ol> <ol>
<li>Right click anywhere on the map, where to place the newly created marker <li data-list-item-id="ea014287557d9fbca07dd30b32405f92a">Right click anywhere on the map, where to place the newly created marker
(and corresponding note).</li> (and corresponding note).</li>
<li>Select <em>Add a marker at this location</em>.</li> <li data-list-item-id="ef758bd1a52c2ced75e402fd68e3d1e67">Select <em>Add a marker at this location</em>.</li>
<li>Enter the name of the newly created note.</li> <li data-list-item-id="e6f1d66e9d872ac4908a7c11b401a9d80">Enter the name of the ne<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>wly
<li>The map should be updated with the new marker.</li> created note.</li>
<li data-list-item-id="eed9a3fbe500d61c76729f6147ceed925">The map should be updated with the new marker.</li>
</ol> </ol>
<h3>Adding an existing note on note from the note tree</h3> <h3>Adding an existing note on note from the note tree</h3>
<ol> <ol>
<li>Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li> <li data-list-item-id="ecba60e77600a1660e947ce54c633df04">Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>Hold the mouse on the note and drag it to the map to the desired location.</li> <li
<li>The map should be updated with the new marker.</li> data-list-item-id="e00bb8f41cf79fef2b5ce215bc678f808">Hold the mouse on the note and drag it to the map to the desired location.</li>
<li
data-list-item-id="e3fc69dc9e44db125872274e68223cd4e">The map should be updated with the new marker.</li>
</ol> </ol>
<p>This works for:</p> <p>This works for:</p>
<ul> <ul>
<li>Notes that are not part of the geo map, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will <li data-list-item-id="e0821dbcf20fa4a83a9cfada4bea95521">Notes that are not part of the geo map, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
be created.</li> be created.</li>
<li>Notes that are a child of the geo map but not yet positioned on the map.</li> <li data-list-item-id="e859aa76bcb592afd7414cccb60cdd3ed">Notes that are a child of the geo map but not yet positioned on the map.</li>
<li>Notes that are a child of the geo map and also positioned, case in which <li
data-list-item-id="e74fb2b74919aba44e1a457a5f8aec6b8">Notes that are a child of the geo map and also positioned, case in which
the marker will be relocated to the new position.</li> the marker will be relocated to the new position.</li>
</ul> </ul>
<aside class="admonition note"> <aside class="admonition note">
@ -136,8 +145,10 @@
<h2>How the location of the markers is stored</h2> <h2>How the location of the markers is stored</h2>
<p>The location of a marker is stored in the <code>#geolocation</code> attribute <p>The location of a marker is stored in the <code>#geolocation</code> attribute
of the child notes:</p> of the child notes:</p>
<img src="18_Geo Map_image.png" <p>
width="1288" height="278"> <img src="18_Geo Map_image.png" width="1288"
height="278">
</p>
<p>This value can be added manually if needed. The value of the attribute <p>This value can be added manually if needed. The value of the attribute
is made up of the latitude and longitude separated by a comma.</p> is made up of the latitude and longitude separated by a comma.</p>
<h2>Repositioning markers</h2> <h2>Repositioning markers</h2>
@ -149,16 +160,17 @@ width="1288" height="278">
page (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) to cancel it.</p> page (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) to cancel it.</p>
<h2>Interaction with the markers</h2> <h2>Interaction with the markers</h2>
<ul> <ul>
<li>Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>&nbsp;with <li data-list-item-id="e953e0022167e10d476bbf438b71029ee">Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>&nbsp;with
the content of the note it belongs to. the content of the note it belongs to.
<ul> <ul>
<li>Clicking on the note title in the tooltip will navigate to the note in <li data-list-item-id="e24f6ec1307f470fc8a9c0681282dd424">Clicking on the note title in the tooltip will navigate to the note in
the current view.</li> the current view.</li>
</ul> </ul>
</li> </li>
<li>Middle-clicking the marker will open the note in a new tab.</li> <li data-list-item-id="ea6f9b375776db475c00f3d308f170cb1">Middle-clicking the marker will open the note in a new tab.</li>
<li>Right-clicking the marker will open a contextual menu (as described below).</li> <li data-list-item-id="e26942774d668ca9d49e1cfc797801516">Right-clicking the marker will open a contextual menu (as described below).</li>
<li>If the map is in read-only mode, clicking on a marker will open a&nbsp; <li
data-list-item-id="edcf8a4a4e252ae3757303fc28c6e549e">If the map is in read-only mode, clicking on a marker will open a&nbsp;
<a <a
class="reference-link" href="#root/_help_ZjLYv08Rp3qC">Quick edit</a>&nbsp;popup for the corresponding note.</li> class="reference-link" href="#root/_help_ZjLYv08Rp3qC">Quick edit</a>&nbsp;popup for the corresponding note.</li>
</ul> </ul>
@ -166,24 +178,24 @@ width="1288" height="278">
<p>It's possible to press the right mouse button to display a contextual <p>It's possible to press the right mouse button to display a contextual
menu.</p> menu.</p>
<ol> <ol>
<li>If right-clicking an empty section of the map (not on a marker), it allows <li data-list-item-id="e529cc53e555215e949135d9998ac4d06">If right-clicking an empty section of the map (not on a marker), it allows
to: to:
<ol> <ol>
<li>Displays the latitude and longitude. Clicking this option will copy them <li data-list-item-id="e18b27ec2d655ca2e29328c6cc899cccf">Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li> to the clipboard.</li>
<li>Open the location using an external application (if the operating system <li data-list-item-id="ebecfc3495ce94589ebdaa3479e70a8ea">Open the location using an external application (if the operating system
supports it).</li> supports it).</li>
<li>Adding a new marker at that location.</li> <li data-list-item-id="e1e1e816904064ed2457553dbcf58f373">Adding a new marker at that location.</li>
</ol> </ol>
</li> </li>
<li>If right-clicking on a marker, it allows to: <li data-list-item-id="eadf4de9e1e967bfcbf7274b8e7613c8e">If right-clicking on a marker, it allows to:
<ol> <ol>
<li>Displays the latitude and longitude. Clicking this option will copy them <li data-list-item-id="ebd32992e411b3a755008b1036448f7e9">Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li> to the clipboard.</li>
<li>Open the location using an external application (if the operating system <li data-list-item-id="e5e8bf64b872e1bf32a53459b05d05263">Open the location using an external application (if the operating system
supports it).</li> supports it).</li>
<li>Open the note in a new tab, split or window.</li> <li data-list-item-id="ec83b4469031db305a1d3f9a4d36b395d">Open the note in a new tab, split or window.</li>
<li>Remove the marker from the map, which will remove the <code>#geolocation</code> attribute <li data-list-item-id="e49f6d549515bec0d6bd8bccf3d34d269">Remove the marker from the map, which will remove the <code>#geolocation</code> attribute
of the note. To add it back again, the coordinates have to be manually of the note. To add it back again, the coordinates have to be manually
added back in.</li> added back in.</li>
</ol> </ol>
@ -203,209 +215,215 @@ width="1288" height="278">
<p>The value of the attribute is made up of the latitude and longitude separated <p>The value of the attribute is made up of the latitude and longitude separated
by a comma.</p> by a comma.</p>
<h3>Adding from Google Maps</h3> <h3>Adding from Google Maps</h3>
<table> <figure class="table">
<thead> <table>
<tr> <thead>
<th></th> <tr>
<th></th> <th>&nbsp;</th>
<th></th> <th>&nbsp;</th>
</tr> <th>&nbsp;</th>
</thead> </tr>
<tbody> </thead>
<tr> <tbody>
<td>1</td> <tr>
<td> <td>1</td>
<figure class="image image-style-align-center image_resized" style="width:56.84%;"> <td>
<img style="aspect-ratio:732/918;" src="12_Geo Map_image.png" <figure class="image image-style-align-center image_resized" style="width:56.84%;">
width="732" height="918"> <img style="aspect-ratio:732/918;" src="12_Geo Map_image.png"
</figure> width="732" height="918">
</td> </figure>
<td>Go to Google Maps on the web and look for a desired location, right click </td>
on it and a context menu will show up.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <td>Go to Google Maps on the web and look for a desired location, right click
<br> on it and a context menu will show up.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>Simply click on the first item displaying the coordinates and they will <br>
be copied to clipboard.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>Simply click on the first item displaying the coordinates and they will
<br> be copied to clipboard.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>Then paste the value inside the text box into the <code>#geolocation</code> attribute <br>
of a child note of the map (don't forget to surround the value with a <code>"</code> character).</td> <br>Then paste the value inside the text box into the <code>#geolocation</code> attribute
</tr> of a child note of the map (don't forget to surround the value with a <code>"</code> character).</td>
<tr> </tr>
<td>2</td> <tr>
<td> <td>2</td>
<figure class="image image-style-align-center image_resized" style="width:100%;"> <td>
<img style="aspect-ratio:518/84;" src="4_Geo Map_image.png" <figure class="image image-style-align-center image_resized" style="width:100%;">
width="518" height="84"> <img style="aspect-ratio:518/84;" src="4_Geo Map_image.png"
</figure> width="518" height="84">
</td> </figure>
<td>In Trilium, create a child note under the map.</td> </td>
</tr> <td>In Trilium, create a child note under the map.</td>
<tr> </tr>
<td>3</td> <tr>
<td> <td>3</td>
<figure class="image image-style-align-center image_resized" style="width:100%;"> <td>
<img style="aspect-ratio:1074/276;" src="11_Geo Map_image.png" <figure class="image image-style-align-center image_resized" style="width:100%;">
width="1074" height="276"> <img style="aspect-ratio:1074/276;" src="11_Geo Map_image.png"
</figure> width="1074" height="276">
</td> </figure>
<td>And then go to Owned Attributes and type <code>#geolocation="</code>, then </td>
paste from the clipboard as-is and then add the ending <code>"</code> character. <td>And then go to Owned Attributes and type <code>#geolocation="</code>, then
Press Enter to confirm and the map should now be updated to contain the paste from the clipboard as-is and then add the ending <code>"</code> character.
new note.</td> Press Enter to confirm and the map should now be updated to contain the
</tr> new note.</td>
</tbody> </tr>
</table> </tbody>
</table>
</figure>
<h3>Adding from OpenStreetMap</h3> <h3>Adding from OpenStreetMap</h3>
<p>Similarly to the Google Maps approach:</p> <p>Similarly to the Google Maps approach:</p>
<table> <figure class="table">
<thead> <table>
<tr> <thead>
<th></th> <tr>
<th></th> <th>&nbsp;</th>
<th></th> <th>&nbsp;</th>
</tr> <th>&nbsp;</th>
</thead> </tr>
<tbody> </thead>
<tr> <tbody>
<td>1</td> <tr>
<td> <td>1</td>
<img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map_image.png" <td>
width="562" height="454"> <img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map_image.png"
</td> width="562" height="454">
<td>Go to any location on openstreetmap.org and right click to bring up the </td>
context menu. Select the “Show address” item.</td> <td>Go to any location on openstreetmap.org and right click to bring up the
</tr> context menu. Select the “Show address” item.</td>
<tr> </tr>
<td>2</td> <tr>
<td> <td>2</td>
<img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map_image.png" <td>
width="696" height="480"> <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map_image.png"
</td> width="696" height="480">
<td>The address will be visible in the top-left of the screen, in the place </td>
of the search bar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <td>The address will be visible in the top-left of the screen, in the place
<br> of the search bar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>Select the coordinates and copy them into the clipboard.</td> <br>
</tr> <br>Select the coordinates and copy them into the clipboard.</td>
<tr> </tr>
<td>3</td> <tr>
<td> <td>3</td>
<img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map_image.png" <td>
width="640" height="276"> <img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map_image.png"
</td> width="640" height="276">
<td>Simply paste the value inside the text box into the <code>#geolocation</code> attribute </td>
of a child note of the map and then it should be displayed on the map.</td> <td>Simply paste the value inside the text box into the <code>#geolocation</code> attribute
</tr> of a child note of the map and then it should be displayed on the map.</td>
</tbody> </tr>
</table> </tbody>
</table>
</figure>
<h2>Adding GPS tracks (.gpx)</h2> <h2>Adding GPS tracks (.gpx)</h2>
<p>Trilium has basic support for displaying GPS tracks on the geo map.</p> <p>Trilium has basic support for displaying GPS tracks on the geo map.</p>
<table> <figure
<thead> class="table">
<tr> <table>
<th></th> <thead>
<th></th> <tr>
<th></th> <th>&nbsp;</th>
</tr> <th>&nbsp;</th>
</thead> <th>&nbsp;</th>
<tbody> </tr>
<tr> </thead>
<td>1</td> <tbody>
<td> <tr>
<figure class="image image-style-align-center"> <td>1</td>
<img style="aspect-ratio:226/74;" src="3_Geo Map_image.png" <td>
width="226" height="74"> <figure class="image image-style-align-center">
</figure> <img style="aspect-ratio:226/74;" src="3_Geo Map_image.png"
</td> width="226" height="74">
<td>To add a track, simply drag &amp; drop a .gpx file inside the geo map </figure>
in the note tree.</td> </td>
</tr> <td>To add a track, simply drag &amp; drop a .gpx file inside the geo map
<tr> in the note tree.</td>
<td>2</td> </tr>
<td> <tr>
<figure class="image image-style-align-center"> <td>2</td>
<img style="aspect-ratio:322/222;" src="14_Geo Map_image.png" <td>
width="322" height="222"> <figure class="image image-style-align-center">
</figure> <img style="aspect-ratio:322/222;" src="14_Geo Map_image.png"
</td> width="322" height="222">
<td>In order for the file to be recognized as a GPS track, it needs to show </figure>
up as <code>application/gpx+xml</code> in the <em>File type</em> field.</td> </td>
</tr> <td>In order for the file to be recognized as a GPS track, it needs to show
<tr> up as <code>application/gpx+xml</code> in the <em>File type</em> field.</td>
<td>3</td> </tr>
<td> <tr>
<figure class="image image-style-align-center"> <td>3</td>
<img style="aspect-ratio:620/530;" src="6_Geo Map_image.png" <td>
width="620" height="530"> <figure class="image image-style-align-center">
</figure> <img style="aspect-ratio:620/530;" src="6_Geo Map_image.png"
</td> width="620" height="530">
<td>When going back to the map, the track should now be visible.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </figure>
<br> </td>
<br>The start and end points of the track are indicated by the two blue markers.</td> <td>When going back to the map, the track should now be visible.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tr> <br>
</tbody> <br>The start and end points of the track are indicated by the two blue markers.</td>
</table> </tr>
<aside class="admonition note"> </tbody>
<p>The starting point of the track will be displayed as a marker, with the </table>
name of the note underneath. The start marker will also respect the icon </figure>
and the <code>color</code> of the note. The end marker is displayed with <aside class="admonition note">
a distinct icon.</p> <p>The starting point of the track will be displayed as a marker, with the
<p>If the GPX contains waypoints, they will also be displayed. If they have name of the note underneath. The start marker will also respect the icon
a name, it is displayed when hovering over it with the mouse.</p> and the <code>color</code> of the note. The end marker is displayed with
</aside> a distinct icon.</p>
<h2>Read-only mode</h2> <p>If the GPX contains waypoints, they will also be displayed. If they have
<p>When a map is in read-only all editing features will be disabled such a name, it is displayed when hovering over it with the mouse.</p>
as:</p> </aside>
<ul> <h2>Read-only mode</h2>
<li>The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li> <p>When a map is in read-only all editing features will be disabled such
<li>Dragging markers.</li> as:</p>
<li>Editing from the contextual menu (removing locations or adding new items).</li> <ul>
</ul> <li data-list-item-id="e78bca8f945a953c13efaf287001d0edb">The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li>
<p>To enable read-only mode simply press the <em>Lock</em> icon from the&nbsp; <li
<a data-list-item-id="e022d4fc44c13cf5f529ea18729df3897">Dragging markers.</li>
class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>. To disable it, press the button again.</p> <li data-list-item-id="e0d024b930867c0253e98c322d3bea021">Editing from the contextual menu (removing locations or adding new items).</li>
<h2>Configuration</h2> </ul>
<h3>Map Style</h3> <p>To enable read-only mode simply press the <em>Lock</em> icon from the&nbsp;
<p>The styling of the map can be adjusted in the <em>Collection Properties</em> tab <a
in the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>. To disable it, press the button again.</p>
manually via the <code>#map:style</code> attribute.</p> <h2>Configuration</h2>
<p>The geo map comes with two different types of styles:</p> <h3>Map Style</h3>
<ul> <p>The styling of the map can be adjusted in the <em>Collection Properties</em> tab
<li>Raster styles in the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
<ul> manually via the <code>#map:style</code> attribute.</p>
<li>For these styles the map is represented as a grid of images at different <p>The geo map comes with two different types of styles:</p>
zoom levels. This is the traditional way OpenStreetMap used to work.</li> <ul>
<li>Zoom is slightly restricted.</li> <li data-list-item-id="ee111daf471290ce8f16adb8ff6255e78">Raster styles
<li>Currently, the only raster theme is the original OpenStreetMap style.</li> <ul>
<li data-list-item-id="ebecb845ceda41068a106693c5a1244e3">For these styles the map is represented as a grid of images at different
zoom levels. This is the traditional way OpenStreetMap used to work.</li>
<li
data-list-item-id="e60a827a1f29105ea8321184d4fb4f0a2">Zoom is slightly restricted.</li>
<li data-list-item-id="e2eb8282db9496f32beeddd53a72fea2a">Currently, the only raster theme is the original OpenStreetMap style.</li>
</ul> </ul>
</li> </li>
<li>Vector styles <li data-list-item-id="e01494841aec47f71245855fe95ad4adb">Vector styles
<ul> <ul>
<li>Vector styles are not represented as images, but as geometrical shapes. <li data-list-item-id="e87e7f879a4c7475769e73f1cfa1bc1b8">Vector styles are not represented as images, but as geometrical shapes.
This makes the rendering much smoother, especially when zooming and looking This makes the rendering much smoother, especially when zooming and looking
at the building edges, for example.</li> at the building edges, for example.</li>
<li>The map can be zoomed in much further.</li> <li data-list-item-id="ef95260bc6fcb49e63ff708077929b263">The map can be zoomed in much further.</li>
<li>These come both in a light and a dark version.</li> <li data-list-item-id="e339157e4fdacc1b59f6c44cf29711032">These come both in a light and a dark version.</li>
<li>The vector styles come from <a href="https://versatiles.org/">VersaTiles</a>, <li data-list-item-id="e9be34d3c44b5dc1ecaa8c856642fc610">The vector styles come from <a href="https://versatiles.org/">VersaTiles</a>,
a free and open-source project providing map tiles based on OpenStreetMap.</li> a free and open-source project providing map tiles based on OpenStreetMap.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
<aside class="admonition note"> <aside class="admonition note">
<p>Currently it is not possible to use a custom map style.</p> <p>Currently it is not possible to use a custom map style.</p>
</aside> </aside>
<h3>Scale</h3> <h3>Scale</h3>
<p>Activating this option via the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or <p>Activating this option via the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
manually via <code>#map:scale</code> will display an indicator in the bottom-left manually via <code>#map:scale</code> will display an indicator in the bottom-left
of the scale of the map.</p> of the scale of the map.</p>
<h2>Troubleshooting</h2> <h2>Troubleshooting</h2>
<figure class="image image-style-align-right image_resized" style="width:34.06%;"> <figure class="image image-style-align-right image_resized" style="width:34.06%;">
<img style="aspect-ratio:678/499;" src="13_Geo Map_image.png" <img style="aspect-ratio:678/499;" src="13_Geo Map_image.png"
width="678" height="499"> width="678" height="499">
</figure> </figure>
<h3>Grid-like artifacts on the map</h3>
<h3>Grid-like artifacts on the map</h3> <p>This occurs if the application is not at 100% zoom which causes the pixels
<p>This occurs if the application is not at 100% zoom which causes the pixels of the map to not render correctly due to fractional scaling. The only
of the map to not render correctly due to fractional scaling. The only possible solution is to set the UI zoom at 100% (default keyboard shortcut
possible solution is to set the UI zoom at 100% (default keyboard shortcut is <kbd>Ctrl</kbd>+<kbd>0</kbd>).</p>
is <kbd>Ctrl</kbd>+<kbd>0</kbd>).</p>

View File

@ -1,5 +1,5 @@
<figure class="image"> <figure class="image">
<img style="aspect-ratio:918/248;" src="Kanban Board_image.png" <img style="aspect-ratio:918/248;" src="2_Kanban Board_image.png"
width="918" height="248"> width="918" height="248">
</figure> </figure>
<p>The Board view presents sub-notes in columns for a Kanban-like experience. <p>The Board view presents sub-notes in columns for a Kanban-like experience.
@ -15,83 +15,168 @@
<h2>Interaction</h2> <h2>Interaction</h2>
<h3>Working with columns</h3> <h3>Working with columns</h3>
<ul> <ul>
<li>Create a new column by pressing <em>Add Column</em> near the last column. <li data-list-item-id="ed78b9e2ac3200e097ae29e2d528c5e89">Create a new column by pressing <em>Add Column</em> near the last column.
<ul> <ul>
<li>Once pressed, a text box will be displayed to set the name of the column. <li data-list-item-id="ed5ddfffe11d0b328a8072e52be9c7492">Once pressed, a text box will be displayed to set the name of the column.
Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li> Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li>
</ul> </ul>
</li> </li>
<li>To reorder a column, simply hold the mouse over the title and drag it <li data-list-item-id="eeecd7ac7b32b1c29e7088ad172411862">To reorder a column, simply hold the mouse over the title and drag it
to the desired position.</li> to the desired position.</li>
<li>To delete a column, right click on its title and select <em>Delete column</em>.</li> <li data-list-item-id="e6bc6a4b20236a9d2c382a9564eef528f">To delete a column, right click on its title and select <em>Delete column</em>.</li>
<li>To rename a column, click on the note title. <li
data-list-item-id="ea3bd7adf8521c4c2fb2f3ef0cf4def28">To rename a column, click on the note title.
<ul> <ul>
<li>Press Enter to confirm.</li> <li data-list-item-id="eb1b0ee1c933e5ca2f4cb57a05b5c07eb">Press Enter to confirm.</li>
<li>Upon renaming a column, the corresponding status attribute of all its <li data-list-item-id="eabddc4dae9e10189e9c7dc087496e846">Upon renaming a column, the corresponding status attribute of all its
notes will be changed in bulk.</li> notes will be changed in bulk.</li>
</ul> </ul>
</li> </li>
<li>If there are many columns, use the mouse wheel to scroll.</li> <li data-list-item-id="efc70bbc5f0d1dc25e919a5b9e41a54e2">If there are many columns, use the mouse wheel to scroll.</li>
</ul> </ul>
<h3>Working with notes</h3> <h3>Working with notes</h3>
<ul> <ul>
<li>Create a new note in any column by pressing <em>New item</em> <li data-list-item-id="ee1000666f3c92f251a0262d5e2e30cbf">Create a new note in any column by pressing <em>New item</em>
<ul> <ul>
<li>Enter the name of the note and press <kbd>Enter</kbd> or click away. To <li data-list-item-id="ea3d86963b86f6820335c3994e3c7a00c">Enter the name of the note and press <kbd>Enter</kbd> or click away. To
dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave
the name empty.</li> the name empty.</li>
<li>Once created, the new note will have an attribute (<code>status</code> label <li data-list-item-id="ee8280e96edd38a1bc247ee34ea514c88">Once created, the new note will have an attribute (<code>status</code> label
by default) set to the name of the column.</li> by default) set to the name of the column.</li>
</ul> </ul>
</li> </li>
<li>To open the note, simply click on it.</li> <li data-list-item-id="eb03f96167236a14a55a7538b588bed05">To open the note, simply click on it.</li>
<li>To change the title of the note directly from the board, hover the mouse <li data-list-item-id="e29a6c1186c096f5ec6316edd9d44e626">To change the title of the note directly from the board, hover the mouse
over its card and press the edit button on the right.</li> over its card and press the edit button on the right.</li>
<li>To change the state of a note, simply drag a note from one column to the <li data-list-item-id="e201e4e28bad20f532c5e2c0ada6398f7">To change the state of a note, simply drag a note from one column to the
other to change its state.</li> other to change its state.</li>
<li>The order of the notes in each column corresponds to their position in <li data-list-item-id="e98766e577d03db3dfd8acb850ddf8268">The order of the notes in each column corresponds to their position in
the tree. the tree.
<ul> <ul>
<li>It's possible to reorder notes simply by dragging them to the desired <li data-list-item-id="e905430d6d0a5e51e2596611ccb3a0f2a">It's possible to reorder notes simply by dragging them to the desired
position within the same columns.</li> position within the same columns.</li>
<li>It's also possible to drag notes across columns, at the desired position.</li> <li data-list-item-id="e66108d33aee9387b325a554e12a85a73">It's also possible to drag notes across columns, at the desired position.</li>
</ul> </ul>
</li> </li>
<li>For more options, right click on a note to display a context menu with <li data-list-item-id="ebb5b8df8459f8b32d2e1712d268b63df">For more options, right click on a note to display a context menu with
the following options: the following options:
<ul> <ul>
<li>Open the note in a new tab/split/window or quick edit.</li> <li data-list-item-id="efe7840fa83c41d4a23759927bbe824d2">Open the note in a new tab/split/window or quick edit.</li>
<li>Move the note to any column.</li> <li data-list-item-id="ea44a2cd0895413620eff0720524e9938">Move the note to any column.</li>
<li>Insert a new note above/below the current one.</li> <li data-list-item-id="e505699fc18903f73f96ddfe29a4cc694">Insert a new note above/below the current one.</li>
<li>Archive/unarchive the current note.</li> <li data-list-item-id="e153bf42c4f955bb1421d586f9e7b5498">Archive/unarchive the current note.</li>
<li>Delete the current note.</li> <li data-list-item-id="e3c0a0113e5bb4a69a9dfe90862f5ee1e">Delete the current note.</li>
</ul> </ul>
</li> </li>
<li>If there are many notes within the column, move the mouse over the column <li data-list-item-id="e1d6b1303eb3567b51fec1174993dcb71">If there are many notes within the column, move the mouse over the column
and use the mouse wheel to scroll.</li> and use the mouse wheel to scroll.</li>
</ul> </ul>
<h2>Keyboard interaction</h2> <h3>Working with the note tree</h3>
<p>It's also possible to add items on the board using the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p>
<ol>
<li data-list-item-id="ef31c436ab587f75725f224880891c063">Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li
data-list-item-id="e4e3b01f6a772fe9f5ea2bbb91f2b1f6d">Hold the mouse on the note and drag it to the to the desired column.</li>
</ol>
<p>This works for:</p>
<ul>
<li data-list-item-id="e4b395d82d6e6220afbacdca93b80bea3">Notes that are not children of the board, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
be created.</li>
<li data-list-item-id="ef1eeff2b993c6285ed33440520254f7f">Notes that are children of the board, but not yet assigned on the board.</li>
<li
data-list-item-id="ee4610f6d74645e030570bfa9420dad61">Notes that are children of the board, case in which they will be moved
to the new column.</li>
</ul>
<h3>Keyboard interaction</h3>
<p>The board view has mild support for keyboard-based navigation:</p> <p>The board view has mild support for keyboard-based navigation:</p>
<ul> <ul>
<li>Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between <li data-list-item-id="ef209d621d05adddb8648e11c1aff106a">Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between
column titles, notes and the “New item” button for each of the columns, column titles, notes and the “New item” button for each of the columns,
in sequential order.</li> in sequential order.</li>
<li>To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li> <li data-list-item-id="e48cffbf4ee1a7452c1e01277c8dd2cbf">To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li>
<li>To open a specific note or create a new item, press <kbd>Enter</kbd> while <li
data-list-item-id="e02a6fb1c98d4e4b75e9e4245cf7cf6b1">To open a specific note or create a new item, press <kbd>Enter</kbd> while
it is focused.</li> it is focused.</li>
<li>To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li> <li data-list-item-id="eec6f2285fa4d8e95f6a3d40cf51e3d69">To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li>
</ul> </ul>
<h2>Configuration</h2> <h2>Configuration</h2>
<h3>Grouping by another attribute</h3> <h3>Displaying custom attributes</h3>
<figure class="image image-style-align-center">
<img style="aspect-ratio:531/485;" src="Kanban Board_image.png"
width="531" height="485">
</figure>
<p>Note attributes can be displayed on the board to enhance it with custom
information such as adding a Due date for your tasks.</p>
<p>This feature works exclusively via attribute definitions (<a class="reference-link"
href="#root/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>). The easiest
way to add these is:</p>
<ol>
<li data-list-item-id="eb2220bf769a14b4d3c3763ddb412215a">Go to board note.</li>
<li data-list-item-id="ef2b3775a79f59cc97c77a69ca78a345e">In the ribbon select <em>Owned Attributes</em> → plus button → <em>Add new label/relation definition</em>.</li>
<li
data-list-item-id="e2565a4dfea04fba704b37927e6252ce4">Configure the attribute as desired.</li>
<li data-list-item-id="ee18605ea5b4a07f7b3f5529ba00b2a57">Check <em>Inheritable</em> to make it applicable to child notes automatically.</li>
</ol>
<p>After creating the attribute, click on a note and fill in the promoted
attributes which should then reflect inside the board.</p>
<p>Of note:</p>
<ul>
<li data-list-item-id="e5a19ed95dbafe9a850690bea201deba1">Both promoted and non-promoted attribute definitions are supported. The
only difference is that non-promoted attributes don't have an “Alias” for
assigning a custom name.</li>
<li data-list-item-id="e7ec69af7257cfe86e14bb803910872b4">Both “Single value” and “Multi value” attributes are supported. In case
of multi-value, a badge is displayed for every instance of the attribute.</li>
<li
data-list-item-id="e810a5dbe56db7e59f9091e45c545a611">All label types are supported, including dates, booleans and URLs.</li>
<li
data-list-item-id="e49414fe2d9d206692332cd7d7ff1d4c0">Relation attributes are also supported as well, showing a link with the
target note title and icon.</li>
<li data-list-item-id="e1c3fb07ae71ca498c04613917eca93d4">Currently, it's not possible to adjust which promoted attributes are displayed,
since all promoted attributes will be displayed (except the <code>board:groupBy</code> one).
There are plans to improve upon this being able to hide promoted attributes
individually.</li>
</ul>
<h3>Grouping by another label</h3>
<p>By default, the label used to group the notes is <code>#status</code>. <p>By default, the label used to group the notes is <code>#status</code>.
It is possible to use a different label if needed by defining a label named <code>#board:groupBy</code> with It is possible to use a different label if needed by defining a label named <code>#board:groupBy</code> with
the value being the attribute to use (without <code>#</code> attribute prefix).</p> the value being the attribute to use (with or without <code>#</code> attribute
<aside prefix).</p>
class="admonition note"> <h3>Grouping by relations</h3>
<p>It's currently not possible to set a relation as the grouping criteria. <figure class="image image-style-align-right">
There are plans to add support for it.</p> <img style="aspect-ratio:535/245;" src="1_Kanban Board_image.png"
</aside> width="535" height="245">
<h2>Limitations</h2> </figure>
<ul> <p>A more advanced use-case is grouping by <a href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_Cq5X6iKQop6R">Relations</a>.</p>
<li>It is not possible yet to use group by a relation, only by label.</li> <p>During this mode:</p>
</ul> <ul>
<li data-list-item-id="e597b9ecddfae34bb858559de09ee1f6a">The columns represent the <em>target notes</em> of a relation.</li>
<li data-list-item-id="eb59f890b2223d7f3f43e7ebae747002d">When creating a new column, a note is selected instead of a column name.</li>
<li
data-list-item-id="e566f9ab556f5c47b00ce0854def37bea">The column icon will match the target note.</li>
<li data-list-item-id="e43d3786e7e6590a003f16f3eb437bba5">Moving notes between columns will change its relation.</li>
<li data-list-item-id="e5c2a414d0c80f0d1a67066078c7a4f79">Renaming an existing column will change the target note of all the notes
in that column.</li>
</ul>
<p>Using relations instead of labels has some benefits:</p>
<ul>
<li data-list-item-id="e580344f5638c09e80f566dc789db656a">The status/grouping of the notes is visible outside the Kanban board,
for example on the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_bdUJEHsAPYQR">Note Map</a>.</li>
<li
data-list-item-id="e1d59fe7873950babd8e1f3dbcb913e1a">Columns can have icons.</li>
<li data-list-item-id="e9933195c1f7708326f434321482cd917">Renaming columns is less intensive since it simply involves changing the
note title of the target note instead of having to do a bulk rename.</li>
</ul>
<p>To do so:</p>
<ol>
<li data-list-item-id="e66855292cf2639a13ecd642482681653">First, create a Kanban board from scratch and not a template:</li>
<li
data-list-item-id="eaf16b94767674ca24de65ae102b84fc7">Assign <code>#viewType=board #hidePromotedAttributes</code> to emulate the
default template.</li>
<li data-list-item-id="e861d2859085e0dba83a44946fdc67c32">Set <code>#board:groupBy</code> to the name of a relation to group by, <strong>including the </strong><code><strong>~</strong></code><strong> prefix</strong> (e.g. <code>~status</code>).</li>
<li
data-list-item-id="efd300f3e766d485e28b7c8fd0a73364c">
<p>Optionally, use&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;for
easy status change within the note:</p><pre><code class="language-text-x-trilium-auto">#relation:status(inheritable)="promoted,alias=Status,single"</code></pre>
</li>
</ol>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.99.4", "appVersion": "0.99.5",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,
@ -110,6 +110,13 @@
"type": "text", "type": "text",
"mime": "text/html", "mime": "text/html",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "4nwtTJyjNDKd",
"isInheritable": false,
"position": 10
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
@ -117,13 +124,6 @@
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{
"type": "relation",
"name": "internalLink",
"value": "4nwtTJyjNDKd",
"isInheritable": false,
"position": 30
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -1263,10 +1263,17 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "zdQzavvHDl1k", "value": "ccIoz7nqgDRK",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{
"type": "relation",
"name": "internalLink",
"value": "zdQzavvHDl1k",
"isInheritable": false,
"position": 20
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
@ -1280,13 +1287,6 @@
"value": "releasing", "value": "releasing",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "ccIoz7nqgDRK",
"isInheritable": false,
"position": 50
} }
], ],
"format": "markdown", "format": "markdown",

View File

@ -1,5 +1,5 @@
# Documentation # Documentation
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/E6pFkO6VwPFI/Documentation_image.png" width="205" height="162"> There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/cJTTOrI5C1jn/Documentation_image.png" width="205" height="162">
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>. * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.

View File

@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.99.4", "appVersion": "0.99.5",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,

View File

@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.99.4", "appVersion": "0.99.5",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,
@ -9884,18 +9884,69 @@
"value": "kanban-board", "value": "kanban-board",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "Cq5X6iKQop6R",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "bdUJEHsAPYQR",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "IakOLONlIfGI",
"isInheritable": false,
"position": 70
} }
], ],
"format": "markdown", "format": "markdown",
"dataFileName": "Kanban Board.md", "dataFileName": "Kanban Board.md",
"attachments": [ "attachments": [
{ {
"attachmentId": "usSSa0WI6dDK", "attachmentId": "3ze7RpkjIWdW",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/png", "mime": "image/png",
"position": 10, "position": 10,
"dataFileName": "Kanban Board_image.png" "dataFileName": "Kanban Board_image.png"
},
{
"attachmentId": "IrIeh59VGjHq",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Kanban Board_image.png"
},
{
"attachmentId": "usSSa0WI6dDK",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "2_Kanban Board_image.png"
} }
] ]
}, },
@ -9983,6 +10034,20 @@
"value": "geomap", "value": "geomap",
"isInheritable": false, "isInheritable": false,
"position": 90 "position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 110
} }
], ],
"format": "markdown", "format": "markdown",
@ -11206,6 +11271,27 @@
"value": "bx bx-list-check", "value": "bx bx-list-check",
"isInheritable": false, "isInheritable": false,
"position": 110 "position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 130
},
{
"type": "relation",
"name": "internalLink",
"value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 140
} }
], ],
"format": "markdown", "format": "markdown",
@ -11670,27 +11756,71 @@
"name": "iconClass", "name": "iconClass",
"value": "bx bx-table", "value": "bx bx-table",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "zP3PMqaG71Ct",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "R9pX4DGra2Vt",
"isInheritable": false,
"position": 80
} }
], ],
"format": "markdown", "format": "markdown",
"dataFileName": "Promoted Attributes.md", "dataFileName": "Promoted Attributes.md",
"attachments": [ "attachments": [
{ {
"attachmentId": "4EcBRWF9iCk2", "attachmentId": "8ue55DaAJ82K",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/jpg", "mime": "image/png",
"position": 10, "position": 10,
"dataFileName": "Promoted Attributes_image.png" "dataFileName": "Promoted Attributes_image.png"
}, },
{ {
"attachmentId": "Txf5Jdm2vqt2", "attachmentId": "bLMPNRtMAaKo",
"title": "promoted-attributes.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/png", "mime": "image/png",
"position": 10, "position": 10,
"dataFileName": "Promoted Attributes_promot.png" "dataFileName": "1_Promoted Attributes_image.png"
},
{
"attachmentId": "FbNQB8xcY0Nu",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "2_Promoted Attributes_image.png"
},
{
"attachmentId": "yBIe1DyxuL2e",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "3_Promoted Attributes_image.png"
} }
] ]
} }

View File

@ -12,19 +12,30 @@ In Trilium, attributes are key-value pairs assigned to notes, providing addition
These attributes play a crucial role in organizing, categorizing, and enhancing the functionality of notes. These attributes play a crucial role in organizing, categorizing, and enhancing the functionality of notes.
## Types of attributes
Conceptually there are two types of attributes (applying to both labels and relations):
1. **System attributes**
As the name suggest, these attributes have a special meaning since they are interpreted by Trilium. For example the `color` attribute will change the color of the note as displayed in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> and links, and `iconClass` will change the icon of a note.
2. **User-defined attributes**
These are free-form labels or relations that can be used by the user. They can be used purely for categorization purposes (especially if combined with <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Search.md">Search</a>), or they can be given meaning through the use of <a class="reference-link" href="../Scripting.md">Scripting</a>.
In practice, Trilium makes no direct distinction of whether an attribute is a system one or a user-defined one. A label or relation is considered a system attribute if it matches one of the built-in names (e.g. like the aforementioned `iconClass`). Keep this in mind when creating  <a class="reference-link" href="Attributes/Promoted%20Attributes.md">Promoted Attributes</a> in order not to accidentally alter a system attribute (unless intended).
## Viewing the list of attributes ## Viewing the list of attributes
Both the labels and relations for the current note are displayed in the _Owned Attributes_ section of the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>, where they can be viewed and edited. Inherited attributes are displayed in the _Inherited Attributes_ section of the ribbon, where they can only be viewed. Both the labels and relations for the current note are displayed in the _Owned Attributes_ section of the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>, where they can be viewed and edited. Inherited attributes are displayed in the _Inherited Attributes_ section of the ribbon, where they can only be viewed.
In the list of attributes, labels are prefixed with the `#` character whereas relations are prefixed with the `~` character. In the list of attributes, labels are prefixed with the `#` character whereas relations are prefixed with the `~` character.
## Multiplicity
Attributes in Trilium can be "multi-valued", meaning multiple attributes with the same name can co-exist.
## Attribute Definitions and Promoted Attributes ## Attribute Definitions and Promoted Attributes
Special labels create "label/attribute" definitions, enhancing the organization and management of attributes. For more details, see <a class="reference-link" href="Attributes/Promoted%20Attributes.md">Promoted Attributes</a>. <a class="reference-link" href="Attributes/Promoted%20Attributes.md">Promoted Attributes</a> create a form-like editing experience for attributes, which makes it easy to enhancing the organization and management of attributes
## Multiplicity
Attributes in Trilium can be "multi-valued", meaning multiple attributes with the same name can co-exist. This can be combined with <a class="reference-link" href="Attributes/Promoted%20Attributes.md">Promoted Attributes</a> to easily add them.
## Attribute Inheritance ## Attribute Inheritance

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

View File

@ -1,31 +1,74 @@
# Promoted Attributes # Promoted Attributes
Promoted attributes are [attributes](../Attributes.md) which are considered important and thus are "promoted" onto the main note UI. See example below: <figure class="image image_resized" style="width:61.4%;"><img style="aspect-ratio:938/368;" src="Promoted Attributes_image.png" width="938" height="368"></figure>
![](Promoted%20Attributes_promot.png) Promoted attributes are [attributes](../Attributes.md) which are displayed prominently in the UI which allow them to be easily viewed and edited.
You can see the note having kind of form with several fields. Each of these is just regular attribute, the only difference is that they appear on the note itself. One way of seeing promoted attributes is as a kind of form with several fields. Each field is just regular attribute, the only difference is that they appear on the note itself.
Attributes can be pretty useful since they allow for querying and script automation etc. but they are also inconveniently hidden. This allows you to select few of the important ones and push them to the front of the user. Attributes can be pretty useful since they allow for querying and script automation etc. but they are also inconveniently hidden. This allows you to select few of the important ones and push them to the front of the user.
Now, how do we make attribute to appear on the UI?
## Attribute definition ## Attribute definition
Attribute is always name-value pair where both name and value are strings. In order to have promoted attributes, there needs to be a way to define them.
_Attribute definition_ specifies how should this value be interpreted - is it just string, or is it a date? Should we allow multiple values or note? And importantly, should we _promote_ the attribute or not? <figure class="image image-style-align-right image_resized" style="width:38.82%;"><img style="aspect-ratio:492/346;" src="1_Promoted Attributes_image.png" width="492" height="346"></figure>
![](Promoted%20Attributes_image.png) Technically, attributes are only name-value pairs where both name and value are strings.
You can notice tag attribute definition. These "definition" attributes define how the "value" attributes should behave. The _Attribute definition_ specifies how should this value be interpreted:
So there's one attribute for value and one for definition. But notice how definition attribute is [Inheritable](Attribute%20Inheritance.md), meaning that it's also applied to all descendant note. So in a way, this definition is used for the whole subtree while "value" attributes are applied only for this note. * Is it just string, or is it a date?
* Should we allow multiple values or note?
* Should we _promote_ the attribute or not?
## Creating a new promoted attribute definition
To create a new promoted attribute:
1. Go to a note.
2. Go to _Owned Attributes_ in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.
3. Press the + button.
4. Select either _Add new label definition_ or _Add new relation definition_.
5. Select the name which will be name of the label or relation that will be created when the promoted attribute is edited.
6. Ensure _Promoted_ is checked in order to display it at the top of notes.
7. Optionally, choose an _Alias_ which will be displayed next to the promoted attribute instead of the attribute name. Generally it's best to choose a “user-friendly” name since it can contain spaces and other characters which are not supported as attribute names.
8. Check _Inheritable_ to apply it to this note and all its descendants. To keep it only for the current note, un-check it.
9. Press “Save & Close” to apply the changes.
## How attribute definitions actually work
When a new promoted attribute definition is created, it creates a corresponding label prefixed with either `label` or `relation`, depending on the definition type:
```
#label:myColor(inheritable)="promoted,alias=Color,multi,color"
```
The only purpose of the attribute definition is to set up a template. If the attribute was marked as promoted, then it's also displayed to the user for easy editing.
| | |
| --- | --- |
| <figure class="image"><img style="aspect-ratio:495/157;" src="2_Promoted Attributes_image.png" width="495" height="157"></figure> | Notice how the promoted attribute definition only creates a “Due date” box above the text content. |
| <figure class="image"><img style="aspect-ratio:663/160;" src="3_Promoted Attributes_image.png" width="663" height="160"></figure> | Once a value is set by the user, a new label (or relation, depending on the type) is created. The name of the attribute matches one set when creating the promoted attribute. |
So there's one attribute for value and one for definition. But notice how an definition attribute can be made [Inheritable](Attribute%20Inheritance.md), meaning that it's also applied to all descendant notes. In this case, the definition used for the whole sub-tree while "value" attributes are for each not individually.
## Using system attributes
It's possible to create promoted attributes out of system attributes, to be able to easily alter them.
Here are a few practical examples:
* <a class="reference-link" href="../../Collections.md">Collections</a> already make use of this practice, for example:
* Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as promoted attributes. These map to system attributes such as `startDate` which are then interpreted by the calendar view.
* <a class="reference-link" href="../../Collections/Presentation.md">Presentation</a> adds a “Background” promoted attribute for each of the slide to easily be able to customize.
* The Trilium documentation (which is edited in Trilium) uses a promoted attribute to be able to easily edit the `#shareAlias` (see <a class="reference-link" href="../Sharing.md">Sharing</a>) in order to form clean URLs.
* If you always edit a particular system attribute such as `#color`, simply create a promoted attribute for it to make it easier.
### Inverse relation ### Inverse relation
Some relations always occur in pairs - my favorite example is on the family. If you have a note representing husband and note representing wife, then there might be a relation between those two of `isPartnerOf`. This is bidirectional relationship - meaning that if a relation is pointing from husband to wife then there should be always another relation pointing from wife to husband. Some relations always occur in pairs - my favorite example is on the family. If you have a note representing husband and note representing wife, then there might be a relation between those two of `isPartnerOf`. This is bidirectional relationship - meaning that if a relation is pointing from husband to wife then there should be always another relation pointing from wife to husband.
Another example is with parent - child relationship. Again these always occur in pairs, but in this case it's not exact same relation - the one going from parent to child might be called `isParentOf` and the other one going from child to parent might be called `isChildOf`. Another example is with parent-child relationship. Again these always occur in pairs, but in this case it's not exact same relation - the one going from parent to child might be called `isParentOf` and the other one going from child to parent might be called `isChildOf`.
Relation definition allows you to specify such "inverse relation" - for the relation you just define you specify which is the inverse relation. Note that in the second example we should have two relation definitions - one for `isParentOf` which defines `isChildOf` as inverse relation and then second relation definition for `isChildOf` which defines `isParentOf` as inverse relation. Relation definition allows you to specify such "inverse relation" - for the relation you just define you specify which is the inverse relation. Note that in the second example we should have two relation definitions - one for `isParentOf` which defines `isChildOf` as inverse relation and then second relation definition for `isChildOf` which defines `isParentOf` as inverse relation.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -1,6 +1,6 @@
# Geo Map # Geo Map
> [!IMPORTANT] > [!IMPORTANT]
> Starting with Trilium v0.97.0, the geo map has been converted from a standalone [note type](../Note%20Types.md) to a type of view for the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>.  > <a class="reference-link" href="../Advanced%20Usage/Attributes.md">Attributes</a><a class="reference-link" href="../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a><a class="reference-link" href="../Advanced%20Usage/Attributes.md">Attributes</a>Starting with Trilium v0.97.0, the geo map has been converted from a standalone [note type](../Note%20Types.md) to a type of view for the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>. 
<figure class="image image-style-align-center"><img style="aspect-ratio:892/675;" src="9_Geo Map_image.png" width="892" height="675"></figure> <figure class="image image-style-align-center"><img style="aspect-ratio:892/675;" src="9_Geo Map_image.png" width="892" height="675"></figure>
@ -26,8 +26,8 @@ The position on the map and the zoom are saved inside the map note and restored
| | | | | | | |
| --- | --- | --- | | --- | --- | --- |
| 1 | To create a marker, first navigate to the desired point on the map. Then press the ![](10_Geo%20Map_image.png) button in the [Floating buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.    <br> <br>If the button is not visible, make sure the button section is visible by pressing the chevron button (![](17_Geo%20Map_image.png)) in the top-right of the map. | | | 1 | To create a marker, first navigate to the desired point on the map. Then press the ![](10_Geo%20Map_image.png) button in the [Floating buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.     <br> <br>If the button is not visible, make sure the button section is visible by pressing the chevron button (![](17_Geo%20Map_image.png)) in the top-right of the map. | |
| 2 | <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map_image.png" width="1730" height="416"> | Once pressed, the map will enter in the insert mode, as illustrated by the notification.       <br> <br>Simply click the point on the map where to place the marker, or the Escape key to cancel. | | 2 | <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map_image.png" width="1730" height="416"> | Once pressed, the map will enter in the insert mode, as illustrated by the notification.        <br> <br>Simply click the point on the map where to place the marker, or the Escape key to cancel. |
| 3 | <img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map_image.png" width="1586" height="404"> | Enter the name of the marker/note to be created. | | 3 | <img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map_image.png" width="1586" height="404"> | Enter the name of the marker/note to be created. |
| 4 | <img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map_image.png" width="1696" height="608"> | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. | | 4 | <img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map_image.png" width="1696" height="608"> | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
@ -35,7 +35,7 @@ The position on the map and the zoom are saved inside the map note and restored
1. Right click anywhere on the map, where to place the newly created marker (and corresponding note). 1. Right click anywhere on the map, where to place the newly created marker (and corresponding note).
2. Select _Add a marker at this location_. 2. Select _Add a marker at this location_.
3. Enter the name of the newly created note. 3. Enter the name of the ne<a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>wly created note.
4. The map should be updated with the new marker. 4. The map should be updated with the new marker.
### Adding an existing note on note from the note tree ### Adding an existing note on note from the note tree
@ -109,7 +109,7 @@ The value of the attribute is made up of the latitude and longitude separated by
| | | | | | | |
| --- | --- | --- | | --- | --- | --- |
| 1 | <figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map_image.png" width="732" height="918"></figure> | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.       <br> <br>Simply click on the first item displaying the coordinates and they will be copied to clipboard.       <br> <br>Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). | | 1 | <figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map_image.png" width="732" height="918"></figure> | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.        <br> <br>Simply click on the first item displaying the coordinates and they will be copied to clipboard.        <br> <br>Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). |
| 2 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map_image.png" width="518" height="84"></figure> | In Trilium, create a child note under the map. | | 2 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map_image.png" width="518" height="84"></figure> | In Trilium, create a child note under the map. |
| 3 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:1074/276;" src="11_Geo Map_image.png" width="1074" height="276"></figure> | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. | | 3 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:1074/276;" src="11_Geo Map_image.png" width="1074" height="276"></figure> | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. |
@ -120,7 +120,7 @@ Similarly to the Google Maps approach:
| | | | | | | |
| --- | --- | --- | | --- | --- | --- |
| 1 | <img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map_image.png" width="562" height="454"> | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. | | 1 | <img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map_image.png" width="562" height="454"> | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
| 2 | <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map_image.png" width="696" height="480"> | The address will be visible in the top-left of the screen, in the place of the search bar.       <br> <br>Select the coordinates and copy them into the clipboard. | | 2 | <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map_image.png" width="696" height="480"> | The address will be visible in the top-left of the screen, in the place of the search bar.        <br> <br>Select the coordinates and copy them into the clipboard. |
| 3 | <img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map_image.png" width="640" height="276"> | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. | | 3 | <img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map_image.png" width="640" height="276"> | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. |
## Adding GPS tracks (.gpx) ## Adding GPS tracks (.gpx)
@ -131,7 +131,7 @@ Trilium has basic support for displaying GPS tracks on the geo map.
| --- | --- | --- | | --- | --- | --- |
| 1 | <figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map_image.png" width="226" height="74"></figure> | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. | | 1 | <figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map_image.png" width="226" height="74"></figure> | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
| 2 | <figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="14_Geo Map_image.png" width="322" height="222"></figure> | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. | | 2 | <figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="14_Geo Map_image.png" width="322" height="222"></figure> | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. |
| 3 | <figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map_image.png" width="620" height="530"></figure> | When going back to the map, the track should now be visible.       <br> <br>The start and end points of the track are indicated by the two blue markers. | | 3 | <figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map_image.png" width="620" height="530"></figure> | When going back to the map, the track should now be visible.        <br> <br>The start and end points of the track are indicated by the two blue markers. |
> [!NOTE] > [!NOTE]
> The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon. > The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon.

View File

@ -1,5 +1,5 @@
# Kanban Board # Kanban Board
<figure class="image"><img style="aspect-ratio:918/248;" src="Kanban Board_image.png" width="918" height="248"></figure> <figure class="image"><img style="aspect-ratio:918/248;" src="2_Kanban Board_image.png" width="918" height="248"></figure>
The Board view presents sub-notes in columns for a Kanban-like experience. Each column represents a possible value for a status label, which can be adjusted. The Board view presents sub-notes in columns for a Kanban-like experience. Each column represents a possible value for a status label, which can be adjusted.
@ -41,7 +41,20 @@ Notes are displayed recursively, so even the child notes of the child notes will
* Delete the current note. * Delete the current note.
* If there are many notes within the column, move the mouse over the column and use the mouse wheel to scroll. * If there are many notes within the column, move the mouse over the column and use the mouse wheel to scroll.
## Keyboard interaction ### Working with the note tree
It's also possible to add items on the board using the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>.
1. Select the desired note in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>.
2. Hold the mouse on the note and drag it to the to the desired column.
This works for:
* Notes that are not children of the board, case in which a [clone](../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.md) will be created.
* Notes that are children of the board, but not yet assigned on the board.
* Notes that are children of the board, case in which they will be moved to the new column.
### Keyboard interaction
The board view has mild support for keyboard-based navigation: The board view has mild support for keyboard-based navigation:
@ -52,13 +65,60 @@ The board view has mild support for keyboard-based navigation:
## Configuration ## Configuration
### Grouping by another attribute ### Displaying custom attributes
By default, the label used to group the notes is `#status`. It is possible to use a different label if needed by defining a label named `#board:groupBy` with the value being the attribute to use (without `#` attribute prefix). <figure class="image image-style-align-center"><img style="aspect-ratio:531/485;" src="Kanban Board_image.png" width="531" height="485"></figure>
> [!NOTE] Note attributes can be displayed on the board to enhance it with custom information such as adding a Due date for your tasks.
> It's currently not possible to set a relation as the grouping criteria. There are plans to add support for it.
## Limitations This feature works exclusively via attribute definitions (<a class="reference-link" href="../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a>). The easiest way to add these is:
* It is not possible yet to use group by a relation, only by label. 1. Go to board note.
2. In the ribbon select _Owned Attributes_ → plus button → _Add new label/relation definition_.
3. Configure the attribute as desired.
4. Check _Inheritable_ to make it applicable to child notes automatically.
After creating the attribute, click on a note and fill in the promoted attributes which should then reflect inside the board.
Of note:
* Both promoted and non-promoted attribute definitions are supported. The only difference is that non-promoted attributes don't have an “Alias” for assigning a custom name.
* Both “Single value” and “Multi value” attributes are supported. In case of multi-value, a badge is displayed for every instance of the attribute.
* All label types are supported, including dates, booleans and URLs.
* Relation attributes are also supported as well, showing a link with the target note title and icon.
* Currently, it's not possible to adjust which promoted attributes are displayed, since all promoted attributes will be displayed (except the `board:groupBy` one). There are plans to improve upon this being able to hide promoted attributes individually.
### Grouping by another label
By default, the label used to group the notes is `#status`. It is possible to use a different label if needed by defining a label named `#board:groupBy` with the value being the attribute to use (with or without `#` attribute prefix).
### Grouping by relations
<figure class="image image-style-align-right"><img style="aspect-ratio:535/245;" src="1_Kanban Board_image.png" width="535" height="245"></figure>
A more advanced use-case is grouping by [Relations](../Advanced%20Usage/Attributes/Relations.md).
During this mode:
* The columns represent the _target notes_ of a relation.
* When creating a new column, a note is selected instead of a column name.
* The column icon will match the target note.
* Moving notes between columns will change its relation.
* Renaming an existing column will change the target note of all the notes in that column.
Using relations instead of labels has some benefits:
* The status/grouping of the notes is visible outside the Kanban board, for example on the <a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a>.
* Columns can have icons.
* Renaming columns is less intensive since it simply involves changing the note title of the target note instead of having to do a bulk rename.
To do so:
1. First, create a Kanban board from scratch and not a template:
2. Assign `#viewType=board #hidePromotedAttributes` to emulate the default template.
3. Set `#board:groupBy` to the name of a relation to group by, **including the** `**~**` **prefix** (e.g. `~status`).
4. Optionally, use <a class="reference-link" href="../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> for easy status change within the note:
```
#relation:status(inheritable)="promoted,alias=Status,single"
```

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 47 KiB