-
Notifications
You must be signed in to change notification settings - Fork 11
Priority Review Document
The Priority Review Document is a powerful feature designed to solve the "information overflow" problem inherent to Incremental Reading. It allows you to generate a custom, disposable review queue containing your highest-priority material — both Flashcards and Incremental Rems — sorted exactly how you want them.
- The Problem: Why do I need this?
- The Solution
- How to Create a Priority Review Document
- How Items Are Selected
- Card Cluster Support
- Smart Scope & Priority Shield Integration
- Best Practices
In the standard RemNote queue, plugins like Incremental Everything can control when Incremental Rems (articles, videos, notes) appear. However, plugins cannot control the order of standard Flashcards. RemNote's native scheduler decides which flashcard comes next, regardless of the priority you set in this plugin.
This creates a problem when you are overwhelmed. If you have 1000 due flashcards, but only time to review 50, you want to ensure those 50 are your most important ones. In the standard queue, you might spend your time reviewing low-priority trivia while critical exams or project knowledge remains unseen.
The Priority Review Document bypasses this limitation by creating a temporary document filled with Rem References (Portals) to your most important due items.
When you practice this specific document, you are guaranteed to see:
- High-Priority Flashcards first.
- High-Priority Incremental Rems interleaved according to your ratio settings.
- A manageable workload (e.g., exactly 50 items) instead of an endless queue.
You can create a review document from anywhere in RemNote:
-
Command Palette: Type
/Create Priority Review Documentand press Enter.
-
Document Menu: Click the 3-dots menu (
...) at the top right of any document → "Create Priority Review Document".
- Queue Menu: Inside the queue, click the plugin menu icon (puzzle piece or 3-dots) → "Create Priority Review Document".
-
Keyboard Shortcut: Press
Opt+Shift+R(Mac) orAlt+Shift+R(Windows).
A popup will appear allowing you to tailor the session:
-
(1) Scope:
- Current Document: Selects high-priority items only from the document you were just viewing (and its descendants/references).
- Full Knowledge Base: Scans your entire database to find the absolute highest priority items due today.
-
(2) Number of Items: Set a hard limit (e.g., 50, 100, or 200). This helps prevent burnout by giving you a finish line.
- Note: Due to RemNote queue gathering rules and its recursive nature, the size of the queue when you click "Practice" and enter the queue will probably be larger, as RemNote will gather e.g. rems that are referenced within the selected items.
-
(3) Content Mix: Displays the current ratio of Flashcards to Incremental Rems (e.g., "6 flashcards for every incremental rem").
- Note: This ratio is pulled from your "Sorting Criteria" settings. If the ratio is not the desired or if you can check the randomness, press the button (4) Change Sorting Criteria Settings.
Click (5) "Create Review Document".
The plugin will generate a new document tagged #Priority Review Queue and automatically open it.
- Click the Practice button (Flashcards) on this new document.
- Review your items as normal.
- When finished, you can safely delete the Priority Review Document. The actual items (your cards and notes) are just references; deleting the review document does not delete your actual data.
The plugin uses a sophisticated selection process to ensure you see the right material:
- Filtering: It gathers all items (Flashcards and Incremental Rems) that are Due (scheduled for today or in the past).
- Scoping: It filters these items based on your selected scope (Specific Document or Full KB).
- Sorting: It ranks them by Priority (0 is highest, 100 is lowest).
-
Randomness: It applies your Sorting Criteria randomness settings.
- Low randomness = Strict adherence to priority (0, 1, 2...).
- High randomness = Introduces serendipity, allowing lower priority items to surface occasionally.
-
Mixing: It interleaves the lists based on your Flashcard Ratio.
- Example: If your ratio is "6 cards per rem", the document will contain roughly 6 flashcard references followed by 1 incremental rem reference, repeating until the item limit is reached.
To help users visualize how the items are selected, a Priority Distribution Graph is automatically generated at the top of the Priority Review Document (in a rem with the Priority Review Graph powerup).
This visualization helps you verify:
- The effect of Randomness: See how "shuffled" your review session is compared to a strict priority order.
- Priority Shield Logic: Confirm that the system is correctly prioritizing your high-value items as expected.
- Scope Distribution: Visualize the balance of absolute priorities and relative percentiles within your included Incremental Rems and Flashcards.
RemNote's Card Cluster powerup (activated via /cluster) lets you group closely related flashcards under a shared parent so they are always reviewed together in the queue. When you practice a cluster, RemNote shows the sibling cards in order — the ones before the active card in grey for context, and the remaining ones as empty boxes.
Without any special handling, the Priority Review Document generator would select individual flashcard rems based solely on priority. If a clustered parent had three children — all with due cards — but only one ranked among the top-N by priority, the other two siblings would be absent from the document. When RemNote encountered that isolated rem during the review queue, it would have no cluster siblings to display, silently breaking the cluster experience.
Starting from v0.2.178, every time a flashcard rem is selected for inclusion in the document, the plugin:
- Looks up the rem's direct parent.
- Checks whether the parent carries the Card Cluster powerup (using multiple code variants and a tag-name fallback, since RemNote does not yet expose the cluster powerup code in its public Plugin SDK).
- If a cluster is detected, all sibling rems (other direct children of that parent) that currently have due cards are automatically added to the document alongside the triggering rem.
| Scenario | Behaviour |
|---|---|
| Only one cluster member meets the priority threshold | All due siblings are pulled in automatically |
| Multiple cluster members independently meet the threshold | Each one triggers the cluster check; the deduplication set ensures no rem is added twice |
| No cluster members are due | Nothing extra is added (the normal selection path applies) |
| Cluster siblings push the total above the configured item limit | Siblings are still included — a partial cluster would break the queue experience |
Note
The item count shown in the document metadata reflects the actual number of portals created, which may exceed your requested limit when cluster siblings are added. This is intentional and expected.
The cluster expansion is fully automatic. As long as your flashcard rems have been grouped under a parent tagged with /cluster, the plugin detects and respects the cluster. No extra configuration is required.
Even though you are reviewing a generated list, the plugin is smart enough to know where the items came from.
- Original Scope Awareness: While reviewing a Priority Review Document, the plugin "pretends" you are reviewing the original source.
-
Priority Shield: The Priority Shield (the stats below the answer buttons) will calculate your protection based on the Original Scope.
- Example: If you generate a review doc for "Biology 101", the shield will show you how well you are protecting priorities within the "Biology 101" folder, not just the temporary review document.
- Stats Tracking: The history graph will record your progress against the original document or Full KB, keeping your long-term stats accurate.
- The "Overwhelmed" Workflow: If you wake up to 1000+ due cards, don't panic. Create a Priority Review Document for 100 items (Full KB). Review them. If you have energy left, create another. If not, you can stop knowing you tackled the most important 100 items.
- The "Deep Dive" Workflow: If you want to focus specifically on one project, navigate to that folder, create a Priority Review Document (Current Document scope), and finish that queue completely before moving on.
- Maintain Priority Hygiene: To ensure your Priority Review Documents accurately catch your most critical content, regularly set priorities on your key documents and flashcards. Crucially, run the "Update all inherited Card Priorities" command periodically (e.g., weekly). This updates the priority inheritance across your entire knowledge base, ensuring that every single flashcard — even those you haven't manually touched — inherits the correct priority from its parent document.
- Cleanup: Get in the habit of deleting these documents after you finish the queue. They are meant to be temporary snapshots of your priorities at that specific moment. Leaving them in your collection will create unnecessary rem references to your items, cluttering the UI and making your KB heavier and slower.
- 1. Getting Started
- 2. The Philosophy: What is Incrementalism?
- 3. The Core Loop
- 4. Mastering the Queue: Prioritization & Sorting
- 5. Advanced Workflows & Use Cases
- 6. Essential References
- 7. FAQ & Troubleshooting
- 8. Changelog
- 9. Contributing to the Wiki