Child pages
  • SettingStore
Skip to end of metadata
Go to start of metadata

Introduction

Most of Omea-global settings are stored in the Omea SettingStore in the SectionKeyValue fashion. While some of them reflect the user-editable options, as found in the Tools -> Options dialog, or persist the window sizes, others control the way Omea behaves, formats, displays, and so on, and may not have an editing UI that allows to change them directly. This page lists some of those settings and tells you how you can change them to gain advanced control over the Omea application.

A Section denotes a group of settings that have similar purpose or are applicable to the same context. For example, the "NewspaperView()" section contains options that apply to the newspaper behavior, and "Clippings" controls the creation and behavior of the clippings.

A Key is a name of a particular setting in a Section, and Value is its value. Each Section is a collection of unique keys, and there cannot be two keys with the same name in one section. Each Key has a type (string, integer, boolean, etc), which means that all the valid values for this key must be of this type.

Most of the settings apply to both Omea Reader and Omea Pro. If not, there should be a note in the description of such a setting.

How to Change the Settings

Warning!

Icon

Take care editing the Omea options!

Setting them to incorrect values may cause Omea to function incorrectly, degrade the performance, or even impose your computer to a security risk. Be sure you know what you're doing.

The SettingStore is persisted in a form of a standard INI-file named "OmniaMea.ini". This file can be found in the Omea Database folder, as specified at Tools -> Options -> Paths -> Database Path. If you cannot run Omea, check the HKEY_CURRENT_USER\Software\JetBrains\Omea\DbPath Registry value for Omea Pro, and HKEY_CURRENT_USER\Software\JetBrains\Omea Reader\DbPath for Omea Reader. By default, it points to the %%LOCALAPPDATA%%\JetBrains\Omea folder (for example, c:\Documents and Settings\Username\Local Settings\Application Data\JetBrains\Omea).

Each section starts with the section header, and all the key-value pairs that follow it, up to the next section header or file end, belong to this section. Each key-value pair occupies a single line, and a key is separated from its value with an equality sign (=). Empty lines are ignored.

String values are not enclosed in quotes. Integer values, be they positive or negative, are written "as is". Boolean values are coerced to integers, where a zero value, 0, in the INI file means False, while any nonzero value, preferrably 1, means True.

Example

Legend

The default table template is:

Section

Name

Value

Default

Flag

Description

<Section>

<Value Name>

<Value Type, or list of possible values>

<Default Value, if hardcoded>

Flag values are:

  • I = Internal (cannot be changed explicitly from the UI)
  • D = Debug (introduced for debug purposes, usually combined with I)
  • H = Hack (option provided for better control over some fine tuning parameter, that cannot be edited from the UI, and it's not quite sensitive to the application whether it's an option or a hard-coded value). Incapsulates the I flag. | <Description and Comments>

Settings

Note

Icon

As a safety measure, some of the potentionaly dangerous settings have been excluded from the public spec.

They can be found in an internal Omea space, on the Debug Setting Store page.

General Section

Section

Name

Value

Default

Flag

Description

General

AllowBrowserDde

boolean

true

I

Controls whether the first attempt to open a Web link in a new external window of the default browser should be done thru DDE.
If True, then Registry is checked for a record about the DDE name of the default browser, and an attempt is made to establish a DDE conversation and issue the command. If the name is not available, the default "Iexplore" name is used. If DDE fails, the link is opened with Shell Run.
If False, then only Shell Run is used to open the link.

Clippings Section

Section

Name

Value

Default

Flag

Description

Clippings

AnnotationEditWindowHeight

positiveInteger

N/A

I

Clippings edit window has an editbox for Annotation with customizeable height, which is saved here. The default is taken from the form designer setting.

ResourceEditWindow Section

Section

Name

Value

Default

Flag

Description

ResourceEditWindow

<ResourceType>.Left

positiveInteger

N/A

I

Specifies the x-coordinate of the resource edit window for the specific resource type. The default is taken at first run.

ResourceEditWindow

<ResourceType>.Top

positiveInteger

N/A

I

Specifies the y-coordinate of the resource edit window for the specific resource type. The default is taken at first run.

ResourceEditWindow

<ResourceType>.Width

positiveInteger

N/A

I

Specifies the width of the resource edit window for the specific resource type. The default is taken at first run, also affected by the AbstractEditPane's width.

ResourceEditWindow

