Skip to content

Latest commit

 

History

History
127 lines (84 loc) · 4.7 KB

File metadata and controls

127 lines (84 loc) · 4.7 KB

User Guide

Your complete guide to using the NZ Legislation Tool


Welcome!

This guide will help you get the most out of the NZ Legislation Tool. Whether you're a researcher, student, developer, or administrator, you'll find workflows and tips tailored to your needs.

New to the tool? Start with our Quick Start Guide.


📚 What's Inside

For Researchers

For Students

For Developers

For Administrators


🎯 Quick Reference

Common Tasks

Task Command Example
Search nzlegislation search --query "..." nzlegislation search --query "health"
Get details nzlegislation get "ID" nzlegislation get "act/2020/67"
Export to CSV nzlegislation export --query "..." --output file.csv nzlegislation export --query "health" --output results.csv
Generate citation nzlegislation cite "ID" nzlegislation cite "act/2020/67"
Check config nzlegislation config --show (shows current settings)

Filters

Filter Option Example
Type --type --type act
Status --status --status in-force
Date from --from --from 2020-01-01
Date to --to --to 2024-12-31
Limit --limit --limit 50

🎓 Tutorials

Beginner Tutorials

  1. Your First Search (Coming Soon)
  2. Export to Excel (Coming Soon)
  3. Create Citations (Coming Soon)

Intermediate Tutorials

  1. Advanced Filtering (Coming Soon)
  2. Batch Operations (Coming Soon)
  3. Working with Dates (Coming Soon)

Advanced Tutorials

  1. Automation Scripts (Coming Soon)
  2. API Integration (Coming Soon)
  3. Performance Optimization (Coming Soon)

❓ Need Help?


♿ Accessibility

This documentation aims to meet WCAG 2.1 AA standards for accessibility.

Features:

  • ✅ Screen reader compatible structure
  • ✅ Keyboard navigation supported
  • ✅ High contrast text formatting
  • ✅ Descriptive link text (no "click here")
  • ✅ Clear heading hierarchy
  • ✅ Plain language (Grade 8-10 reading level)

Issues? If you encounter accessibility barriers, please open an issue or contact us.


📖 Related Documentation


Last Updated: 2026-03-10
Version: 1.0.0