Rules & Guide
Rules and User Guide
1. Scope
Readori supports a community-compatible rule format for web source parsing and RSS feed reading. This guide describes Readori behavior, not third-party project documentation.
2. Source Rule Model
- Basic fields: source URL, source name, enabled status.
- Search rules: list, title, author, detail URL, cover, intro.
- Detail rules: metadata extraction and table-of-contents URL.
- TOC rules: chapter list, chapter title, chapter URL, optional next-page.
- Content rules: chapter content extraction, optional content next-page.
3. Supported Expression Types
- CSS-like selectors for HTML extraction.
- XPath for structured DOM querying.
- JSONPath for JSON API responses.
- Regex replacement for cleanup after extraction.
- JavaScript post-processing in constrained contexts.
4. URL & Request Options
Rules can include request options such as method, headers, charset, and optional web rendering behavior. Use only when required by the target site.
5. RSS Rules
- Feed URL: required; must return valid RSS/Atom XML.
- List mapping: item title, link, publication date, summary.
- Detail mapping (optional): full content extraction from entry link.
- Refresh strategy: page index or timestamp based on source behavior.
6. Compliance Notes
- Only configure sources you are legally allowed to access.
- Respect target site terms, robots policy, and copyright rules.
- Avoid credential abuse, automated bypass, or prohibited scraping.
7. Troubleshooting
- If list parsing fails, validate selector scope on source HTML/JSON.
- If chapter content is empty, verify detail URL and content rule order.
- If encoding appears broken, set charset explicitly in request options.
8. User Guide
This section covers how to get started with Readori, manage sources, sync across devices, and use reading features.
Quick Start
- Install Readori from the App Store.
- Open the app and follow the welcome flow.
- Add your first book using the plus button on the bookshelf.
Source Management
Sources define where Readori fetches book content. You can use built-in sources or add your own custom source.
- Open Settings > Source Management.
- Tap the plus button to add a new source.
- Choose a method: URL import, JSON paste, QR scan, or local file.
Source Validation
After adding a source, validate it to confirm it works correctly.
- Select the source from the source list.
- Tap the validate button.
- Review the validation results.
Reading Experience
Readori supports custom themes and reading modes to optimize long sessions.
- Open the reader and tap the center of the screen.
- Select Theme Settings to adjust font, color, and spacing.
- Swipe page turn: left/right swipe for a book-like feel.
- Scroll page turn: vertical scrolling for continuous reading.
iCloud Sync
Use iCloud sync to keep your bookshelf, progress, and sources synced on multiple devices.
- Open Settings > iCloud Sync.
- Turn on Enable Sync.
- Choose what to sync: bookshelf, progress, sources, etc.
Sync Conflicts
When data conflicts occur across devices, choose the version to keep or merge changes.
- Review the conflict prompt.
- Choose Local, Cloud, or Merge.
Text-to-Speech
Readori supports system TTS and custom HTTP TTS engines.
- Tap the read-aloud button in the reader toolbar.
- Select voice and speed.
- Start narration.
To use a custom TTS engine, open Settings > TTS Settings, choose Custom Engine, and enter the service URL and parameters.
RSS Subscriptions
Readori can also subscribe to RSS feeds for news and other updates.
- Open Settings > RSS Management.
- Tap plus to add a feed URL.
- Set the update frequency.
9. Advanced Features
Bookmark Management
Add bookmarks to important passages.
- Long press text in the reader.
- Select Add Bookmark.
- Give the bookmark a name.
Content Cleanup Rules
Define cleanup rules to remove ads, watermarks, or unwanted text.
- Open Settings > Content Cleanup.
- Add a new rule.
- Set matching patterns and replacement values.
Data Backup
Back up your data regularly to prevent loss.
- WebDAV Backup: configure a remote server for automatic backups.
- Local Backup: export backup files to your device.
- iCloud Backup: keep data synced to iCloud.
10. Security & Privacy
Readori is designed with privacy in mind.
- All data is stored locally by default.
- iCloud sync is optional.
- We do not collect or upload personal sensitive information.
- You can export or fully clear your data at any time.
11. Contact
For format compatibility or product support, contact support@readori.com.