Skip to end of metadata
Go to start of metadata
Icon

This page description is for openBEB 2.8

openBEB 3

Icon

In openBEB 3, the CORE program and browser are operate modules! This documentation might be outdated (2016-04-01)

Most important CORE commands are described below. Note, for historocal reasons, somme commands were renamed and better structured. See this page for a list.

Metadata

The command metadata handles the the opening, initialization and saving of the metadata files. Related commands

  • For metadatamanipulation by macros see the commands !set and !get : Macro Metadata manipulation.
  • For sybchronization with the GUI, see CORE GUI commands.

Before triggering tghis command, the collection must be selected! See ???

Read

Reads the metadata for a collection or dataset. 

Usage

metedata::read::target

target:

  • Collection or dataset: Reads the collection or dataset metadata file 
  • DatasetProtocol: Reads the dataset protocol template from the extension folder. If not found, it takes the backup-file.
  • AttributeFile: Reads and parses the attribute file, if present. Puts the results in the the dataset metadata. Only perfomed the first time, when the dataset metadata did not exist before.

Example:

 

write

Reads the metadata for a collection or dataset

Usage

metedata::write::{collection or dataset}

Example:

 

GUI

Configures the GUI for various action and displays metadata.

DisplayEmbedded

Displayed the embedded metadata of a dataset.

Usage

GUI::DisplayEmbedded

DisplayFrameAnnotations

Display the frame metadata of a stacked dataset.

Usage

GUI::DisplayFrameAnnotations

DisplayProtocol

Display the protocol of a collection or dataset.

Usage

GUI::DisplayProtocol::{collection or dataset}

DisplayMetadata

Display the metadata of a collection or dataset. Use GUI: DisplayProtocol to show the protocol.

Usage

GUI::DisplayMetadata::{collection or dataset}

Adjustements

Adjusts the GUI for several actions.

Usage

GUI::Adjustments::TARGET[::value1::value2]

TARGET:

  • dataset: adjust the GUI for opening a dataset
  • mainWindow: layouts the window for the given size. If no values 1 & 2 are provided, the layout of the mainwindow is performed to fit the current panel size, e.g., after resizing the main front window. If value1 and valu2 are provided, the main window is resized accordingly. Value 1: Width, value2: Height.
  • bundle: Layouts the main window for attached bundles.

Example

Management

Commands to create collections, attaching bundles and browsing.

Bundle

Manipulates bundles: Bundles can be created, attached or detached.

Usage

management::bundle::command::option

Available commands:

  • Attach: attaches a bundle. Options:
    • ask: Opens a dialog to select a bundle existing in the file system
    • path: attaches the bundle 
  • New: Creates a new bundle. Options:
    • 1: Use GUI dialog
    • 0: Do it programmatically (NOT TESTED)
  • Detach: Detaches a bundle from the collection inventory
    • Option: Name of the bundle to remove

Collection

Manipulates collections.

Usage

management::collection::command::option

Available commands:

  • close: Closes the currently open collection
  • new: Creates a new collection. Options:
    • 1: Uses the graphical user interface.

 

 

 

  • No labels
Write a comment…