Check Keymap #101232

New Issue

Tobias Heinke · 2022-09-21T00:17:20+02:00

Tobias Heinke commented

2022-09-21 00:17:20 +02:00

Autodoc the keymap. Export the keymap from Blender and check the tool shortcuts identified by RNA (hyperlink) targets in the manual.

Ref-boxes ☑️🟦

 Reference directive with shortcuts in a list.

Modal ☑️🟦

 Definition list for modal maps.

Tool lists 🟦🟦

 Def. list with a tool each.

Add-ons 🟦🟦
Free 🟦🟦

  In continuous text.

Problems/ Decision needed:

Manual

• Call UI shortcuts (menu, panel, pie):
Add target and/or comment [or custom directive]:
wm.call_menu.TOPBAR_MT_file_new or bpy.types.TOPBAR_....
Comment with 'bpy' or 'api' prefix to distinguish/ isn't typo?
No caps?

• Duplicate tools:
Add comment or ignore.

• Tool lists identify:
Add targets (a lot, block or in-between) or
get display name or
fuzzy match ID name (last segment) or
wildcard e.g. any text editor tool text.* has shortcut (can't find swaps)

• Add-ons: target or comment:
e.g. Node wrangler node.nw_lazy_connect

Export

• ID name to display name
e.g. mesh.select_all or MESH_OT_select_all.bl_label -> '(De)select All'

• Enum index to display name:
e.g. .select_all.action = 2 -> 'Invert'

• Internal modal maps:
Confirm is inaccessible.
e.g. transform.vert_slide Flip - [x]. Modal map is from transform.

• Modal map owner (optimization):
Instead of find_modal. bl_owner_id is always empty.

Autodoc the keymap. Export the keymap from Blender and check the tool shortcuts identified by RNA (hyperlink) targets in the manual. 1. Ref-boxes ☑️🟦 ``` Reference directive with shortcuts in a list. ``` 2. Modal ☑️🟦 ``` Definition list for modal maps. ``` 3. Tool lists 🟦🟦 ``` Def. list with a tool each. ``` 4. Add-ons 🟦🟦 5. Free 🟦🟦 ``` In continuous text. ``` *Problems/ Decision needed:* **Manual** • Call UI shortcuts (menu, panel, pie): Add target and/or comment [or custom directive]: `wm.call_menu.TOPBAR_MT_file_new` or `bpy.types.TOPBAR_...`. Comment with 'bpy' or 'api' prefix to distinguish/ isn't typo? No caps? • Duplicate tools: Add comment or ignore. • Tool lists identify: Add targets (a lot, block or in-between) or get display name or fuzzy match ID name (last segment) or wildcard e.g. any text editor tool `text.*` has shortcut (can't find swaps) • Add-ons: target or comment: e.g. Node wrangler `node.nw_lazy_connect` **Export** • ID name to display name e.g. `mesh.select_all` or `MESH_OT_select_all.bl_label` -> '(De)select All' • Enum index to display name: e.g. `.select_all.action = 2` -> 'Invert' • Internal modal maps: Confirm is inaccessible. e.g. `transform.vert_slide` Flip - [x]. Modal map is from transform. • Modal map owner (optimization): Instead of `find_modal`. `bl_owner_id` is always empty.

Tobias Heinke self-assigned this 2022-09-21 00:17:20 +02:00

Tobias Heinke commented

2022-09-21 00:17:20 +02:00

Added subscribers: @Tobias, @Blendify