Files
pages/docs/design/organizer-and-editing-ideas.md
T
Anya Tokugawa c1175d389f Implement Knowledge City platform, organizer and DAV integration
Capture accumulated application, UI, CLI, regression tests and design documentation changes, including task project mapping and default CalDAV list naming.

Keep deployment data, backups, local credentials and build artifacts out of Git. Move the Compose enrollment token to an ignored local environment file.
2026-09-27 14:44:43 +09:00

5.9 KiB
Raw Blame History

Organizer, task/ticket and HTML editing ideas

User notes recorded 2026-09-19. Design backlog; product implementation remains separate. The user subsequently requested detailed design and Japanese Wiki publication. The expanded proposals now live in the Japanese handbook, chapters 12–17, with decisions and open questions. Original English notes remain below as source material for later aligned translations. Primary protocol and FreshRSS/newsboat documentation has been reviewed; exact client/version interoperability still requires fixtures before implementation.

Tasks and tickets

  • Define lightweight task management: status, assignee, due date, priority, checklist, dependencies, recurring tasks and links to existing Wiki Pages.
  • Compare task metadata on ordinary Pages with a dedicated extension entity referencing a Page. Do not make mutable titles or URL Paths durable identity.
  • Evaluate CalDAV task interoperability and client support; decide how tasks differ from calendar events and how completion/recurrence map to clients.
  • Decide whether ticket management is a task view or a separate extension: ticket numbers, workflow transitions, queues, labels, discussion, attachments, assignments, watchers and notification Inbox integration.
  • Keep ACLs, history, audit, search and Domain isolation shared with core facilities rather than introducing an independent permission system.

Organizer: URLs, iCalendar, CalDAV and CardDAV

  • Separate the browser-facing Wiki URL, stable object identity, calendar item UID, export URL and DAV resource URL. Renaming a Wiki Path must not silently duplicate externally synchronized items.
  • Start with calendar/list/agenda views and explicit import/export; evaluate read-only subscription feeds before bidirectional synchronization.
  • Design timezone/all-day/recurrence/exception handling, conflict resolution, deletions, revisions, sync cursors, conditional writes and bounded pagination.
  • Evaluate an external calendar connector versus serving a local CalDAV endpoint; document ownership of canonical data and failure/retry behavior.
  • CardDAV contacts: address books, contact identity, duplicates/merge, personal/shared access, import/export and links from contacts to Wiki content.
  • Contacts and schedules stay private by default. Scope-specific app tokens, revocation and audit are prerequisites for external client access.

RSS viewer and reader integrations

  • Evaluate an Organizer RSS/Atom reader: subscriptions/folders, unread/recent views, search, bookmarks and explicit article-to-Wiki capture with provenance.
  • Compare a built-in reader, integration with FreshRSS, and integration with newsboat. Review their supported interfaces and deployment requirements before choosing an API or promising bidirectional interoperability.
  • Decide ownership of subscriptions and read/starred state; define import/ export (including OPML), synchronization direction, deduplication, conflicts, offline use, token scope and revocation. Do not assume reader states are portable.
  • Reuse background scheduling, bounded fetch/cache and notification facilities; define polling budgets, retention, failure backoff and private subscription ACLs.
  • Sanitize feed HTML, block unsafe outbound fetching/SSRF, control remote media, and require an explicit destination/publication warning when saving into Wiki. Distinguish incoming feed reading from the existing outgoing blog RSS feed.

IMAP ingestion and mail-to-Wiki

  • Design read-only IMAP ingestion first: account/folder scope, incremental checkpoints, message deduplication, retry limits and background event scheduling.
  • Preserve original MIME/EML provenance and reuse the existing EML viewer for safe HTML/text and attachment handling. Never execute active email content.
  • Offer an explicit “Copy to Wiki” operation selecting destination Path and title, with an optional source-message backlink and attachment copy policy.
  • Importing a message must not delete/move/mark it read remotely by default. External mutations need separate, explicit configuration and audit.
  • Resolve the confidentiality boundary when copying private mail into an automatically public Street/Spot: show a disclosure warning, source/attachment scope and explicit confirmation; no automatic public destination default.
  • Plan credential storage, OAuth/app-password handling, message size quotas, attachment scanning, quarantine, deduplication and storage retention.

HTML editing: do we actually need full WYSIWYG?

  • Record real editing pain points before choosing an editor engine. Full WYSIWYG is an open decision, not a committed implementation.
  • First evaluate small improvements: reusable HTML-part insertion, tables, images/captions, callouts, links, code blocks and keyboard-friendly commands.
  • Compare source+preview, selection-based formatting, constrained block editing and full rich-text editing for fidelity, accessibility, performance and maintenance.
  • Define immutable round-trip fixtures for macros, assets, embedded adapters, code blocks and arbitrary existing HTML. Editing must not persist expanded macro projections or destructively rewrite unsupported markup.
  • Keep canonical HTML, editable representation and safe public rendering distinct. Consider undo/redo, dirty-state warnings, revision conflicts and paste sanitization before collaboration or full rich-text editing.
  • Prototype behind an explicit opt-in and decide go/no-go from lossless editing and user value, rather than committing to full WYSIWYG as a prerequisite.

Prerequisite order

Scope/identity/ACL design → extension contracts → small read-only prototypes → write/conflict handling → external synchronization. Prefer reusable notification, scheduler, import journal and storage facilities already on the roadmap.