<ResourceType>.Height

positiveInteger

N/A

I

Specifies the height of the resource edit window for the specific resource type. The default is taken at first run, also affected by the AbstractEditPane's height.

Formatting Section

Section

Name

Value

Default

Flag

Description

Formatting

MinimumWrapWidth

positiveInteger

50

H

Minimum width of the line that can be considered a part of the wrapped paragraph. Also implicitly controls the maximum width over which a line is considered to be a whole paragraph and is not concatenated with the others.

Newspaper Sections Family

"Newspaper()" - the common newspaper section

Section

Name

Value

Default

Flag

Description

Newspaper()

MinSpaceAfterItemWhenJumping

positiveInteger

30

H

When jumping to an item while doing goto-next or goto-previous, amount of visible space to be left after the item (in the direction of a jump).

Newspaper()

MinRelationOfSpaceAfterToSpaceBefore,Numerator

positiveInteger

1

H

When jumping to an item while doing goto-next or goto-previous, the minimum value for visible space after the item divided on the visible space before the item. An integer numerator of the fraction.

Newspaper()

MinRelationOfSpaceAfterToSpaceBefore,Denomenator

positiveInteger

3

H

When jumping to an item while doing goto-next or goto-previous, the minimum value for visible space after the item divided on the visible space before the item. An integer denomenator of the fraction.

Newspaper()

DesiredRelationOfSpaceAfterToSpaceBefore,Numerator

positiveInteger

3

H

When jumping to an item while doing goto-next or goto-previous, the desired (to be established when minimum is not respected) value for visible space after the item divided on the visible space before the item. An integer numerator of the fraction.

Newspaper()

DesiredRelationOfSpaceAfterToSpaceBefore,Denomenator

positiveInteger

1

H

When jumping to an item while doing goto-next or goto-previous, the desired (to be established when minimum is not respected) value for visible space after the item divided on the visible space before the item. An integer denomenator of the fraction.

Newspaper()

ScrollFactor

positiveInteger

2

H

When newspaper is being scrolled smoothly, there's source pos and target pos. The scrolling is done so that distance between them is reduced ScrollFactor times on each step.

Newspaper()

MinScrollStep

positiveInteger

10

H

The minimum scrolling step. If the desired step of smooth scrolling is smaller than that, then scrolling finishes in an instant by jumping to the target position.

Newspaper()

ShowItemNumbers

boolean

false

DH

Enables display of additional debug information, such as item numbers & IDs, numer of items per page, etc.

Newspaper()

AllowSmoothScrolling

boolean

true

H

Defines whether smooth scrolling is allowed or not.

Newspaper()

AllowAutoMarkAsRead

boolean

true

H

Determines whether auto-marking as read by timeout is allowed in the newspaper. Is ANDed with the global Omea settings.

Newspaper()

MarkAsReadOnGotoNext

boolean

true

H

Determines whether items get marked as read when selection jumps to the next/prev item from them. This setting does not respect the Omea-global option, which behavior is by design.

Newspaper()

AllowHoverSelection

boolean

true

 

Defines whether the items are selected by mouse hover.

Newspaper()

HoverSelectionTimeout

positiveInteger

500

H

Timeout for the hover selection - amount of time between mouse-entering the item and setting selection to it, in milliseconds.

Newspaper()

ScrollTimerInterval

positiveInteger

100

H

Interval for the scrolling timer, in milliseconds.

Newspaper()

BarAtBottom

boolean

true

H

Whether the Newspaper Bar (view filtering and page navigation) appears at the bottom (true) or at the top (false) of newspaper.

"Newspaper(…)" - resource-types-dependent section

Here and below the ellipsis (…) stands for a lexicographically-ordered comma-separated list of string representations of resource types displayed by this newspaper, eg "Newspaper(Fragment,RSSItem)".
Note that this also applies to the case when there are no resources to be displayed and thus no resource types, in which case the common section (see above) is used.

Section

Name

Value

Default

Flag

Description

Newspaper(…)

ItemsPerPage

positiveInteger

10

 

MRU setting for the number of items per page.

Newspaper(…)

MruViewId

integer

-1

 

MRU filtering view represented by its resource's Omea ID, or "-1" if the virtual "All Items" view was selected.

Section

Name

Value

Default

Flag

Description

SearchBar

CustomWidth

positiveInteger

300

 

Width of the Search Bar control.

  • No labels