kicad-doc icon indicating copy to clipboard operation
kicad-doc copied to clipboard

Pl_Editor restructure

Open evanshultz opened this issue 9 years ago • 2 comments

https://github.com/KiCad/kicad-doc/blob/master/src/pl_editor/pl_editor.adoc jumps right into doing stuff after the intro. It feels abrupt. Later on we find the main window description, toolbar introduction, etc.

I propose this structure (with abbreviations for existing section names): -Introduction (include Files and Invoking sections, remove section about element type as it's below) --Basic properties --References and Coordinates -Interface (was Commands) --Main window (include Status bar) --Main toolbar --Left window --Right window ---Keyboard ---Mouse --Selection -Adding Elements --Creation (merge Context Menus) --Lines and rectanges --Text (include Page 1 option) ---Symbols ---Multi-line (including in page setup) ---Constraints --Bitmaps --Logos --Rotation --Repeat

The document flow will then follow: -talk about what Pl Editor is and does -brief description of page layout concepts -orientation to the Pl Editor interface -general interaction principles for all elements -adding and manipulating specific elements

To be clear, I'm talking about moving the existing sections around and not changing the content of the documentation. "Merging" or "including" above just means smash the content of those two sections together, with cleanup and reformatting to be a later step based on our discussion of GSIK where translation issues are a legitimate concern.

Agree? Disagree? Comments?

evanshultz avatar Jun 28 '16 15:06 evanshultz