Commit | Line | Data |
---|---|---|
08fe2e33 NR |
1 | package be.nikiroo.fanfix.bundles; |
2 | ||
3 | import be.nikiroo.utils.resources.Meta; | |
ce788468 | 4 | import be.nikiroo.utils.resources.Meta.Format; |
08fe2e33 NR |
5 | |
6 | /** | |
7 | * The configuration options. | |
8 | * | |
9 | * @author niki | |
10 | */ | |
ce788468 | 11 | @SuppressWarnings("javadoc") |
08fe2e33 | 12 | public enum Config { |
ce788468 | 13 | @Meta(description = "language (example: en-GB, fr-BE...) or nothing for default system language", format = Format.LOCALE, info = "Force the language (can be overwritten again with the env variable $LANG)") |
08fe2e33 | 14 | LANG, // |
c1873e56 NR |
15 | @Meta(description = "reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)", format = Format.FIXED_LIST, list = { |
16 | "CLI", "GUI", "TUI" }, info = "Select the default reader to use to read stories") | |
3727aae2 | 17 | READER_TYPE, // |
e604986c NR |
18 | @Meta(format = Format.COMBO_LIST, list = { "INFO_TEXT", "EPUB", "HTML", |
19 | "TEXT" }, info = "One of the known output type", description = "The type of output for the Local Reader for non-images documents") | |
20 | NON_IMAGES_DOCUMENT_TYPE, // | |
21 | @Meta(format = Format.COMBO_LIST, list = { "CBZ", "HTML" }, description = "The type of output for the Local Reader for images documents") | |
22 | IMAGES_DOCUMENT_TYPE, // | |
ce788468 | 23 | @Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)") |
08fe2e33 | 24 | CACHE_DIR, // |
ce788468 | 25 | @Meta(description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh") |
08fe2e33 | 26 | CACHE_MAX_TIME_CHANGING, // |
ce788468 | 27 | @Meta(description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh") |
08fe2e33 | 28 | CACHE_MAX_TIME_STABLE, // |
ce788468 | 29 | @Meta(description = "string", info = "The user-agent to use to download files") |
08fe2e33 | 30 | USER_AGENT, // |
ce788468 | 31 | @Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to get the default story covers") |
08fe2e33 | 32 | DEFAULT_COVERS_DIR, // |
ce788468 | 33 | @Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store the library") |
08fe2e33 | 34 | LIBRARY_DIR, // |
ce788468 | 35 | @Meta(description = "boolean", format = Format.BOOLEAN, info = "Show debug information on errors") |
08fe2e33 | 36 | DEBUG_ERR, // |
a8209dd0 NR |
37 | @Meta(description = "boolean", format = Format.BOOLEAN, info = "Show debug trace information") |
38 | DEBUG_TRACE, // | |
ce788468 NR |
39 | @Meta(description = "image format", format = Format.COMBO_LIST, list = { |
40 | "PNG", "JPG", "BMP" }, info = "Image format to use for cover images") | |
08fe2e33 | 41 | IMAGE_FORMAT_COVER, // |
ce788468 NR |
42 | @Meta(description = "image format", format = Format.COMBO_LIST, list = { |
43 | "PNG", "JPG", "BMP" }, info = "Image format to use for content images") | |
08fe2e33 | 44 | IMAGE_FORMAT_CONTENT, // |
ce788468 | 45 | @Meta(group = true) |
08fe2e33 | 46 | LATEX_LANG, // |
ce788468 | 47 | @Meta(description = "LaTeX output language: English", info = "LaTeX full name") |
08fe2e33 | 48 | LATEX_LANG_EN, // |
ce788468 | 49 | @Meta(description = "LaTeX output language: French", info = "LaTeX full name") |
08fe2e33 | 50 | LATEX_LANG_FR, // |
ce788468 | 51 | @Meta(description = "other 'by' prefixes before author name, used to identify the author", array = true) |
08fe2e33 | 52 | BYS, // |
ce788468 | 53 | @Meta(description = "List of languages codes used for chapter identification (should not be changed)", array = true, info = "EN,FR") |
08fe2e33 | 54 | CHAPTER, // |
ce788468 | 55 | @Meta(description = "Chapter identification String: English", info = "used to identify a starting chapter in text mode") |
08fe2e33 | 56 | CHAPTER_EN, // |
ce788468 | 57 | @Meta(description = "Chapter identification String: French", info = "used to identify a starting chapter in text mode") |
08fe2e33 | 58 | CHAPTER_FR, // |
ce788468 | 59 | @Meta(description = "Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)") |
6e06d2cc | 60 | LOGIN_YIFFSTAR_USER, // |
ce788468 | 61 | @Meta(description = "Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)", format = Format.PASSWORD) |
6e06d2cc | 62 | LOGIN_YIFFSTAR_PASS, // |
ce788468 | 63 | @Meta(description = "If the last update check was done at least that many days, check for updates at startup (-1 for 'no checks' -- default is 1 day)", format = Format.INT) |
315f14ae NR |
64 | UPDATE_INTERVAL, // |
65 | @Meta(description = "An API key required to create a token from FimFiction", format = Format.STRING) | |
66 | LOGIN_FIMFICTION_APIKEY_CLIENT_ID, // | |
67 | @Meta(description = "An API key required to create a token from FimFiction", format = Format.PASSWORD) | |
68 | LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, // | |
a8209dd0 | 69 | @Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping (default is false, use API if token or ID present)", format = Format.BOOLEAN) |
315f14ae NR |
70 | LOGIN_FIMFICTION_APIKEY_FORCE_HTML, // |
71 | @Meta(description = "A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)", format = Format.PASSWORD) | |
72 | LOGIN_FIMFICTION_APIKEY_TOKEN, // | |
08fe2e33 | 73 | } |