StarMirror/gitpitch
1
0
Fork 0
mirror of https://github.com/gitpitch/gitpitch.git synced 2024-04-18 07:30:55 +08:00
Code Issues Projects Releases Wiki Activity
master
gitpitch/docs/desktop/app-modes.md
gitpitch 245d53865b 4.0 release.
2020-09-29 07:45:10 +01:00

4.6 KiB
Raw Permalink Blame History

Desktop Modes

The desktop app supports three distinct modes of operation:

  1. Edit Mode for Development
  2. IDE Mode for Development
  3. Live Mode for Presenting

Edit Mode

Edit mode is the default mode when a slide deck is opened in the desktop app. When this mode is active the interface looks as follows:

Screenshot showing the desktop app in edit mode

In edit mode the desktop app exposes the following interface and behaviors:

  1. At the top you'll find a dedicated area for live previews of your slide deck.
  2. Within the preview area the grid layouts guide-lines are visible as a content positioning aid.
  3. In the center a navigation panel provides links to related tools and actions.
  4. At the bottom an embedded markdown editor is available for developing slide content.
  5. Any changes saved in the embedded editor are automatically reflected in the preview window.

The center navigation panel in edit mode supports the following links and actions:

  • :fas fa-home fa-fw: Return to the Deck Manager
  • :fas fa-download fa-fw: Open the Offline Publishing Manager
  • :fas fa-upload fa-fw: Open the Online Publishing Manager
  • :fas fa-save fa-fw: Save the latest Markdown
  • :fas fa-sync-alt fa-fw: Reload the current Slide Deck
  • :fas fa-external-link-square-alt fa-fw: Switch to Desktop IDE Mode
  • :fas fa-bolt fa-fw: Switch to Desktop Live Mode
  • :fas fa-question-circle fa-fw: Open the GitPitch Documentation

When working within the embedded markdown editor the following keyboard shortcuts are available:

  • Cmd-S or Ctrl-S: Save the latest Markdown
  • Cmd-Space or Ctrl-Space: Open Widget Syntax Help

When you save markdown within the editor the slide deck preview automatically refreshes. The Widget Syntax Help feature is context sensitive. Simply type the opening syntax for any widget then type Cmd-Space or Ctrl-Space. The syntax and associated properties for the corresponding widget will be displayed directly within the editor.

Screenshot showing the desktop app edit mode help

The above screenshow shows Widget Syntax Help within the embedded editor in action.

IDE Mode

!> In IDE mode use vim, emacs, sublime, vscode, intellij etc. to create your slide deck content.

If you prefer using your favorite IDE or editor to create, edit, and manage your presentation files while enjoying a live preview of your slide deck in a dedicated browser window, then IDE mode is for you:

Screenshot showing the desktop app in ide mode

In IDE mode the desktop app exposes the following interface and behaviors:

  1. IDE mode uses a dedicated browser window for live previews of your slide deck.
  2. Within the preview window the grid layouts guide-lines are visible as a content positioning aid.
  3. In the bottom-left of the browser window you'll find navigation links to other tools and actions.
  4. Any changes saved in your IDE or editor are automatically reflected in the preview window.

The bottom-left navigations in ide mode supports the following links and actions:

  • :fas fa-home fa-fw: Return to the Deck Manager
  • :fas fa-question-circle fa-fw: Show the Keyboard Shortcuts Help
  • :fas fa-download fa-fw: Open the Offline Publishing Manager
  • :fas fa-upload fa-fw: Open the Online Publishing Manager
  • :fas fa-bolt fa-fw: Switch to Desktop Live Mode

Live Mode

Live mode is used when you are ready to engage your audience and present your slide deck. This mode disables all features that are specific to development including live refresh and the display of grid layouts grid-lines.

Screenshot showing the desktop app in live mode

In live mode the desktop app exposes the following interface and behaviors:

  1. Live mode uses a dedicated browser window for live presentation of your slide deck.
  2. Within the live window the grid layouts guide-lines are hidden.
  3. The live window does not detect changes or refresh if your slide deck content changes.
  4. In the bottom-left of the browser window you'll find navigation links to other tools and actions.

The bottom-left navigations in ide mode supports the following links and actions:

  • :fas fa-home fa-fw: Return to the Deck Manager
  • :fas fa-laptop-code fa-fw: Switch to Desktop Edit Mode

When live mode is activated press the S key on your keyboard to launch the Speaker Window.