Skip to content

quickstart.md

Latest commit

 

History

History
48 lines (34 loc) · 2.58 KB

quickstart.md

File metadata and controls

48 lines (34 loc) · 2.58 KB
Raw

Quickstart

For a full tour of menus, tools, and behaviour, read the User manual first. This page is a minimal hands-on sequence.

The steps below assume you have started the application and will load a Navit configuration that contains at least one <osd> element (for example a copy of tests/golden/minimal_navit.xml from this repository).

  1. Open a configuration
    Choose File → Open… and select your navit.xml (or another root config). The canvas shows each OSD item as a selectable rectangle; the title bar shows navit-osd-editor — <filename>.

  2. Move an OSD element
    Click an item on the canvas and drag it. Release to commit the move. Coordinates update in the backing XML through the undo stack.

  3. Zoom (optional)
    Use Ctrl++ / Ctrl+= and Ctrl+-, the zoom buttons on the toolbar, or Ctrl + scroll wheel with the canvas focused. Ctrl+0 resets to 100% scale.

  4. Delete an OSD item (optional)
    Select one or more items (rubber-band on empty canvas for several). With the canvas focused, press Delete or Backspace, or use Edit → Delete selected OSD.

  5. Change a property
    With exactly one item selected, use the Properties dock to edit attributes (type, enabled flag, non-coordinate fields). Coordinate spin boxes reflect parsed x, y, w, h values.

  6. Internal menu (if present)
    If the file has <gui type="internal">, use the Internal menu dock at the bottom to browse screens and preview. Otherwise the dock explains that the left list is OSD types for the canvas, not the Settings menu.

  7. Save
    Choose File → Save to write the merged configuration (root XML and any fragment files the serializer manages). The title bar * dirty indicator clears when the undo stack is clean after a successful save.

Keyboard shortcuts

Shortcut Action
Ctrl+Z Undo
Ctrl+Shift+Z / Ctrl+Y Redo (platform-dependent)
Ctrl+S Save
Ctrl+W Close window (unsaved changes prompt if dirty)
Ctrl++ / Ctrl+= Zoom in (canvas focused for wheel)
Ctrl+- Zoom out
Ctrl+0 Actual size (100% zoom)
Delete / Backspace Delete selected OSD (canvas focused)

Exact redo bindings follow the standard Qt shortcuts on your platform.

Next steps

  • User manual — complete usage guide.
  • OSD editor — canvas, grid, anchors, percent coordinates, bitmask preview.
  • Menu editor — tree, hierarchy, command scan.
  • Export — OSD-only save, xi:include export, backups.