docs: update

This commit is contained in:
wfx 2026-01-18 20:42:46 +01:00
parent 1182b7b55d
commit 0e31b146a3
2 changed files with 30 additions and 35 deletions

View file

@ -14,22 +14,19 @@ This document describes the implemented and planned features of Noctua, a modern
- Real-time transformation preview
- EXIF metadata extraction
#### Vector Graphics (Planned)
#### Vector Graphics (Implemented)
- **Formats**: SVG
- **Status**: Code structure prepared, but rendering not yet implemented
- **Planned capabilities**:
- High-quality rendering via `resvg`
- Scalable display without quality loss
- Metadata extraction
- **Rendering**: High-quality rendering via `resvg` library
- **Capabilities**:
- Scalable display at any zoom level without quality loss
- Transformations (rotate, flip)
#### Portable Documents (Planned)
#### Portable Documents (Implemented)
- **Formats**: PDF
- **Status**: Code structure prepared, but rendering not yet implemented
- **Planned capabilities**:
- First page rendering
- Multi-page navigation
- Basic transformations on rendered pages
- **Rendering**: Full PDF rendering via poppler library
- **Multi-page navigation**: Browse through all pages of a document
- **Page thumbnails**: Left sidebar shows page previews (generated on demand)
- **Transformations**: Rotate and flip on rendered pages
### Navigation
@ -91,9 +88,9 @@ This document describes the implemented and planned features of Noctua, a modern
- **Native COSMIC design**: Follows COSMIC desktop design language
- **Theme support**: Automatically adapts to system light/dark theme
- **Header toolbar**:
- Navigation controls (Previous/Next)
- Transformation buttons (Rotate, Flip)
- Information panel toggle
- Left: Navigation controls (Previous/Next) and panel toggle
- Center: Transformation buttons (Rotate, Flip) - horizontally centered
- Right: Information panel toggle
- **Footer bar**:
- Zoom controls with buttons
- Current zoom level display
@ -111,7 +108,8 @@ This document describes the implemented and planned features of Noctua, a modern
- Toggle with `i` key or toolbar button
- **Navigation panel** (Left sidebar):
- Toggle with `n` key or toolbar button
- Content not yet implemented
- For multi-page documents (PDF): Shows page thumbnails
- Click to navigate to specific page
#### Keyboard Shortcuts (Implemented)
Full keyboard-driven workflow:
@ -163,18 +161,6 @@ Full keyboard-driven workflow:
### High Priority
#### SVG Support
- Implement proper SVG parsing and rendering
- Integration with `resvg` library
- Scalable vector display
- Transformation support
#### PDF Support
- Implement PDF rendering backend
- First page display
- Multi-page navigation
- Page thumbnails
#### File Operations
- File dialog integration (OpenPath message prepared)
- Save transformed images
@ -184,8 +170,8 @@ Full keyboard-driven workflow:
### Medium Priority
#### Multi-format TIFF Support
- Multi-page TIFF navigation
- Page thumbnails
- Multi-page TIFF navigation (infrastructure ready)
- Page thumbnails for TIFF (same as PDF)
#### Metadata Editing
- EXIF data modification
@ -200,7 +186,6 @@ Full keyboard-driven workflow:
- Basic color adjustments (brightness, contrast)
#### Enhanced Navigation
- Thumbnail strip
- Grid view for folder contents
- Quick jump to file

View file

@ -14,8 +14,8 @@ When you open an image, Noctua automatically scans the folder and indexes all su
### Supported Formats
- **Raster Images**: PNG, JPEG, GIF, BMP, TIFF, WebP, and all formats supported by `image-rs`
- **Vector Graphics**: SVG (planned, not yet implemented)
- **Portable Documents**: PDF (planned, not yet implemented)
- **Vector Graphics**: SVG (with scalable rendering)
- **Portable Documents**: PDF (with multi-page navigation and thumbnails)
## Keyboard Shortcuts
@ -30,6 +30,10 @@ All keyboard shortcuts are case-insensitive unless otherwise noted.
The footer shows your current position (e.g., "3 / 42").
For multi-page documents (PDF):
- Click thumbnails in the left sidebar to jump to a specific page
- Use `←` `→` to navigate between pages
### Zoom and View
| Key | Action | Description |
@ -75,6 +79,9 @@ All transformations are lossless and show in real-time.
| `i` | Toggle properties | Show/hide the properties panel (metadata)|
| `n` | Toggle navigation | Show/hide the navigation sidebar |
For multi-page documents (PDF), the navigation sidebar displays page thumbnails.
Click on a thumbnail to jump to that page.
### Actions
| Key | Action | Description |
@ -101,6 +108,8 @@ The header toolbar provides quick access to common operations:
### Left Side
- **Navigation toggle**: Show/hide the sidebar
- **Previous/Next buttons**: Navigate between images in the folder
### Center (Horizontally Centered)
- **Rotate buttons**: Rotate clockwise or counter-clockwise
- **Flip buttons**: Flip horizontally or vertically
@ -134,6 +143,8 @@ The footer displays useful information:
- **Image dimensions**: Width × Height in pixels
- **Navigation position**: Current image / Total images in folder
For PDFs, it also shows the current page number.
## Tips and Tricks
### Keyboard-Driven Workflow
@ -173,8 +184,7 @@ The following features are prepared in code but not yet implemented:
- (Copy/Move/)Delete operations
### Document Support
- SVG rendering with `resvg`
- PDF rendering with multi-page support
- SVG rendering (implemented)
### Advanced Editing
- Crop mode (`c` key prepared)