You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koreader/frontend/ui/data/creoptions.lua

559 lines
26 KiB
Lua

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

local Device = require("device")
local Screen = Device.screen
local optionsutil = require("ui/data/optionsutil")
local _ = require("gettext")
local C_ = _.pgettext
-- Get font size numbers as a table of strings
local tableOfNumbersToTableOfStrings = function(numbers)
local t = {}
for i, v in ipairs(numbers) do
-- We turn 17.5 into 17<sup>5</sup>
table.insert(t, tostring(v%1==0 and v or (v-v%1)..""))
end
return t
end
local CreOptions = {
prefix = 'copt',
{
icon = "appbar.rotation",
options = {
{
name = "rotation_mode",
name_text = _("Rotation"),
toggle = {C_("Rotation", "⤹ 90°"), C_("Rotation", "↑ 0°"), C_("Rotation", "⤸ 90°"), C_("Rotation", "↓ 180°")},
alternate = false,
values = {Screen.ORIENTATION_LANDSCAPE_ROTATED, Screen.ORIENTATION_PORTRAIT, Screen.ORIENTATION_LANDSCAPE, Screen.ORIENTATION_PORTRAIT_ROTATED},
args = {Screen.ORIENTATION_LANDSCAPE_ROTATED, Screen.ORIENTATION_PORTRAIT, Screen.ORIENTATION_LANDSCAPE, Screen.ORIENTATION_PORTRAIT_ROTATED},
default_arg = 0,
current_func = function() return Device.screen:getRotationMode() end,
event = "SetRotationMode",
name_text_hold_callback = optionsutil.showValues,
},
{
name = "visible_pages",
name_text = _("Dual Pages"),
toggle = {_("off"), _("on")},
values = {1, 2},
default_value = 1,
args = {1, 2},
default_arg = 1,
event = "SetVisiblePages",
current_func = function()
-- If not in landscape mode, shows "1" as selected
if Device.screen:getScreenMode() ~= "landscape" then
return 1
end
-- if we return nil, ConfigDialog will pick the one from the
-- configurable as if we hadn't provided this 'current_func'
end,
enabled_func = function(configurable)
return Device.screen:getScreenMode() == "landscape" and
optionsutil.enableIfEquals(configurable, "view_mode", 0) -- "page"
end,
name_text_hold_callback = optionsutil.showValues,
help_text = _([[In landscape mode, you can choose to display one or two pages of the book on the screen.
Note that this may not be ensured under some conditions: in scroll mode, when a very big font size is used, or on devices with a very low aspect ratio.]]),
},
}
},
{
icon = "appbar.crop",
options = {
{
name = "h_page_margins",
name_text = _("L/R Margins"),
buttonprogress = true,
fine_tune = true,
values = {
DCREREADER_CONFIG_H_MARGIN_SIZES_SMALL,
DCREREADER_CONFIG_H_MARGIN_SIZES_MEDIUM,
DCREREADER_CONFIG_H_MARGIN_SIZES_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_X_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_XX_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_XXX_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_HUGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_X_HUGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_XX_HUGE,
},
default_pos = 2,
default_value = DCREREADER_CONFIG_H_MARGIN_SIZES_MEDIUM,
event = "SetPageHorizMargins",
args = {
DCREREADER_CONFIG_H_MARGIN_SIZES_SMALL,
DCREREADER_CONFIG_H_MARGIN_SIZES_MEDIUM,
DCREREADER_CONFIG_H_MARGIN_SIZES_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_X_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_XX_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_XXX_LARGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_HUGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_X_HUGE,
DCREREADER_CONFIG_H_MARGIN_SIZES_XX_HUGE,
},
delay_repaint = true,
name_text_hold_callback = optionsutil.showValuesHMargins,
},
{
name = "sync_t_b_page_margins",
name_text = _("Sync T/B Margins"),
toggle = {_("off"), _("on")},
values = {0, 1},
default_value = 0,
event = "SyncPageTopBottomMargins",
args = {false, true},
default_arg = false,
delay_repaint = true,
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Keep top and bottom margins synchronized.
- 'off' allows different top and bottom margins.
- 'on' keeps top and bottom margins locked, ensuring text is vertically centered in the page.
In the top menu → Settings → Status bar, you can choose whether the bottom margin applies from the bottom of the screen, or from above the status bar.]]),
},
{
name = "t_page_margin",
name_text = _("Top Margin"),
buttonprogress = true,
fine_tune = true,
values = {
DCREREADER_CONFIG_T_MARGIN_SIZES_SMALL,
DCREREADER_CONFIG_T_MARGIN_SIZES_MEDIUM,
DCREREADER_CONFIG_T_MARGIN_SIZES_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_X_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_XX_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_XXX_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_HUGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_X_HUGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_XX_HUGE,
},
default_pos = 3,
default_value = DCREREADER_CONFIG_T_MARGIN_SIZES_LARGE,
event = "SetPageTopMargin",
args = {
DCREREADER_CONFIG_T_MARGIN_SIZES_SMALL,
DCREREADER_CONFIG_T_MARGIN_SIZES_MEDIUM,
DCREREADER_CONFIG_T_MARGIN_SIZES_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_X_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_XX_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_XXX_LARGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_HUGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_X_HUGE,
DCREREADER_CONFIG_T_MARGIN_SIZES_XX_HUGE,
},
delay_repaint = true,
name_text_hold_callback = optionsutil.showValues,
},
{
name = "b_page_margin",
name_text = _("Bottom Margin"),
buttonprogress = true,
fine_tune = true,
values = {
DCREREADER_CONFIG_B_MARGIN_SIZES_SMALL,
DCREREADER_CONFIG_B_MARGIN_SIZES_MEDIUM,
DCREREADER_CONFIG_B_MARGIN_SIZES_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_X_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_XX_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_XXX_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_HUGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_X_HUGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_XX_HUGE,
},
default_pos = 3,
default_value = DCREREADER_CONFIG_B_MARGIN_SIZES_LARGE,
event = "SetPageBottomMargin",
args = {
DCREREADER_CONFIG_B_MARGIN_SIZES_SMALL,
DCREREADER_CONFIG_B_MARGIN_SIZES_MEDIUM,
DCREREADER_CONFIG_B_MARGIN_SIZES_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_X_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_XX_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_XXX_LARGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_HUGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_X_HUGE,
DCREREADER_CONFIG_B_MARGIN_SIZES_XX_HUGE,
},
delay_repaint = true,
name_text_hold_callback = optionsutil.showValues,
help_text = _([[In the top menu → Settings → Status bar, you can choose whether the bottom margin applies from the bottom of the screen, or from above the status bar.]]),
},
}
},
{
icon = "appbar.pageview",
options = {
{
name = "view_mode",
name_text = _("View Mode"),
toggle = {_("page"), _("continuous")},
values = {0, 1},
default_value = 0,
args = {"page", "scroll"},
default_arg = "page",
event = "SetViewMode",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[- 'page' mode splits the text into pages, at the most acceptable places (page numbers and the number of pages may change when you change fonts, margins, styles, etc.).
- 'continuous' mode allows you to scroll the text like you would in a web browser (the 'Page Overlap' setting is only available in this mode).]]),
},
{
name = "block_rendering_mode",
name_text = _("Render Mode"),
toggle = {_("legacy"), _("flat"), _("book"), _("web")},
values = {0, 1, 2, 3},
default_value = 2,
args = {0, 1, 2, 3},
default_arg = 2,
event = "SetBlockRenderingMode",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[
- 'legacy' uses original CR3 block rendering code.
- 'flat' ensures flat rendering with collapsing margins and accurate page breaks.
- 'book' additionally allows floats, but limits style support to avoid blank spaces and overflows.
- 'web' renders as web browsers do, allowing negative margins and possible page overflow.]]),
},
{
name = "render_dpi",
name_text = _("Zoom (dpi)"),
more_options = true,
more_options_param = {
value_hold_step = 20,
},
toggle = {_("off"), "48", "96¹¹", "167", "212", "300"},
values = {0, 48, 96, 167, 212, 300},
default_value = 96,
args = {0, 48, 96, 167, 212, 300},
event = "SetRenderDPI",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Sets the DPI used to scale absolute CSS units and images:
- off: ignore absolute units (old engine behavior).
- 96¹¹: at 96 DPI, 1 CSS pixel = 1 screen pixel and images are rendered at their original dimensions.
- other values scale CSS absolute units and images by a factor (300 DPI = x3, 48 DPI = x0.5)
Using your device's actual DPI will ensure 1 cm in CSS actually translates to 1 cm on screen.
Note that your selected font size is not affected by this setting.]]),
},
{
name = "line_spacing",
name_text = _("Line Spacing"),
buttonprogress = true,
values = {
DCREREADER_CONFIG_LINE_SPACE_PERCENT_X_TINY,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_TINY,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XX_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_X_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_L_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_L_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XL_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XXL_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_LARGE,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_X_LARGE,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XX_LARGE,
},
default_pos = 7,
default_value = DCREREADER_CONFIG_LINE_SPACE_PERCENT_MEDIUM,
more_options = true,
more_options_param = {
value_min = 50,
value_max = 300,
value_step = 1,
value_hold_step = 5,
},
event = "SetLineSpace",
args = {
DCREREADER_CONFIG_LINE_SPACE_PERCENT_X_TINY,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_TINY,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XX_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_X_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_L_SMALL,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_L_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XL_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XXL_MEDIUM,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_LARGE,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_X_LARGE,
DCREREADER_CONFIG_LINE_SPACE_PERCENT_XX_LARGE,
},
name_text_hold_callback = optionsutil.showValues,
-- used by showValues
name_text_true_values = true,
show_true_value_func = function(val) -- add "%"
return string.format("%d%%", val)
end,
},
}
},
{
icon = "appbar.textsize",
options = {
{
name = "font_size",
item_text = tableOfNumbersToTableOfStrings(DCREREADER_CONFIG_FONT_SIZES),
item_align_center = 1.0,
spacing = 15,
item_font_size = DCREREADER_CONFIG_FONT_SIZES,
values = DCREREADER_CONFIG_FONT_SIZES,
default_value = DCREREADER_CONFIG_DEFAULT_FONT_SIZE,
args = DCREREADER_CONFIG_FONT_SIZES,
event = "SetFontSize",
},
{
name = "font_fine_tune",
name_text = _("Font Size"),
toggle = Device:isTouchDevice() and {_("decrease"), _("increase")} or nil,
item_text = not Device:isTouchDevice() and {_("decrease"), _("increase")} or nil,
more_options = true,
more_options_param = {
value_min = 12,
value_max = 255,
value_step = 0.5,
precision = "%.1f",
value_hold_step = 4,
name = "font_size",
name_text = _("Font Size"),
event = "SetFontSize",
},
values = {},
event = "ChangeSize",
args = {"decrease", "increase"},
alternate = false,
name_text_hold_callback = function(configurable, __, prefix)
local opt = {
name = "font_size",
name_text = _("Font Size"),
}
optionsutil.showValues(configurable, opt, prefix)
end,
},
{
name = "word_spacing",
name_text = _("Word Spacing"),
more_options = true,
more_options_param = {
name = "word_spacing",
name_text = _("Word spacing"),
info_text = _([[Set word spacing percentages:
- how much to scale the width of each space character from its regular width,
- by how much some of them can then be reduced to make more words fit on a line.]]),
left_text = _("Scaling %"),
left_min = 10,
left_max = 500,
left_step = 1,
left_hold_step = 10,
right_text = _("Reduction %"),
right_min = 25,
right_max = 100,
right_step = 1,
right_hold_step = 10,
event = "SetWordSpacing",
},
toggle = {_("small"), _("medium"), _("large")},
values = {
DCREREADER_CONFIG_WORD_SPACING_SMALL,
DCREREADER_CONFIG_WORD_SPACING_MEDIUM,
DCREREADER_CONFIG_WORD_SPACING_LARGE,
},
default_value = DCREREADER_CONFIG_WORD_SPACING_MEDIUM,
args = {
DCREREADER_CONFIG_WORD_SPACING_SMALL,
DCREREADER_CONFIG_WORD_SPACING_MEDIUM,
DCREREADER_CONFIG_WORD_SPACING_LARGE,
},
event = "SetWordSpacing",
help_text = _([[Tells the rendering engine by how much to scale the width of each 'space' character in the text from its regular width, and by how much it can additionally reduce them to make more words fit on a line (100% means no reduction).]]),
name_text_hold_callback = optionsutil.showValues,
name_text_true_values = true,
show_true_value_func = function(val)
return string.format("%d%%, %d%%", val[1], val[2])
end,
},
{
name = "word_expansion",
name_text = _("Word Expansion"),
more_options = true,
more_options_param = {
value_min = 0,
value_max = 20,
value_step = 1,
value_hold_step = 4,
name = "word_expansion",
name_text = _("Max word expansion"),
info_text = _([[Set max word expansion as a % of the font size.]]),
event = "SetWordExpansion",
},
toggle = {_("none"), _("some"), _("more")},
values = {
DCREREADER_CONFIG_WORD_EXPANSION_NONE,
DCREREADER_CONFIG_WORD_EXPANSION_SOME,
DCREREADER_CONFIG_WORD_EXPANSION_MORE,
},
default_value = DCREREADER_CONFIG_WORD_EXPANSION_NONE,
args = {
DCREREADER_CONFIG_WORD_EXPANSION_NONE,
DCREREADER_CONFIG_WORD_EXPANSION_SOME,
DCREREADER_CONFIG_WORD_EXPANSION_MORE,
},
event = "SetWordExpansion",
help_text = _([[On justified lines having too wide spaces, allow distributing the excessive space into words by expanding them with letter spacing. This sets the max allowed letter spacing as a % of the font size.]]),
name_text_hold_callback = optionsutil.showValues,
name_text_true_values = true,
show_true_value_func = function(val)
return string.format("%d%%", val)
end,
},
}
},
{
icon = "appbar.contrast",
options = {
{
name = "font_weight",
name_text = _("Font Weight"),
toggle = {_("regular"), _("bold")},
values = {0, 1},
default_value = 0,
args = {0, 1},
event = "ToggleFontBolder",
name_text_hold_callback = optionsutil.showValues,
},
{
name = "font_gamma",
name_text = _("Contrast"),
buttonprogress = true,
default_value = 15, -- gamma = 1.0
default_pos = 2,
values = {10, 15, 25, 30, 36, 43, 49, 56},
event = "SetFontGamma",
args = {10, 15, 25, 30, 36, 43, 49, 56},
-- gamma values for these indexes are:
labels = {0.8, 1.0, 1.45, 1.90, 2.50, 4.0, 8.0, 15.0},
name_text_hold_callback = optionsutil.showValues,
more_options = true,
more_options_param = {
-- values table taken from crengine/crengine/Tools/GammaGen/gammagen.cpp
value_table = { 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.65, 0.7, 0.75, 0.8, 0.85, 0.9,
0.95, 0.98, 1, 1.02, 1.05, 1.1, 1.15, 1.2, 1.25, 1.3, 1.35, 1.4, 1.45,
1.5, 1.6, 1.7, 1.8, 1.9, 2, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9,
3, 3.5, 4, 4.5, 5, 5.5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 };
args_table = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12,
13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25,
26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 29, 40,
41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56 };
value_step = 1,
},
},
{
name = "font_hinting",
name_text = _("Font Hinting"),
toggle = {_("off"), _("native"), _("auto")},
values = {0, 1, 2},
default_value = 2,
args = {0, 1, 2},
event = "SetFontHinting",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Font hinting is the process by which fonts are adjusted for maximum readability on the screen's pixel grid.
- off: no hinting.
- native: use the font internal hinting instructions.
- auto: use FreeType's hinting algorithm, ignoring font instructions.]]),
},
{
name = "font_kerning",
name_text = _("Font Kerning"),
toggle = {_("off"), _("fast"), _("good"), _("best")},
values = {0, 1, 2, 3},
default_value = 3,
args = {0, 1, 2, 3},
event = "SetFontKerning",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Font kerning is the process of adjusting the spacing between individual letter forms, to achieve a visually pleasing result.
- off: no kerning.
- fast: use FreeType's kerning implementation (no ligatures).
- good: use HarfBuzz's light kerning implementation (faster than full but no ligatures and limited support for non-western scripts)
- best: use HarfBuzz's full kerning implementation (slower, but may support ligatures with some fonts; also needed to properly display joined arabic glyphs and some other scripts).
(Font Hinting may need to be adjusted for the best result with either kerning implementation.)]]),
},
}
},
{
icon = "appbar.settings",
options = {
{
name = "status_line",
name_text = _("Alt Status Bar"),
toggle = {_("off"), _("on")},
values = {1, 0},
default_value = 1, -- Note that 1 means KOReader (bottom) status bar only
args = {1, 0},
default_arg = 1,
event = "SetStatusLine",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Enable or disable the rendering engine alternative status bar at the top of the screen (this status bar can't be customized).
Whether enabled or disabled, KOReader's own status bar at the bottom of the screen can be toggled by tapping. The items displayed can be customized via the main menu.]]),
},
{
name = "embedded_css",
name_text = _("Embedded Style"),
toggle = {_("off"), _("on")},
values = {0, 1},
default_value = 1,
args = {false, true},
default_arg = nil,
event = "ToggleEmbeddedStyleSheet",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Enable or disable publisher stylesheets embedded in the book.
(Note that less radical changes can be achieved via Style Tweaks in the main menu.)]]),
},
{
name = "embedded_fonts",
name_text = _("Embedded Fonts"),
toggle = {_("off"), _("on")},
values = {0, 1},
default_value = 1,
args = {false, true},
default_arg = nil,
event = "ToggleEmbeddedFonts",
enabled_func = function(configurable)
return optionsutil.enableIfEquals(configurable, "embedded_css", 1)
end,
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Enable or disable the use of the fonts embedded in the book.
(Disabling the fonts specified in the publisher stylesheets can also be achieved via Style Tweaks in the main menu.)]]),
},
{
name = "smooth_scaling",
name_text = _("Image Scaling"),
toggle = {_("fast"), _("best")},
values = {0, 1},
default_value = 0,
args = {false, true},
default_arg = nil,
event = "ToggleImageScaling",
name_text_hold_callback = optionsutil.showValues,
help_text = _([[- 'fast' uses a fast but inaccurate scaling algorithm when scaling images.
- 'best' switches to a more costly but vastly more pleasing and accurate algorithm.]]),
},
{
name = "nightmode_images",
name_text = _("Invert Images"),
toggle = {_("on"), _("off")},
values = {1, 0},
default_value = 1,
args = {true, false},
default_arg = nil,
event = "ToggleNightmodeImages",
show_func = function() return Device.screen.night_mode end,
name_text_hold_callback = optionsutil.showValues,
help_text = _([[Disable the automagic inversion of images when nightmode is enabled. Useful if your book contains mainly inlined mathematical content or scene break art.]]),
},
},
},
}
return CreOptions