Link

Contents

Table of contents

  1. Concepts
  2. Start/Resume Sandbox Mode
  3. Version Control
  4. Stop Sandbox Mode
  5. Where To Go from Here?

Concepts

  • “Sandbox Mode” is an offline mode where the annotations are saved locally in your project’s directory.
  • The annotations added in an Offline workspace are not synced with Predlab.
  • You can add the annotations to source control to make them available with your team mates.

Start/Resume Sandbox Mode

To start an offline workspace for a project

  1. Open a project as you normally do for your IDE
  2. Choose “Start Offline Session” from Predlab Tool Window.

Predlab Tab

You can now start adding annotations to your project. The Sandbox Mode View will be displayed once the session is started.

Predlab Tab

PRO TIP

You can list and jump to your annotations from the annotations file tree.


Version Control

The annotations added in an Offline workspace are not synced with Predlab.

To make your annotations available with your project, you can add the local database that Predlab creates to your Source Control System.

Predlab stores the annotations in your project’s home directory under predlab/localData.db

Predlab Tab

Once you add the localData file to your source control, your team mates can view the annotations when they checkout the project.


Stop Sandbox Mode

To exit Sandbox Mode, simply click the Logout button on the Sandbox view.

Predlab Tab

You can resume your session anytime by clicking “Start Offline Session”.

Where To Go from Here?

That is it! Now you can create a workspace for your project.