QiMeta Documentation
A complete guide to preparing documents with QiMeta's Highlighting engine, reviewing reader analytics, and refining learning materials.
Need Help?
Have questions or need support? Contact our team — we're here to help.
Who This Guide Is For
- Teachers & course designers who want to prepare readings with highlights, definitions, and optional assessments.
- Program coordinators & admins who monitor engagement and outcomes via dashboards.
Prerequisites
- A QiMeta account with access to the Highlight feature.
- Your document (PDF, PPTX, DOCX, EPUB/e-book, and more) or a public URL to the content.
- (Optional) Reader level (e.g., 9th grade) and any classroom context you want QiMeta to consider.
Part 1 – Highlighting
Transform any document into an interactive, AI-enhanced reading experience with definitions, highlights, and optional assessments.
Quick Start
1. Upload a file or paste a link
- Drag & drop a file or select from your device. Supported formats: PDF, PPTX, DOCX, EPUB, and others.
- Or paste a public URL to web content.
2. Review the content (if using a link)
- Click Review to confirm the fetched content looks right before processing.
3. Click Highlight
- Submit the document to QiMeta's highlighting engine.
- You'll be redirected to My Documents where the item shows status Pending while processing.
4. Open when ready
- When status changes to COMPLETED, click the article to begin reading.
- Tip: Click any highlighted term to view a concise definition. Select Ask QiMeta in the pop-up to ask questions or request explanations.
Share with Learners
- Copy and paste the reading link directly to students.
- Paste into Google Classroom or any LMS (Learning Management System).
Advanced Highlighting Controls
Customize how QiMeta annotates your document. Use these options after uploading and before clicking Highlight.
Reader Level & Context
Set the reading level (default: 9th grade) and add any context about your learners, such as course topic, prior knowledge, or learning goals.
What to Highlight
- Difficult words – Vocabulary and terms likely to be challenging for the specified reader level.
- Names & places – Proper nouns such as people, organizations, and locations.
- Key facts & concepts – Central ideas and takeaways, prioritized from the reader's perspective.
Assessment Tests (Optional)
Create Pre-Assessment and/or Post-Assessment tests. Choose:
- Number of questions for each assessment.
- Whether learners see immediate correctness feedback or if results are hidden.
All results are stored and visible in the Teacher Dashboard for analysis.
Best practice: For dense readings, start with Difficult words and Key facts only. Add Names & places in subsequent iterations if learners need additional scaffolding.
Part 2 – Teacher Dashboard (Reading Analysis)
Monitor student engagement and comprehension with detailed analytics. From the left main menu, open Reading Analysis and select a reader + article. Interactions are grouped into sessions.
Understanding Sessions
- Definition: A session is a contiguous period of reading engagement on the article.
- New sessions: Inactivity over 5 minutes automatically starts a new session.
- Navigation: Use the session drop-down to switch views. By default, the longest session is shown first.
Dashboard Reports
- Focus – Indicates how intently the reader stayed on task while reading the document.
- Curiosity – Reflects the reader's exploratory behavior (e.g., opening definitions, asking questions) to deepen understanding.
- Effort – Captures the amount of work the reader invested (time on task, navigation, interactions).
- Raw Navigation Report – A factual log of clicks, scrolls, terms opened, and related events.
Pro tip: Pair Focus with Effort to spot students who are trying hard but may be losing concentration—ideal candidates for targeted support or alternative scaffolds.
Part 3 – Editing a Highlighted Article (QiMeta Canvas)
After a document is processed, you can refine and customize the reading experience. In My Articles, click Edit on any processed article to open the QiMeta Canvas.
What You Can Edit
- Definitions – Keep the AI-generated definitions or tailor them to match your classroom language and learning objectives.
- Diagrams & images – Replace, add, or supplement definitions with visual aids.
Reader Experience
When a learner clicks a highlighted term during reading, they see the definition. If you've added a diagram or image, it displays beneath the definition, helping anchor abstract concepts and accelerate comprehension.
When to use visuals: Add a diagram when structure matters (e.g., cycles, hierarchies, processes) or when an image can anchor abstract terms. A well-placed visual can dramatically improve learning outcomes.
Update After Publishing
Yes! You can edit definitions and visuals anytime after publishing. Learners will see the latest version when they reload the article.
Best Practices & Tips
- Start simple: Use defaults (9th-grade level, Difficult words + Key facts) for your first pass, then refine based on learner feedback.
- Align highlights to objectives: If a quiz emphasizes mechanisms, bias highlights toward Key concepts rather than proper nouns.
- Mind cognitive load: Too many highlights can distract. Focus on must-know items for the reading's purpose.
- Iterate with analytics: Use Focus, Curiosity, and Effort metrics to adjust highlight density and assessment difficulty over time.
- Leverage visuals strategically: Use diagrams and images for concepts that benefit from visual representation, not every definition.
Troubleshooting & FAQs
The link I pasted won't Review correctly.
Ensure the URL is publicly accessible (no login or paywall required). If the page is behind authentication, export it to PDF and upload the file instead.
My document is stuck in Processing.
Large files with many graphics can take longer to process. If the status persists unusually long, try splitting the document into smaller sections and re-submitting each one.
Highlights feel too advanced or too basic.
Adjust the Reader level setting and add relevant context (course topic, prior knowledge). Then re-run Highlight to regenerate highlights at the appropriate level.
Students can see whether answers are correct, but I want to hide that.
In Assessment settings, disable "show correctness" and republish the article.
Can I change highlights after students start reading?
Yes. Use Edit (QiMeta Canvas) to update definitions or add visuals. Learners will see the latest version when they reload the article.
Glossary
Highlight
The process of annotating a document with definitions, key concepts, and optional assessments to enhance the reading experience.
Reader Level
Target complexity for definitions and highlight selections; default is 9th grade. Can be adjusted based on learner age, background, or course level.
Session
A continuous reading period. A new session automatically begins after 5 minutes of inactivity, allowing you to track engagement patterns.
Focus
A dashboard metric indicating how intently a reader stayed on task while reading the document.
Curiosity
A dashboard metric reflecting the reader's exploratory behavior, such as opening definitions and asking questions to deepen understanding.
Effort
A dashboard metric capturing the amount of work a reader invested, including time on task, navigation patterns, and total interactions.
Raw Navigation Report
Unfiltered interaction data showing clicks, scrolls, terms opened, and related events for detailed analysis.
QiMeta Canvas
The editing interface where you customize definitions and add diagrams or images to highlighted articles.
Version Information
v1.0 – Initial publication of QiMeta Highlighting & Reading Documentation.