docs(specs): remove Emacs references and update links spec with future drop-down search enhancement
This commit is contained in:
parent
fb519760b5
commit
f75a7a0c09
GPG key ID:
43C1470D890F23ED
4 changed files with 119 additions and 23 deletions
21
README.md
21
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# QuickNotes
|
||||
|
||||
QuickNotes is a personal knowledge management application that allows you to create, manage, and interlink your notes, save articles for later reading, subscribe to RSS/Atom feeds, upload and view PDF documents, and perform a unified full-text search across all your content. The application also includes an Emacs mode for seamless integration directly from your editor.
|
||||
QuickNotes is a personal knowledge management application that allows you to create, manage, and interlink your notes, save articles for later reading, subscribe to RSS/Atom feeds, upload and view PDF documents, and perform a unified full-text search across all your content.
|
||||
|
||||
## Features
|
||||
|
||||
|
|
@ -9,7 +9,6 @@ QuickNotes is a personal knowledge management application that allows you to cre
|
|||
- **Feeds**: Subscribe to and manage RSS/Atom feeds, and view feed entries with options to mark them as read or unread.
|
||||
- **Documents**: Upload and view PDF documents directly within the app without needing to download them.
|
||||
- **Omnisearch**: Perform unified full-text searches across notes, feed entries, readlist items, and documents.
|
||||
- **Emacs Integration**: Access QuickNotes features directly from Emacs using a dedicated mode.
|
||||
|
||||
## Technology Stack
|
||||
|
||||
|
|
@ -32,27 +31,11 @@ QuickNotes is a personal knowledge management application that allows you to cre
|
|||
- The SvelteKit frontend is served by the Go backend after being built, or can be run separately for development.
|
||||
- Access the application via your web browser at `http://localhost:3000`.
|
||||
|
||||
3. **Emacs Integration**:
|
||||
- Place `quicknotes.el` in your Emacs load path.
|
||||
- Add `(require 'quicknotes)` to your Emacs configuration.
|
||||
- Start QuickNotes within Emacs using `M-x quicknotes`.
|
||||
|
||||
## Usage
|
||||
|
||||
- Navigate using dedicated pages for Notes, Readlist, Feeds, Documents, and Omnisearch.
|
||||
- Use the Omnisearch page to perform full-text searches across all content domains.
|
||||
|
||||
### Emacs Mode Key Bindings
|
||||
|
||||
- `RET`: Open item
|
||||
- `r`: Mark item as read
|
||||
- `f`: List feeds
|
||||
- `l`: List readlist items
|
||||
- `n`: List notes
|
||||
- `o`: Toggle between HTML and Org mode rendering (using Pandoc)
|
||||
- `g`: Refresh content
|
||||
- `q`: Quit the current buffer
|
||||
|
||||
## Documentation
|
||||
|
||||
For detailed specifications, see:
|
||||
|
|
@ -67,7 +50,7 @@ For detailed specifications, see:
|
|||
- [API](specs/api.md)
|
||||
- [Frontend](specs/frontend.md)
|
||||
- [Authentication](specs/authentication.md)
|
||||
- [Emacs Integration](specs/emacs_integration.md)
|
||||
- [Links](specs/links.md)
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
1
SPECS.md
1
SPECS.md
|
|
@ -22,7 +22,6 @@ The following table lists all the specification documents for the QuickNotes app
|
|||
| API | API endpoints and communication | [API](specs/api.md) |
|
||||
| Frontend | User interface and client-side features | [Frontend](specs/frontend.md) |
|
||||
| Authentication | Local-only authentication and potential future enhancements | [Authentication](specs/authentication.md) |
|
||||
| Emacs Integration| Emacs mode for accessing QuickNotes features | [Emacs Integration](specs/emacs_integration.md) |
|
||||
|
||||
## Key Features
|
||||
|
||||
|
|
|
|||
70
specs/links.md
Normal file
70
specs/links.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# Links Specification
|
||||
|
||||
## Overview
|
||||
|
||||
This document describes the enhanced linking functionality introduced in QuickNotes. Users can create links to items in various domains using a unified syntax. These links are processed by both the backend and the frontend to generate clickable hyperlinks that navigate to the appropriate detail pages.
|
||||
|
||||
## Link Syntax
|
||||
|
||||
Users should create links using the following syntax:
|
||||
|
||||
```
|
||||
[[<domain>:::<uuid>]]
|
||||
```
|
||||
|
||||
- `<domain>` specifies the type of the referenced item. Allowed values are:
|
||||
- `note` – for notes
|
||||
- `feed` – for feed subscriptions
|
||||
- `entry` – for individual feed entries
|
||||
- `doc` – for uploaded documents
|
||||
- `post` – for posts (if implemented in the future)
|
||||
|
||||
- `<uuid>` is the unique identifier of the target item.
|
||||
|
||||
### Example
|
||||
|
||||
For example, to link to a note:
|
||||
|
||||
```
|
||||
[[note:::123e4567-e89b-12d3-a456-426614174000]]
|
||||
```
|
||||
|
||||
## Backend Implementation Changes
|
||||
|
||||
1. **Link Extraction**: Update the link extraction function (e.g., `ExtractLinks`) to recognize the new pattern. A suggested regular expression is:
|
||||
|
||||
```go
|
||||
re := regexp.MustCompile(`\[\[([a-z]+):::(.+?)\]\]`)
|
||||
```
|
||||
|
||||
This regex captures two groups: the domain (`[a-z]+`) and the UUID (`.+?`).
|
||||
|
||||
2. **Validation and URL Generation**:
|
||||
- Validate that the extracted domain is one of the allowed values: `note`, `feed`, `entry`, `doc`, or `post`.
|
||||
- Generate the appropriate URL based on the domain:
|
||||
- For `note`: `/notes/<uuid>`
|
||||
- For `feed`: `/feeds/<uuid>`
|
||||
- For `entry`: `/feeds/entries/<uuid>`
|
||||
- For `doc`: `/documents/<uuid>`
|
||||
- For `post`: `/posts/<uuid>` (if posts are later implemented)
|
||||
|
||||
3. **Link Storage and Updates**: When a note is created or updated, the link management routines should:
|
||||
- Extract all links using the new regex.
|
||||
- Validate and resolve these links by verifying the existence of the target items.
|
||||
- Store the relationships if needed, so that bidirectional navigation or graph visualization can be supported.
|
||||
|
||||
## Frontend Implementation Changes
|
||||
|
||||
1. **Rendering**: Modify the markdown or HTML rendering components so that when the new link syntax is encountered, it is transformed into an HTML `<a>` tag whose `href` attribute is the generated URL.
|
||||
|
||||
2. **Routing**: Ensure that client-side routing is properly set up so that clicking the link navigates to the corresponding detail page (e.g., a note detail view, feed entry view, or document viewer).
|
||||
|
||||
3. **Styling**: Apply CSS rules to these links to visually indicate their interactive nature.
|
||||
|
||||
## Summary
|
||||
|
||||
The enhanced linking functionality unifies the way references to various content types are created and handled within QuickNotes. By adopting the `[[<domain>:::<uuid>]]` syntax, the system improves consistency and makes it easier to navigate across different domains.
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
A potential future improvement is to implement a search drop-down feature in the editor. When a user types "[[<domain>:::" (for example, "[[note:::"), the editor could display a drop-down list of items from the selected domain, searchable by title. Upon selection, the link would be automatically completed with the corresponding item's UUID. This enhancement would improve usability by making it easier to find and link to existing items.
|
||||
|
|
@ -42,9 +42,53 @@ The `NoteLink` entity represents a connection between two notes:
|
|||
|
||||
### Note Linking
|
||||
|
||||
1. **Wiki-style Links**: Users can create links between notes using the `[[note-title]]` syntax
|
||||
2. **Automatic Link Management**: Links are automatically created, updated, or removed when notes are saved
|
||||
3. **Bidirectional Links**: Links are bidirectional, allowing navigation in both directions
|
||||
The application now supports an enhanced linking syntax that allows users to reference items from various domains using the following format:
|
||||
|
||||
```
|
||||
[[<domain>:::<uuid>]]
|
||||
```
|
||||
|
||||
Where:
|
||||
|
||||
- `<domain>` is one of the following keywords: `note`, `feed`, `entry`, `doc`, or `post`.
|
||||
- `<uuid>` is the unique identifier of the target item.
|
||||
|
||||
For example, to link to a note, a user might write:
|
||||
|
||||
```
|
||||
[[note:::123e4567-e89b-12d3-a456-426614174000]]
|
||||
```
|
||||
|
||||
This link will be processed and rendered as a clickable hyperlink that navigates to the corresponding detail page.
|
||||
|
||||
#### Backend Implementation Changes
|
||||
|
||||
1. **Link Extraction:** Update the link extraction function (e.g., `ExtractLinks`) to recognize the new pattern. A suggested regular expression is:
|
||||
|
||||
```go
|
||||
re := regexp.MustCompile(`\[\[([a-z]+):::(.+?)\]\]`)
|
||||
```
|
||||
|
||||
This regex captures the domain and UUID portions.
|
||||
|
||||
2. **Validation and URL Generation:** After extraction, validate that the domain is one of the allowed values. Then, generate the appropriate URL for the link:
|
||||
- For `note`: `/notes/<uuid>`
|
||||
- For `feed`: `/feeds/<uuid>`
|
||||
- For `entry`: `/feeds/entries/<uuid>`
|
||||
- For `doc`: `/documents/<uuid>`
|
||||
- For `post`: `/posts/<uuid>` (if posts are implemented in the future)
|
||||
|
||||
3. **Link Storage and Updates:** Ensure that link creation, updates, and deletions in the note service properly handle the new syntax.
|
||||
|
||||
#### Frontend Implementation Changes
|
||||
|
||||
1. **Rendering:** Modify the markdown or HTML rendering component to detect the new link format and replace it with an HTML `<a>` tag with the generated URL.
|
||||
|
||||
2. **Routing:** Use client-side routing to navigate to the appropriate detail view when the link is clicked.
|
||||
|
||||
3. **Styling:** Apply specific styling to these links to indicate they are interactive.
|
||||
|
||||
For a complete description of the enhanced linking functionality, please refer to the standalone [Links Specification](../specs/links.md).
|
||||
|
||||
### Note Graph
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue