Complete Tier 1: Quick Start Guide, User Manual, and FAQ

Quick Start Guide (10-minute onboarding):
- Platform-specific installation (Windows, macOS, Linux)
- Step-by-step project creation and first diagram
- Interface overview and toolbar guide
- Adding elements and drawing wires
- Labeling and saving
- Common first-time tasks and shortcuts

User Manual (comprehensive reference):
- Basics and interface overview with diagram
- Projects and folios (pages/diagrams)
- Working with elements (find, place, select, move, rotate)
- Drawing and editing wires/conductors
- Text, labels, and dynamic fields
- Editing, alignment, zoom, snap-to-grid
- Reports, export, and printing
- Preferences and settings
- Keyboard shortcuts table
- Troubleshooting section
- Links to advanced topics

FAQ (60+ questions with practical answers):
- Installation and setup for all platforms
- Getting started with projects and diagrams
- Common beginner questions about elements, wires, labels
- Creating and saving projects
- Organization and sharing
- Performance and troubleshooting
- File compatibility and advanced topics
- Platform-specific guidance
- Active community support pointers

Research gathered from:
- qelectrotech.org official manual structure
- GitHub releases and documentation
- Forum activity analysis
- Official example projects
- Official element collections

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GtMZqGEiUMvDBqcFvVG2vb
ispyisail
2026-09-09 15:12:50 +12:00
parent ca76ea1c70
commit 3c794eb8c8
4 changed files with 1095 additions and 194 deletions
+83
@@ -0,0 +1,83 @@
# Tier 1 Pages Research
Research compiled for Quick Start Guide, User Manual, and FAQ pages.
## Official Documentation Resources Found
- **Main Manual:** https://qelectrotech.github.io/qelectrotech-doc/index.html
- **YouTube Channel:** https://www.youtube.com/user/scorpio8101/videos
- **PDF Schemas:** https://download.qelectrotech.org/qet/schemas_pdf
- **Element Collection:** https://download.qelectrotech.org/qet/elements/index.html
- **Community Elements:** https://download.qelectrotech.org/qet/elements_contrib/index.html
- **Forum:** qelectrotech.org/forum (850 EN topics, 1,124 FR topics)
## Official Manual Structure
### Main Topics Covered
- **Basics** — Launching (Linux, Windows, Mac), help, quitting
- **Interface** — Menus, toolbars, workspaces, panels, customization
- **Preferences** — Display, appearance, project/element/text/grid/export settings
- **Projects** — Create, open, save, properties, organization
- **Folios** — Types (single-line, multiline, control), properties, title blocks
- **Elements** — Types (simple, master, slave), properties, collections, editor
- **Conductors** — Single-line, multiline, appearance, numbering
- **Schema Work** — Add elements, draw conductors, text, shapes, select, copy/paste
- **Reports** — Summaries, nomenclature, conductor lists, I/O docs
- **Export/Print** — PDF, export, database exports
- **Annex** — Variables, fonts, colors
## Common Beginner Question Areas (From Forum Analysis)
1. **Installation & Setup** — Platform-specific (Windows, Linux, macOS)
2. **Element Creation & Management** — Finding, using, creating elements
3. **Import/Export** — DXF conversion, file format questions
4. **Drawing Basics** — How to start, draw wires, add elements
5. **Documentation Gaps** — Users need more getting-started materials
## Example Projects Available
**Industrial:** CNC, PLC control, automation panels
**Residential:** Home wiring, domotics, solar/PV systems
**Specialized:** Vehicle wiring, HVAC, KNX automation, energy systems
**Educational:** Basic circuits, training examples
Use these as reference examples for tutorials.
## Key Insights
1. **Beginner Struggle Areas:**
- How to start a project
- Element placement and connection
- Drawing conductors/wires properly
- File import/export
2. **Strong Community:**
- 3,747+ users
- 850 EN help topics = active support
- Multilingual (FR, EN, DE, CS, etc.)
3. **Good Visual Learning Resources:**
- Existing PDF schemas/examples
- YouTube tutorials available
- Gallery of user projects
4. **Documentation Opportunity:**
- Wiki lacks beginner tutorials
- Quick Start and FAQ would fill gap
- Users currently ask in forums
## For Quick Start Page
- Reference: Basics section (launching, interface, first project)
- Examples: Use simple circuit example
- Steps: New project → Add elements → Draw wire → Save
## For User Manual Page
- Structure: Match official manual topics
- Add: Interface overview, feature screenshots
- Link: To official manual for deep dives
- Organize: By task type (not just features)
## For FAQ Page
- Questions from forum patterns: installation, elements, import/export, drawing
- Answers: Based on official manual content
- Cover: Platform-specific (Windows/Linux/Mac) issues
+316 -40
@@ -1,112 +1,388 @@
# Frequently Asked Questions # Frequently Asked Questions
Quick answers to common questions about QElectroTech. Quick answers to common questions about QElectroTech. Can't find your answer? See **[Getting Help](#getting-help)** below.
## Installation & Setup ## Installation & Setup
### Q: Where do I download QElectroTech? ### Q: Where do I download QElectroTech?
A: Visit [qelectrotech.org/downloads](https://qelectrotech.org/downloads/) for official releases, or see [Building QET](building) to compile from source.
**A:** Visit **[qelectrotech.org/downloads](https://qelectrotech.org/downloads/)** for:
- Windows installer (.exe, .msi)
- macOS package (.dmg)
- Linux AppImage, Flatpak, Snap packages
- Source code for building from source
**Or install via package manager:**
- **Ubuntu/Debian:** `sudo apt install qelectrotech`
- **Fedora:** `sudo dnf install qelectrotech`
- **Arch:** `sudo pacman -S qelectrotech`
### Q: What are the system requirements? ### Q: What are the system requirements?
A: *System requirements for Windows, macOS, and Linux*
**A:** Minimum requirements:
- **Windows:** Windows 7 or later (32-bit or 64-bit)
- **macOS:** macOS 10.12 or later
- **Linux:** Qt5-compatible distribution (Ubuntu 18.04+, Fedora 25+, etc.)
- **RAM:** 512 MB (1 GB recommended)
- **Disk:** 100 MB for installation
**Note:** Exact requirements vary by version. Check releases page for details.
### Q: How do I uninstall QElectroTech? ### Q: How do I uninstall QElectroTech?
A: *Uninstall instructions for each operating system*
**A:**
- **Windows:** Control Panel → Programs → Uninstall (or Windows Installer if portable)
- **macOS:** Drag QElectroTech from Applications to Trash, empty Trash
- **Linux (apt):** `sudo apt remove qelectrotech`
- **Linux (Flatpak):** `flatpak uninstall org.qelectrotech.QElectroTech`
- **AppImage:** Delete the downloaded .AppImage file
### Q: Is QElectroTech free? ### Q: Is QElectroTech free?
A: Yes! QElectroTech is free and open-source under the GNU GPL license.
**A:** Yes! Completely free and open-source:
- **License:** GNU GPL v3 (free software license)
- **Source code:** Publicly available on GitHub
- **No cost:** No licensing fees, subscription, or restrictions
- **Legal:** Can be used for personal, educational, and commercial projects
See **[License](license)** for details.
--- ---
## Getting Started ## Getting Started
### Q: I just installed QET. How do I create my first diagram? ### Q: I just installed QET. How do I create my first diagram?
A: See the **[Quick Start Guide](quick_start_guide)** for a 5-minute tutorial.
**A:** Follow the **[Quick Start Guide](quick_start_guide)** for a step-by-step tutorial. You'll:
1. Create a new project
2. Add elements from the library
3. Connect them with wires
4. Add labels
5. Save your work
Takes about 10 minutes!
### Q: How do I add elements to my diagram? ### Q: How do I add elements to my diagram?
A: Use the Elements panel on the right side. Search for what you need or browse by category, then drag elements onto your canvas.
**A:**
1. Find the **Elements panel** on the right side
2. **Search:** Type in the search box (e.g., "switch", "relay")
3. **Browse:** Expand categories (Control, Electrical, etc.)
4. **Drag:** Click and drag element onto canvas
5. **Place:** Release to place; drag again for another copy
**Tips:**
- Browse by category if you don't know the name
- Double-click category name to expand it
- Right-click element for rotation/flip options
### Q: How do I connect elements with wires? ### Q: How do I connect elements with wires?
A: Use the Wire tool from the toolbar, then click on connection terminals on each element.
**A:**
1. Click the **Wire tool** in the toolbar (lightning bolt icon)
2. **Click on a terminal** (small dot/circle on element edge)
3. Move your mouse to the next element's terminal
4. **Click again** to complete the connection
5. Wire is drawn automatically
**Important:** Only click on terminals (connection points). Wires won't connect to random points.
### Q: How do I add labels to wires and elements? ### Q: How do I add labels to wires and elements?
A: Double-click on a wire or element to add text.
**A:**
1. **Double-click** on the wire or element
2. **Type your label:**
- Wire: "L1", "Signal_A", "24V"
- Element: "S1", "R1", "M1"
3. Press **Enter**
Label now appears on the object.
### Q: Can I undo mistakes?
**A:** Yes!
- **Ctrl+Z** (Windows/Linux) or **Cmd+Z** (macOS) — undo
- **Ctrl+Y** or **Ctrl+Shift+Z** (macOS) — redo
- You can undo many steps by pressing multiple times
--- ---
## Creating Diagrams ## Creating & Saving Diagrams
### Q: What file format does QElectroTech use? ### Q: What file format does QElectroTech use?
A: QElectroTech projects are saved as `.qet` files (XML format), and elements as `.elmt` files.
**A:**
- **Projects:** `.qet` files (XML-based, human-readable)
- **Elements:** `.elmt` files (XML format for custom symbols)
- Both are text files, viewable in any text editor
See **[Project XML Structure](project_XML)** and **[Elements XML Structure](elements_XML)** for technical details.
### Q: Can I open QET files in other software? ### Q: Can I open QET files in other software?
A: `.qet` and `.elmt` are XML formats, so you can view and edit them in any text editor. See **[Project XML Structure](project_XML)** and **[Elements XML Structure](elements_XML)** for format details.
**A:** Partially:
- `.qet` and `.elmt` are XML, so text editors can view/edit them
- For electrical design software: Export to DXF or SVG for compatibility
- For documentation: Export to PDF or PNG
See **[User Manual → Export & Printing](user_manual#export--printing)** for export options.
### Q: How do I export my diagram? ### Q: How do I export my diagram?
A: Use **File → Export** to save as PNG, SVG, PDF, and other formats.
**A:**
1. **File → Export** (or right-click project/folio)
2. Choose format:
- **PDF** — Best for sharing/printing
- **PNG** — Image format for web/documents
- **SVG** — Vector format, editable
- **DXF** — CAD format
3. Choose location and filename
4. Click Export
### Q: How do I print my diagram? ### Q: How do I print my diagram?
A: Use **File → Print** or set up multi-page printing for large diagrams.
### Q: Can I create custom elements? **A:**
A: Yes! See **[Creating Elements](elements_XML)** for instructions. 1. **File → Print** (Ctrl+P)
2. **Configure:**
- Color or black & white
- Page size and orientation
- Scaling (fit to page, actual size, etc.)
3. Print to printer or PDF
4. For multi-page: Set up folio (page) layout first
### Q: How do I save my project?
**A:**
- **File → Save** (Ctrl+S) — Save current changes
- **File → Save As** — Save with new name
- **Auto-save:** Enabled by default (every few minutes)
- Projects save as `.qet` format
--- ---
## Projects & Organization ## Projects & Organization
### Q: How do I create multiple diagrams in one project? ### Q: How do I create multiple diagrams in one project?
A: *Instructions for managing multiple diagrams*
**A:**
1. **Right-click in Project panel** (left side)
2. **New Folio** (a folio = one page/diagram)
3. Choose folio type (Single-line, Multiline, etc.)
4. Enter title
5. New diagram ready to edit
**Organize:**
- Drag folios to reorder them
- Right-click folio for rename/properties
### Q: How do I organize a large project? ### Q: How do I organize a large project?
A: See **[Tips & Tricks](tips_and_tricks)** for organization strategies.
**A:** Best practices:
- **Group by function:** Power, Control, Safety, etc.
- **Name clearly:** "Main Power", "Control Logic", "Outputs", etc.
- **Use multiple folios:** One per major section
- **Consistent labeling:** Use reference designators (S1, R1, etc.)
See **[Tips & Tricks](tips_and_tricks)** for advanced organization strategies.
### Q: Can I share projects with other QET users? ### Q: Can I share projects with other QET users?
A: Yes, `.qet` files are portable. You can email them or use version control (Git). See **[Tips & Tricks](tips_and_tricks)** for collaboration workflows.
**A:** Yes!
- **Email .qet files** — Portable, self-contained
- **Cloud storage:** Dropbox, Google Drive, etc.
- **Version control:** Push to Git repo, collaborate
- **Network drive:** Share on company network
**Note:** Both users need QET installed to edit. Others can view via PDF export.
--- ---
## Troubleshooting ## Elements & Libraries
### Q: QET won't start / crashes on startup ### Q: Where are all the available elements?
A: *Common startup issues and solutions*
**A:** In the **Elements panel** (right side):
- **Built-in library:** 8,000+ symbols included
- **Search:** Type component name or number
- **Browse:** Expand categories for different types
- **Community:** Additional elements on [qelectrotech.org/elements](https://qelectrotech.org/)
### Q: Can I create custom elements?
**A:** Yes! See **[Creating Elements](elements_XML)** for detailed instructions to:
- Design element graphics
- Define connection terminals
- Create metadata
- Package for sharing
---
## Wires & Connections
### Q: My wires aren't connecting properly ### Q: My wires aren't connecting properly
A: *Tips for debugging wire connection problems*
**A:** Common issues:
1. **Not clicking on terminal** — Click directly on the small dot (terminal), not near it
2. **Broken connection** — Delete wire, reconnect to correct terminal
3. **Crossing wires without connecting** — Crossing wires don't join; must connect at terminal
4. **Element has no terminals** — Check element type; not all symbols can connect
**Solution:**
- Select wire with Selection tool
- Right-click → Delete
- Redraw, clicking precisely on terminals
### Q: Can I edit wire paths?
**A:** Yes!
1. **Select wire** (click on it)
2. **Drag waypoints** to adjust routing
3. **Right-click waypoint** to remove it
4. **Add waypoint** by clicking on wire with Wire tool
### Q: What does a crossed wire mean in QET?
**A:** By default, crossing wires **do NOT connect**. They're just visual crosses for complex diagrams. Explicit terminal connections are required.
---
## Performance & Issues
### Q: QET is running slowly with my large project ### Q: QET is running slowly with my large project
A: See the **[User Manual](user_manual)** Performance section.
### Q: I accidentally deleted something. How do I undo? **A:** Tips to improve performance:
A: Press Ctrl+Z (or Cmd+Z on macOS) to undo. You can undo multiple steps. 1. **Reduce zoom level** if viewing entire diagram
2. **Disable grid display** (View → Grid)
3. **Close unused panels** (View → Panels)
4. **Split into multiple folios** if diagram is very large (100+ elements)
5. **Turn off selection handles** when not editing
### Q: My file won't open in a newer/older version of QET For very large projects (1000+ elements), performance may be limited.
A: *Compatibility issues and migration instructions*
### Q: Where are project files stored? ### Q: My file won't open
A: QET files are saved wherever you choose. Look in your Documents folder or the last location you used.
**A:** Try:
1. **Check file location** — Ensure .qet file exists and is readable
2. **Verify permissions** — File should be readable/writable
3. **Version compatibility** — Try opening in different QET version
4. **Repair corrupted file** — Open in text editor, check for XML errors
5. **Restore backup** — If file is corrupted
See **[Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)** for bug reports.
### Q: QET won't start
**A:** Try:
1. **Reinstall:** Remove and reinstall QElectroTech
2. **Check logs:** Look for error messages on startup
3. **Disable plugins:** If crash on startup, plugins may be issue
4. **Clear cache:** Remove ~/.qelectrotech/ (Linux) or AppData (Windows)
5. **Update Qt:** Ensure Qt libraries are current
---
## File Compatibility
### Q: Can I open QET files from older versions?
**A:** Yes! QET maintains backward compatibility:
- Older .qet files open in newer versions
- Some formatting may change with UI updates
- Features added in newer versions won't be present in older files
**Best practice:** Keep files in current QET format.
### Q: What about files from different QET versions?
**A:** Generally compatible, but:
- Files made in v0.100 should open in v0.100+
- Files from v0.9 work in v0.100
- Very old files (v0.6 and earlier) may have compatibility issues
If having trouble, see **[Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)**.
--- ---
## Advanced Topics ## Advanced Topics
### Q: How do I write scripts for QElectroTech? ### Q: How do I create element libraries?
A: *Introduction to QET scripting (when available)*
### Q: Can I use QElectroTech in an automated/headless workflow? **A:**
A: *Information about automation and command-line usage* 1. Create custom elements (see **[Creating Elements](elements_XML)**)
2. Organize in folders
3. Distribute `.elmt` files to users
4. Users copy to element collection directory
Or publish on **[Community Elements](https://github.com/qelectrotech/qelectrotech-elements)** repository.
### Q: Can I use QET in scripts or automation?
**A:** Limited support:
- Python terminal block generator available
- Some command-line support in development
- See **[Contributing](contributing)** for scripting roadmap
### Q: How do I contribute to QElectroTech? ### Q: How do I contribute to QElectroTech?
A: See **[Contributing](contributing)** for guidelines.
### Q: Where can I get help with advanced topics? **A:** Multiple ways:
A: Visit the **[Forum](https://forum.qelectrotech.org/)** or check the **[Community](community)** resources. 1. **Report bugs** — [GitHub Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)
2. **Create elements** — Share symbols and components
3. **Translate** — Help internationalization efforts
4. **Write code** — See **[Contributing](contributing)** for guidelines
### Q: Where can I find example projects?
**A:** Examples available:
- **PDF schemas:** [qelectrotech.org/schemas_pdf](https://download.qelectrotech.org/qet/schemas_pdf)
- **Forum gallery:** [qelectrotech.org/forum](https://qelectrotech.org/forum/)
- **Your own projects:** Once experienced, create reference diagrams
---
## Platform-Specific Questions
### Q: How do I launch QET on Linux?
**A:**
- **Application menu** — Search for QElectroTech
- **Command line:** `qelectrotech`
- **Desktop shortcut:** Create launcher for quick access
### Q: How do I launch QET on macOS?
**A:**
- **Applications folder** → Double-click QElectroTech
- **Launchpad** → Click QElectroTech
- **Dock** → Drag application to Dock for quick access
### Q: How do I launch QET on Windows?
**A:**
- **Start menu** → Search "QElectroTech" and click
- **Desktop shortcut** → Double-click (if created during install)
- **Command line:** `qelectrotech` (if in PATH)
--- ---
## Didn't Find Your Answer? ## Didn't Find Your Answer?
- **[User Manual](user_manual)** — Detailed feature documentation **Resources:**
- **[Quick Start Guide](quick_start_guide)** — Get started in 10 minutes
- **[User Manual](user_manual)** — Complete feature documentation
- **[Tips & Tricks](tips_and_tricks)** — Advanced workflows - **[Tips & Tricks](tips_and_tricks)** — Advanced workflows
- **[Forum](https://forum.qelectrotech.org/)** — Ask the community - **[Forum](https://forum.qelectrotech.org/)** — Ask the community (very responsive!)
- **[Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)** — Report bugs or request features - **[GitHub Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)** — Report bugs and request features
- **[Community](community)** — Find help and connect with users
---
## Still Stuck?
Post on the **[QElectroTech Forum](https://forum.qelectrotech.org/)** with:
1. Description of your problem
2. QET version you're using
3. Steps to reproduce
4. Screenshots if helpful
5. Your operating system
Community members are very helpful and responsive!
+179 -45
@@ -1,72 +1,206 @@
# Quick Start Guide # Quick Start Guide
Get QElectroTech running and create your first diagram in 5 minutes. Get QElectroTech running and create your first electrical diagram in 10 minutes.
## Step 1: Download & Install ## Step 1: Download & Install
### Windows ### Windows
1. Visit [qelectrotech.org/downloads](https://qelectrotech.org/downloads/)
2. Download the Windows installer 1. Visit **[qelectrotech.org/downloads](https://qelectrotech.org/downloads/)**
3. Run the installer and follow the prompts 2. Download the Windows installer (.exe or .msi)
4. Launch QElectroTech from your Start menu 3. Run the installer and follow the setup wizard
4. Launch QElectroTech from your Start menu or desktop
### macOS ### macOS
1. Visit [qelectrotech.org/downloads](https://qelectrotech.org/downloads/)
2. Download the macOS package 1. Visit **[qelectrotech.org/downloads](https://qelectrotech.org/downloads/)**
3. Drag QElectroTech to Applications 2. Download the macOS package (.dmg)
4. Launch from Applications folder 3. Open the .dmg file
4. Drag QElectroTech to the Applications folder
5. Launch from Applications or Launchpad
### Linux ### Linux
**Ubuntu/Debian:**
```bash ```bash
# Ubuntu/Debian sudo apt update
sudo apt install qelectrotech sudo apt install qelectrotech
# Fedora
sudo dnf install qelectrotech
# Or compile from source - see [Building QET](building)
``` ```
## Step 2: Create Your First Project **Fedora/RHEL:**
```bash
sudo dnf install qelectrotech
```
1. Open QElectroTech **Arch Linux:**
```bash
sudo pacman -S qelectrotech
```
**Or use AppImage/Flatpak:**
- Download from [qelectrotech.org/downloads](https://qelectrotech.org/downloads/)
---
## Step 2: Launch & Create Your First Project
1. **Open QElectroTech** — The application will launch with a welcome screen
2. Click **File → New Project** 2. Click **File → New Project**
3. Choose your diagram size (A4, A3, etc.) 3. **Choose your project settings:**
4. Click **OK** - **Page Size:** A4 (or A3 for larger diagrams)
- **Orientation:** Portrait or Landscape
- Click **OK**
4. QElectroTech opens with a blank diagram ready for work
## Step 3: Draw Your First Diagram ---
### Add Elements ## Step 3: Get Familiar with the Interface
1. Find the **Elements panel** on the right
2. Search for "switch" or browse categories
3. Drag an element onto your diagram
4. Repeat to add more elements
### Connect with Wires Your workspace has several key areas:
1. Click the **Wire tool** in the toolbar
2. Click on a terminal (connection point) on your first element
3. Click on a terminal on your second element
4. The wire is drawn automatically
### Add Labels & Text - **Left side:** Drawing canvas (where you create diagrams)
1. Double-click on a wire or element to add a label - **Right side:** **Elements panel** (symbols and components)
2. Type your text and press Enter - **Top:** **Toolbar** with tools (select, wire, text, etc.)
- **Bottom:** Status bar showing cursor position and tool info
## Step 4: Save Your Work ### Key Toolbar Buttons
1. Click **File → Save** - **Selection tool** (arrow) — Select and move elements
2. Choose a location and enter a filename - **Wire tool** (lightning bolt) — Draw connections
3. QElectroTech saves as `.qet` format - **Text tool** (A) — Add labels and text
- **Zoom controls** — Enlarge/shrink view
## Next Steps ---
- Explore the **[User Manual](user_manual)** for detailed features ## Step 4: Add Your First Element
- Check out **[Tips & Tricks](tips_and_tricks)** for advanced workflows
- Learn to **[Create Custom Elements](elements_XML)** 1. Look at the **Elements panel** on the right
- Join the **[Community](community)** for help 2. **Search for an element:**
- Type "switch" in the search box, or
- Browse categories like "03_Control" or "10_Electrical"
3. **Drag the element** onto your canvas
4. **Drag more elements** to build your circuit:
- Add a power source (battery or AC symbol)
- Add a switch
- Add a lamp or load
- Arrange them roughly in a line
**Tip:** Right-click on an element to rotate it 90°, flip it, or access properties.
---
## Step 5: Draw Wires to Connect Elements
1. Click the **Wire tool** in the toolbar (looks like a lightning bolt)
2. **Click on a terminal** (the small circle/dot at connection points on elements)
3. **Move the mouse** to the next element's terminal
4. **Click again** to complete the wire connection
5. The wire is drawn automatically between the two points
**Connection Tips:**
- Wires connect at terminal points only (small dots on elements)
- You can create multi-segment wires by clicking multiple times
- Press **Escape** to cancel wire drawing
---
## Step 6: Add Labels & Text
### Label a Wire (e.g., signal name, voltage)
1. **Double-click on the wire**
2. Type your label (e.g., "L1", "GND", "Signal_A")
3. Press **Enter**
### Label an Element (e.g., reference number)
1. **Double-click on an element**
2. Type a reference number (e.g., "S1", "R1", "U1")
3. Press **Enter**
### Add Free Text
1. Click the **Text tool** in the toolbar
2. Click on the canvas where you want text
3. Type your text
4. Click elsewhere to finish
---
## Step 7: Save Your Work
1. Click **File → Save** (or press Ctrl+S)
2. **Choose a location** on your computer
3. **Enter a filename** (e.g., "my_first_circuit")
4. QElectroTech saves your project as a `.qet` file
5. Your file is saved and can be reopened anytime
---
## Your First Circuit Complete! 🎉
You now have a basic electrical diagram showing:
- ✅ Elements (components)
- ✅ Wires (connections)
- ✅ Labels (identification)
### Next Steps
**Learn More:**
- Explore the **[User Manual](user_manual)** for all features
- See **[Tips & Tricks](tips_and_tricks)** for advanced techniques
- Browse **[Features](features)** to see what else QET can do
**Create More:**
- Add more folios (pages) to your project via **Project → New Folio**
- Create multi-page electrical schematics
- Export to PDF, PNG, or SVG
**Customize:**
- Change wire colors and styles (right-click wire → properties)
- Adjust element properties
- Use the grid and snap features for alignment
**Share & Collaborate:**
- Export diagrams as PDF or PNG to share
- Save .qet files to share with colleagues
- Use version control (Git) for team projects
---
## Common First-Time Tasks
### "How do I undo a mistake?"
Press **Ctrl+Z** (or Cmd+Z on Mac) to undo. Repeat to undo multiple steps.
### "How do I zoom in/out?"
- **Zoom in:** Scroll wheel up, or press **+**
- **Zoom out:** Scroll wheel down, or press **-**
- **Fit to page:** Press **Ctrl+0** (or Cmd+0 on Mac)
### "How do I rotate an element?"
Right-click the element and choose **Rotate 90°**, or select it and press **R**.
### "How do I delete something?"
Select it and press **Delete**, or right-click and choose **Delete**.
### "How do I find a specific component?"
Use the **Search box** in the Elements panel on the right. Type the component name or number.
---
## Getting Help ## Getting Help
- **[FAQ](faq)** — Common questions - **[FAQ](faq)** — Quick answers to common questions
- **[Forum](https://forum.qelectrotech.org/)** — Ask the community - **[User Manual](user_manual)** — Complete feature documentation
- **[Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)** — Report problems - **[Forum](https://forum.qelectrotech.org/)** — Ask the community (very responsive!)
- **[GitHub Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)** — Report bugs
---
## Ready to Learn More?
You've learned the basics! Now explore:
- **[User Manual](user_manual)** — Deep dive into features
- **[Tips & Tricks](tips_and_tricks)** — Power-user workflows
- **[Creating Custom Elements](elements_XML)** — Build your own symbols
+517 -109
@@ -1,56 +1,159 @@
# User Manual # User Manual
Comprehensive guide to using QElectroTech for creating electrical diagrams and schematics. Complete reference guide for using QElectroTech to create electrical diagrams, schematics, and automation drawings.
## Table of Contents ## Table of Contents
1. [Interface Overview](#interface-overview) 1. [Basics](#basics)
2. [Projects & Diagrams](#projects--diagrams) 2. [Interface Overview](#interface-overview)
3. [Working with Elements](#working-with-elements) 3. [Projects & Folios](#projects--folios)
4. [Drawing Wires](#drawing-wires) 4. [Working with Elements](#working-with-elements)
5. [Text & Labels](#text--labels) 5. [Drawing Wires & Conductors](#drawing-wires--conductors)
6. [Editing & Formatting](#editing--formatting) 6. [Text, Labels & Annotations](#text-labels--annotations)
7. [Exporting & Printing](#exporting--printing) 7. [Schema Editing & Formatting](#schema-editing--formatting)
8. [Advanced Features](#advanced-features) 8. [Reports & Documentation](#reports--documentation)
9. [Export & Printing](#export--printing)
10. [Preferences & Settings](#preferences--settings)
11. [Advanced Topics](#advanced-topics)
12. [Troubleshooting](#troubleshooting)
---
## Basics
### Launching QElectroTech
**Linux/macOS/Windows:**
- Double-click the QElectroTech application
- Or launch from terminal: `qelectrotech`
**Platform-Specific:**
- **Linux:** Also available via package manager (`apt install qelectrotech`)
- **macOS:** Drag from Applications to Dock for easy access
- **Windows:** Pin to Start menu or desktop for quick launch
### Quitting the Application
- **File → Exit** (or File → Quit)
- Close the main window
- Save your projects before quitting
### Getting Help Inside QET
- **Help → Manual** — Opens the official PDF manual
- **Help → About** — Shows version and credits
- Right-click on elements for context help
--- ---
## Interface Overview ## Interface Overview
*The QElectroTech workspace: menu bar, toolbars, panels, and diagram canvas* ### Main Workspace
### Main Components ```
┌─────────────────────────────────────────────────────────┐
│ Menu Bar (File, Edit, View, Insert, Tools, Help) │
├─────────────────────────────────────────────────────────┤
│ Toolbar (Select, Wire, Text, Shapes, etc.) │
├─────────┬─────────────────────────────┬─────────────────┤
│ Project │ │ Elements Panel │
│ Panel │ DIAGRAM CANVAS │ (Search & Browse)
│ │ (Your drawing area) │ │
│ (Folios)│ │ Properties │
│ │ │ (Selected item)│
├─────────┴─────────────────────────────┴─────────────────┤
│ Status Bar (Coordinates, Zoom, Current Mode) │
└─────────────────────────────────────────────────────────┘
```
- **Menu Bar** — File, Edit, View, Insert, Tools, Windows, Help ### Key Panels
- **Toolbar** — Quick access to common tools (select, wire, text, etc.)
- **Elements Panel** (right) — Browse and search available elements
- **Properties Panel** — Adjust properties of selected objects
- **Diagram Canvas** — Your working area for drawing
- **Status Bar** — Information about current selection and zoom
### Customizing the Interface **Elements Panel (Right Side)**
- Search box for finding components
- Categories for browsing
- Drag elements onto canvas
- Shows "Master" elements and connections info
*How to show/hide panels, customize toolbars, and arrange your workspace* **Project Panel (Left Side)**
- Lists all folios (pages) in your project
- Add new folios (diagrams)
- Organize and rename folios
- Right-click for folio properties
**Toolbar**
- **Selection Tool** — Select and move objects
- **Wire Tool** — Draw electrical connections
- **Text Tool** — Add labels and annotations
- **Shape Tools** — Add rectangles, circles, polygons
- **Zoom Controls** — Magnify/reduce view
**Preferences Panel (Windows Menu)**
- Show/hide panels as needed
- Customize workspace layout
- Save custom workspaces
### Customizing Your Workspace
- **View → Panels** — Show/hide side panels
- **View → Toolbars** — Show/hide toolbars
- Drag panels to reposition
- Double-click panel tabs to float/dock
--- ---
## Projects & Diagrams ## Projects & Folios
### Creating a New Project ### Creating a New Project
*Steps to create a new project with custom settings* 1. **File → New Project**
2. **Project Settings:**
- **Page Size:** Choose A4, A3, Letter, Legal, or custom
- **Orientation:** Portrait or Landscape
- **Margin settings** (if needed)
3. Click **OK**
4. Your blank project is ready
### Managing Multiple Diagrams ### Understanding Folios
*Adding, organizing, and navigating between diagrams in one project* A **folio** is a single page/diagram within your project.
### Project Settings **Folio Types:**
*Page size, scale, printing options, and project properties* - **Single-line diagram** — Simplified representation (most common)
- **Multiline diagram** — Detailed connection details
- **Control diagram** — Logic and control circuits
### Opening & Saving To create a new folio:
- Right-click in Project panel → **New Folio**
- Choose folio type
- Set title and properties
*File formats (.qet), autosave, backups, and version control* ### Organizing Your Project
- **Rename folios:** Right-click folio → **Rename**
- **Reorder folios:** Drag & drop in Project panel
- **Delete folios:** Right-click → **Delete** (confirm)
- **Folio properties:** Right-click → **Properties**
- Title block information
- Scale and print settings
- Author and date
### Opening & Saving Projects
**Opening:**
- **File → Open Recent** — Quick access to recent projects
- **File → Open** — Browse for .qet files
- **Ctrl+O** (or Cmd+O) — Keyboard shortcut
**Saving:**
- **File → Save** — Save current project (Ctrl+S)
- **File → Save As** — Save with new name
- **Auto-save** — Configure in Preferences
**File Format:**
- QElectroTech projects are saved as `.qet` files
- XML-based format, human-readable
- Can be opened in text editor if needed
--- ---
@@ -58,180 +161,485 @@ Comprehensive guide to using QElectroTech for creating electrical diagrams and s
### Finding Elements ### Finding Elements
*Browsing by category, searching, and creating favorite elements* **Search Method:**
1. Type in the **search box** at top of Elements panel
2. Results appear instantly as you type
3. Click element to select it for placement
**Browse by Category:**
1. Expand categories in Elements panel
2. Categories organized by electrical type (switches, relays, etc.)
3. Sub-categories for specific component families
**Common Categories:**
- 01_Misc — Miscellaneous symbols
- 03_Control — Control devices and logic
- 04_Energy — Power generation and distribution
- 10_Electrical — Standard electrical components
### Placing Elements ### Placing Elements
*Drag and drop, rotation, alignment, and positioning* **Drag & Drop:**
1. Click and hold an element in Elements panel
2. Drag onto your canvas
3. Release to place
4. Element appears at cursor position
### Selecting & Deselecting **Multiple Placements:**
- Don't release from Elements panel, just click canvas multiple times
- Convenient for adding many of the same element
*Single select, multi-select, selection tools, and filters* **Smart Rotation:**
- Place element at rough angle
- Right-click → **Rotate 90°** to adjust
- Or select element and press **R**
### Moving & Duplicating ### Selecting Elements
*Move, copy, paste, cut, and keyboard shortcuts* **Single Select:**
- Click on element with Selection tool
**Multi-Select:**
- Hold **Ctrl** (or Cmd on Mac) and click elements
- Or drag a selection box around multiple elements
**Select All:**
- **Edit → Select All** (Ctrl+A)
- Or use **Ctrl+A**
### Moving & Positioning Elements
**Move:**
1. Click element to select (handles appear)
2. Drag to new position
3. Hold **Shift** to constrain to horizontal/vertical
**Precise Positioning:**
- Use **arrow keys** to nudge selected elements
- Hold **Shift** for larger jumps
**Snap to Grid:**
- Elements snap to grid by default
- Toggle grid snap: **View → Snap to Grid**
- Adjust grid size: **Preferences → Grid**
### Duplicating Elements
**Copy & Paste:**
1. Select element(s)
2. **Ctrl+C** to copy
3. **Ctrl+V** to paste (appears offset from original)
4. Drag to final position
**Quick Duplicate:**
1. Select element
2. **Edit → Duplicate**
3. New copy appears nearby
### Rotating & Flipping ### Rotating & Flipping
*Rotate elements 90°, flip horizontally/vertically* **Rotate:**
- Select element
- Right-click → **Rotate 90°**
- Or press **R** and click to rotate
### Resizing & Grouping **Flip:**
- Right-click → **Flip Horizontally** or **Flip Vertically**
- Or use **H** or **V** shortcuts
*Resize, group elements, lock position and properties* ### Grouping & Locking
**Lock Position:**
- Select element
- Right-click → **Lock position** (prevents accidental moves)
- Unlock same way to allow movement
**Lock Appearance:**
- Lock text, style, or connections
- Right-click → **Properties** for locking options
### Deleting Elements ### Deleting Elements
*Remove single or multiple elements from your diagram* - Select element(s)
- Press **Delete** key
- Or right-click → **Delete**
- Use **Ctrl+Z** to undo deletion
--- ---
## Drawing Wires ## Drawing Wires & Conductors
### Wire Tool Basics ### Understanding Conductors
*Selecting the wire tool and drawing connections* A **conductor** is an electrical connection between elements (the wires/lines).
### Wire Modes **Types:**
- **Single-line** — Simplified representation
- **Multiline** — Individual conductor lines shown
*Orthogonal vs. free-form wires, and wire styles* ### Drawing Wires
### Connecting to Terminals **Basic Wire Drawing:**
1. Click the **Wire Tool** (lightning bolt icon)
2. Click on a **terminal** (connection point on element)
3. Move mouse to destination terminal
4. Click to complete the wire
5. Wire is drawn, automatically routed
*Finding connection points and ensuring valid connections* **Multi-Segment Wires:**
1. Click first terminal (start point)
2. Click intermediate points for routing
3. Click final terminal (end point)
4. Press **Escape** to finish
**Wire Routing:**
- Automatic routing typically creates orthogonal (right-angle) paths
- Click waypoints to control path
- Press **Escape** to abandon wire
### Editing Wires ### Editing Wires
*Moving, deleting, splitting, and joining wires* **Modify Wire Path:**
1. Select wire (click on it)
2. Drag waypoints to adjust routing
3. Right-click waypoint to remove it
**Delete Wire:**
- Select wire
- Press **Delete**
**Split Wire:**
- Click wire with Wire tool to add connection point
- Place element on wire to split automatically
**Join Wires:**
- Wires joining at terminal automatically connect
- No manual joining needed
### Wire Properties ### Wire Properties
*Color, thickness, style, and electrical properties* **Change Wire Appearance:**
1. Right-click wire
2. Select **Properties**
3. **Modify:**
- Color (from color palette)
- Style (solid, dashed, dotted)
- Thickness (line width)
**Conductor Properties:**
1. Right-click wire
2. Select **Conductor Properties**
3. **Set:**
- Conductor type (phase, neutral, ground, etc.)
- Electrical properties
- Numbering scheme
--- ---
## Text & Labels ## Text, Labels & Annotations
### Adding Text ### Adding Text Labels
*Text tool, entering text, and formatting options* **Text Tool Method:**
1. Click **Text Tool** (A icon) in toolbar
2. Click on canvas where you want text
3. Type your text
4. Click elsewhere to finish
### Wire Labels **Quick Labels on Elements/Wires:**
1. Double-click element or wire
2. Type text (e.g., "S1" for switch 1)
3. Press **Enter**
4. Label appears on object
*Labeling wires with signal names, voltages, and notes* ### Labeling Wires
### Element Labels Common wire labels:
- **Signal names:** "L1", "L2", "N", "PE" (ground)
- **Voltage:** "24V AC", "12V DC"
- **Function:** "Enable", "Reset", "Alarm"
*Adding reference designations and descriptions to elements* To add wire label:
1. Double-click wire
2. Type label text
3. Press **Enter**
### Dynamic Fields ### Labeling Elements
*Using variables like %id, %label, and %author* Common element labels:
- **Reference designator:** "S1" (switch 1), "R1" (relay 1), "M1" (motor 1)
- **Component value:** "100kΩ", "10µF"
- **Description:** "Power Switch", "Start Button"
To add element label:
1. Double-click element
2. Type reference (e.g., "Q1")
3. Press **Enter**
### Dynamic Text Fields
Use variables that auto-populate:
- **%id** — Element ID/reference number
- **%label** — Element label
- **%comment** — Comment text
- **%author** — Project author
- **%date** — Current date
- **%filename** — Project filename
Example: Add text "%date" and it displays today's date automatically.
### Text Formatting ### Text Formatting
*Font selection, size, color, and alignment* **Font & Style:**
1. Select text element
2. Right-click → **Properties**
3. **Configure:**
- Font family (Arial, Times, etc.)
- Size (points)
- Color
- Orientation (horizontal, vertical, 45°, etc.)
--- ---
## Editing & Formatting ## Schema Editing & Formatting
### Selection & Organization
**Select All Objects:**
- **Edit → Select All** (Ctrl+A)
**Select by Type:**
- **Edit → Select** (submenu for selecting specific types)
**Multi-Select Tips:**
- Hold **Ctrl** and click to add to selection
- Shift+click to select range
- Drag box to select all within box
### Alignment & Distribution
**Align Objects:**
1. Select multiple objects
2. Right-click → **Align**
3. Choose: Left, Right, Top, Bottom, Center
**Distribute Spacing:**
1. Select objects (3 or more)
2. Right-click → **Distribute**
3. Evenly space horizontally or vertically
### Grid & Snap Features
**Grid Settings:**
- **View → Snap to Grid** — Toggle snapping on/off
- **Preferences → Grid** — Adjust grid size
- Smaller grid = finer positioning; larger = faster placement
**Alignment Tips:**
- Enable snap for neat, aligned diagrams
- Disable for free placement
- Toggle with keyboard shortcut
### Undo & Redo ### Undo & Redo
*Reverting and re-applying changes* **Undo:**
- **Ctrl+Z** (or Cmd+Z on Mac)
- **Edit → Undo** from menu
- Undo multiple steps repeatedly
### Selection Tools **Redo:**
- **Ctrl+Y** (or Cmd+Shift+Z on Mac)
*Select all, select by type, and deselect* - **Edit → Redo** from menu
- Redo multiple steps repeatedly
### Alignment Tools
*Align left, right, center, top, bottom, and distribute spacing*
### Snap to Grid
*Enable/disable, adjust grid size, and alignment options*
### Zoom & Pan ### Zoom & Pan
*Zoom in/out, fit to page, pan, and navigation shortcuts* **Zoom Methods:**
- **Scroll wheel:** Up to zoom in, down to zoom out
- **+/-** keys: Magnify or reduce
- **Ctrl+Scroll:** Fine zoom control
- **View → Zoom → Fit to Page:** Auto-fit diagram
**Pan (Move View):**
- **Middle mouse button:** Click and drag to pan
- **Space + drag:** Hold space and drag to pan
- **Arrow keys:** Nudge view (when nothing selected)
--- ---
## Exporting & Printing ## Reports & Documentation
### Generating Reports
Reports automatically create documentation from your schema:
**Available Reports:**
1. **Nomenclature** — List of all elements with reference numbers
2. **Conductor List** — All wires with connections and properties
3. **I/O Documentation** — Inputs and outputs summary
**Creating a Report:**
1. **Project → Reports**
2. Select report type
3. **Configure options** (what to include)
4. Generate (exports to file)
---
## Export & Printing
### Printing Diagrams ### Printing Diagrams
*Print preview, page setup, scaling, and multi-page printing* **Print Preview:**
1. **File → Print Preview**
2. See how diagram will print
3. Adjust settings if needed
### Exporting Formats **Print Settings:**
1. **File → Print**
2. **Configure:**
- Page size and orientation
- Color or black & white
- Scale (fit to page, actual size, etc.)
3. Print to printer or PDF
*PNG, SVG, PDF, and other export options* ### Exporting Diagrams
### Batch Export **Export Formats:**
- **PDF** — Professional documents, best for sharing
- **PNG** — Raster image, good for web
- **SVG** — Vector format, editable in other software
- **DXF** — CAD format for collaboration
*Export multiple diagrams at once* **Export Process:**
1. Select folio(s) to export
### Print-Friendly Settings 2. **File → Export**
3. Choose format and location
*Color vs. black & white, margins, and quality settings* 4. Configure export options
5. Click **Export**
--- ---
## Advanced Features ## Preferences & Settings
### Custom Elements ### Display & Appearance
*Creating your own elements and element libraries* **Preferences → Display:**
- Language selection
- Theme (light/dark)
- Font size and rendering
- Color scheme
### Templates ### Project Settings
*Using project templates and diagram templates* **Preferences → Projects:**
- Default page size
- Margin settings
- Default conductors
- Auto-numbering rules
### Grid & Snap
**Preferences → Grid:**
- Grid size
- Show/hide grid
- Snap distance
- Grid line style
---
## Advanced Topics
### Creating Custom Elements
See **[Creating Elements](elements_XML)** for detailed instructions on:
- Designing element graphics
- Defining connection terminals
- Creating element metadata
- Packaging for distribution
### Element Collections & Libraries
- Organize custom elements
- Create private libraries
- Share with team or community
- Access community element repository
### Multi-User Workflows
- Save .qet files to shared storage (network drive)
- Use version control (Git) for diagrams
- Collaborate with team members
- Merge changes when working in parallel
### Scripting & Automation ### Scripting & Automation
*Writing scripts to automate common tasks* *Information on Python scripting support (when fully documented)*
### Database Integration
*Importing component data and managing libraries*
### Multi-User Projects
*Collaboration features and version control integration*
--- ---
## Troubleshooting ## Troubleshooting
*Common issues and solutions* ### Common Issues
### Performance **"Element won't connect to wire"**
- Click directly on terminal (small dot)
- Not all points on element are connectable
- Check element properties for terminal definitions
*Optimizing large diagrams and reducing file size* **"Wires crossing without connecting"**
- Wires only connect at terminals
- Crossing lines don't automatically join
- Use explicit connection at terminal points
### Compatibility **"Diagram is slow/laggy"**
- Large projects with many elements slow responsiveness
- Reduce zoom level to improve performance
- Disable grid display if not needed
- Close unnecessary panels
*Opening files from different QET versions* **"File won't open"**
- Corrupted file or compatibility issue
### Importing - Try opening in text editor to check XML validity
- Restore from backup if available
*Importing from other diagram tools*
--- ---
## Keyboard Shortcuts ## Keyboard Shortcuts
*Complete list of keyboard shortcuts for common tasks* | Action | Windows/Linux | macOS |
|--------|---|---|
| New | Ctrl+N | Cmd+N |
| Open | Ctrl+O | Cmd+O |
| Save | Ctrl+S | Cmd+S |
| Print | Ctrl+P | Cmd+P |
| Undo | Ctrl+Z | Cmd+Z |
| Redo | Ctrl+Y | Cmd+Shift+Z |
| Select All | Ctrl+A | Cmd+A |
| Copy | Ctrl+C | Cmd+C |
| Paste | Ctrl+V | Cmd+V |
| Delete | Delete | Delete |
| Rotate | R | R |
| Zoom In | + | + |
| Zoom Out | - | - |
| Fit to Page | Ctrl+0 | Cmd+0 |
--- ---
## Tips & Best Practices ## More Resources
See **[Tips & Tricks](tips_and_tricks)** for advanced workflows and best practices. - **[Quick Start Guide](quick_start_guide)** — Getting started
- **[Tips & Tricks](tips_and_tricks)** — Advanced workflows
- **[FAQ](faq)** — Common questions
- **[Official Manual](https://qelectrotech.github.io/qelectrotech-doc/)** — Full documentation
- **[Forum](https://forum.qelectrotech.org/)** — Community help
## Need Help? ---
- **[FAQ](faq)** — Quick answers to common questions ## Getting Help
- **[Forum](https://forum.qelectrotech.org/)** — Ask the community
- **[FAQ](faq)** — Quick answers
- **[Forum](https://forum.qelectrotech.org/)** — Ask the community (very active!)
- **[Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)** — Report bugs - **[Issues](https://github.com/qelectrotech/qelectrotech-source-mirror/issues)** — Report bugs
- **[Creating Elements](elements_XML)** — Build custom components