About QRef

Required Metadata

Your CSV file must include a database name in a special metadata row. Metadata rows use # in the category column:

Optional Metadata

You can also include version and last updated information:

• # version - Defaults to "1.0" if not specified
• # last_updated - Defaults to today's date if not specified

Data Format

After the metadata, include your terms with these columns:

1. category - The category or section of the term (required)
2. term - The term name or title (required)
3. definition - A clear explanation of the term (optional)
4. example - A practical example or use case (optional)

Note: Only category and term are required for each row. The definition and example fields can be left empty.

The header row (category,term,definition,example) is optional. QRef auto-detects whether it's present.

Multiple Examples

You can provide multiple examples for any term by adding extra data beyond the standard 4 columns:

• Start with the standard example column for your first example
• Add additional examples by including more data in the same row
• No additional column headers needed - just add the extra example data
• Each example will be displayed separately in the UI

category,term,definition,example
JavaScript,Array,"A list of values","[1, 2, 3]","new Array(5)","['a', 'b', 'c']"

In this example, the Array term has three different examples that will each be displayed in their own section.

Phraseology Support (Optional 4th Column)

QRef supports an optional phraseology column that helps categorize how terms are used in practice. This is especially useful for programming references, language learning, or any domain where context matters:

• Add phraseology as the 4th column after example
• Use common phrases like "declare variable", "call function", "create array"
• Phraseology appears as a secondary label under each term
• Helps users understand the typical usage context of terms
• Can be left empty if not needed - it's completely optional

category,term,definition,phraseology,example
Programming,Variable,"A named storage location",declare variable,"let count = 0;"
Programming,Function,"A reusable block of code",define function,"function add(a, b) { return a + b; }"

The phraseology column appears between definition and example, helping users understand not just what a term means, but how it's typically used in practice.

Example with Full Metadata and Header

category,term,definition,example
# name,Programming Reference,,
# version,1.0,,
# last_updated,2025-10-22,,
Programming,Variable,A named storage location in memory,"let count = 0;","const name = 'John';","var isActive = true;"
Programming,Function,A reusable block of code,"function add(a, b) { return a + b; }"
Web Development,HTML,Markup language for web pages,"<div>Content</div>","<p>Paragraph</p>"

Example without Header Row

# name,Quick Reference,,
Programming,Variable,A named storage location in memory,"let count = 0;"
Programming,Function,A reusable block of code,"function add(a, b) { return a + b; }"