features
ispyisail edited this page 2026-09-12 07:29:35 +12:00
Clone

Wiki Page Revisions

5 Commits

Author SHA1 Message Date
ispyisail f3bfa8387c Document Search & Replace and the nomenclature/summary query builder
Both were confirmed still-real gaps from the survey: Search & Replace
(sources/SearchAndReplace/, ~3,180 lines) was a single features.md bullet,
and the query-builder UI (sources/dataBase/ui/, ~1,088 lines) was only
named once inside project_database.md as a pointer to ElementQueryWidget,
with no workflow documentation.

## Search & Replace

The name is misleading and worth correcting up front: this is not text
find/replace. SearchAndReplaceWorker::applyChange() shows the real
semantics -- an empty field leaves a property untouched, a filled field
replaces it wholesale (never a substring swap), and a reserved sentinel
string (set via a per-field checkbox, never typed by the user) explicitly
clears a field. Three states per field, not two. Traced through
setupLineEdit()'s own doc comment and applyChange()'s three-branch
behavior to be sure of this before writing it down.

## Nomenclature / summary query builder

ElementQueryWidget (element_nomenclature_view) and SummaryQueryWidget
(project_summary_view) are a visual SELECT builder: two-list column
picker, seven filter modes with their exact SQL traced from
on_m_filter_le_textEdited()'s switch statement (No filter/Not empty/
Empty/Contains/Does not contain/Is equal/Is not equal), group-by and
count, an "Edit SQL query" escape hatch, and named saved configurations.
Explicit about what it is not: not a general SQL client (bound to one
view, can't change the FROM even in raw-SQL mode), and not the same
column set as --export-bom, which was verified to hardcode its own fixed
list in cli_export.cpp rather than sharing this widget's choices.

Links the existing one-line Search & Replace mentions in features (all
three languages) to the new page. EN/FR/DE for both.
2026-09-12 07:29:35 +12:00
ispyisail c1b47381b2 Document DXF: two unrelated features reduced to one bullet each
sources/createdxf.*, sources/dxfpaintdevice.*, sources/dxf/dxftoelmt.*
total ~1,780 lines. The only wiki coverage was a single repeated bullet
-- 'DXF -- CAD format for collaboration' -- across features, faq and
user_manual, in all three languages, describing neither direction
accurately: it reads as one feature, and it's actually two that share
nothing but a file extension.

Export (File -> Export, alongside PDF/PNG/SVG, in-process) reuses every
item's existing paint() code through a custom QPaintEngine
(DxfPaintEngine) rather than a separate DXF renderer -- documented from
that class's own thorough header comment, including the real fidelity
table it specifies: rectangles and filled paths lose their fill (no
HATCH primitive in this DXF dialect), arcs become straight-line chords,
and images become position-preserving placeholder rectangles since DXF
has no raster entity here. No CLI verb exists for it, unlike PDF/PNG/SVG.

Import (element editor only, not the diagram editor -- File -> Import a
DXF file) is a symbol-authoring tool: it shells out to dxf2elmt, a
separate third-party program QET does not bundle, the same external-tool
pattern as qet_tb_generator already documented in api_reference. Traces
the actual call: , stdout read as .elmt XML, pushed
onto the element editor's undo stack as one operation.

Makes explicit what neither direction is: not a way to place a DXF
drawing on a folio, not round-trip safe (export's own limitations rule
that out before even considering the code is entirely separate), and not
a full CAD interchange path -- no layers, blocks or metadata, just
primitives.

Links the existing one-line mentions in features/faq/user_manual (all
three languages) to the new page instead of rewriting them, since they
are fine as list bullets. EN/FR/DE.
2026-09-12 06:56:32 +12:00
ispyisail 4854c314f0 Correct the automation docs: QET has no Python scripting and no plugins
api_reference stated "QElectroTech supports Python scripting" and
"QElectroTech supports plugins for deep integration", and told readers to
install plugins into ~/.local/share/QElectroTech/plugins/ and platform
equivalents. None of it exists: there is no QPluginLoader anywhere in
sources/, no plugin ABI, and every Python reference in the tree is the
launcher for qet_tb_generator -- a separate PyPI program QET starts as an
ordinary child process. QET never reads those plugin paths.

cli_reference had the mirror-image error, calling the shipped headless
export "Future CLI Features (QET 2.0)" and sending readers to the
scripting that does not exist. The FR/DE CLI pages additionally invented
a --dpi option and QET_PLUGIN_PATH / QET_ELEMENT_PATH, and documented an
argument order the parser cannot accept.

Rewrites api_reference (EN/FR/DE) around what is actually there: the 13
CLI verbs with their real positional syntax and exit codes, the real .qet
and .elmt XML (the old skeletons were invented -- no <diagrams> wrapper,
element has no id, uuid is an attribute), qet_tb_generator, and the C++
source. Adds a section naming what does not exist, so the claim does not
come back.

Also corrects the same claims where they had spread: features, history,
faq, user_manual (EN/FR/DE) and the sidebar.
2026-09-11 21:42:51 +12:00
ispyisail c0256bc0b6 Complete Tier 2: Features, Community, and Tips & Tricks
Features Page (comprehensive capabilities showcase):
- Open source/free, no vendor lock-in
- 8,200+ professional symbols
- Multi-industry support (electrical, HVAC, automation, solar, etc.)
- Automatic report generation (nomenclature, conductor lists)
- Professional documentation (configurable folios, titleblocks)
- Customizable elements and libraries
- Advanced connectivity (auto-numbering, cross-references)
- Multiple export formats (PDF, SVG, PNG, DXF)
- Comparison table vs commercial tools
- Real-world use cases across industries

Community Page (engagement and support):
- 3,747+ users, 21,856 forum posts
- Multilingual (25+ languages, 3 main: French, English, German)
- Forum structure with most active sections
- GitHub development center
- Ways to get involved (5 levels from user to maintainer)
- Community standards and values
- How to get help (forum, GitHub, FAQ, manual)
- Recognition and appreciation
- Welcome message and next steps

Tips & Tricks Page (power-user workflows):
- Wire drawing efficiency techniques
- Multi-select and copy/paste patterns
- Large project organization strategies
- Professional diagram best practices
- Custom element library creation
- Performance optimization for large diagrams
- Collaboration and version control workflows
- PDF/SVG/PNG export strategies
- Bills of materials and reporting
- Keyboard shortcuts mastery
- Industry-specific workflows (industrial, automotive, solar)
- Troubleshooting and recovery strategies
- Learning path from beginner to advanced

Research gathered from:
- qelectrotech.org official features
- GitHub capabilities documentation
- Forum analysis (2,959 topics, 21,856 posts)
- Real project examples (80+ schemas across industries)
- Community engagement patterns

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GtMZqGEiUMvDBqcFvVG2vb
2026-09-09 15:18:10 +12:00
ispyisail 6242ac4458 Redesign wiki home page for end-users; add structure and stub pages
- Reorganize Home.md with end-user-first structure
- Add Getting Started, User Documentation, Development sections
- Create stub pages for Quick Start Guide, User Manual, FAQ, Tips & Tricks
- Add developer stubs: Building, Contributing, Development Roadmap
- Add About section: History, Features, License, Community

The stubs provide structure and placeholders ready for content to be filled in.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GtMZqGEiUMvDBqcFvVG2vb
2026-09-09 14:56:29 +12:00