Commit | Line | Data |
---|---|---|
08fe2e33 NR |
1 | package be.nikiroo.fanfix.bundles; |
2 | ||
3 | import be.nikiroo.utils.resources.Meta; | |
4 | ||
5 | /** | |
6 | * The configuration options. | |
7 | * | |
8 | * @author niki | |
9 | */ | |
10 | public enum Config { | |
b42117f1 | 11 | @Meta(what = "language (example: en-GB, fr-BE...) or nothing for default system language", where = "", format = "Locale|''", info = "Force the language (can be overwritten again with the env variable $LANG)") |
08fe2e33 | 12 | LANG, // |
b42117f1 | 13 | @Meta(what = "reader type (CLI = simple output to console, LOCAL = use local system file handler)", where = "", format = "'CLI'|'LOCAL'", info = "Select the default reader to use to read stories") |
3727aae2 | 14 | READER_TYPE, // |
b42117f1 | 15 | @Meta(what = "absolute path, $HOME variable supported, / is always accepted as dir separator", where = "", format = "Directory", info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)") |
08fe2e33 | 16 | CACHE_DIR, // |
b42117f1 | 17 | @Meta(what = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", where = "", 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 | 18 | CACHE_MAX_TIME_CHANGING, // |
b42117f1 | 19 | @Meta(what = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", where = "", 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 | 20 | CACHE_MAX_TIME_STABLE, // |
b42117f1 | 21 | @Meta(what = "string", where = "", format = "String", info = "The user-agent to use to download files") |
08fe2e33 | 22 | USER_AGENT, // |
b42117f1 | 23 | @Meta(what = "absolute path, $HOME variable supported, / is always accepted as dir separator", where = "", format = "Directory", info = "The directory where to get the default story covers") |
08fe2e33 | 24 | DEFAULT_COVERS_DIR, // |
b42117f1 | 25 | @Meta(what = "absolute path, $HOME variable supported, / is always accepted as dir separator", where = "", format = "Directory", info = "The directory where to store the library") |
08fe2e33 | 26 | LIBRARY_DIR, // |
b42117f1 | 27 | @Meta(what = "boolean", where = "", format = "'true'|'false'", info = "Show debug information on errors") |
08fe2e33 | 28 | DEBUG_ERR, // |
b42117f1 | 29 | @Meta(what = "image format", where = "", format = "'PNG'|JPG'|'BMP'", info = "Image format to use for cover images") |
08fe2e33 | 30 | IMAGE_FORMAT_COVER, // |
b42117f1 | 31 | @Meta(what = "image format", where = "", format = "'PNG'|JPG'|'BMP'", info = "Image format to use for content images") |
08fe2e33 | 32 | IMAGE_FORMAT_CONTENT, // |
b42117f1 | 33 | // This key is only present to allow access to suffixes, so no Meta |
08fe2e33 | 34 | LATEX_LANG, // |
b42117f1 | 35 | @Meta(what = "LaTeX output language", where = "LaTeX", format = "String", info = "LaTeX full name for English") |
08fe2e33 | 36 | LATEX_LANG_EN, // |
b42117f1 | 37 | @Meta(what = "LaTeX output language", where = "LaTeX", format = "String", info = "LaTeX full name for French") |
08fe2e33 | 38 | LATEX_LANG_FR, // |
b42117f1 | 39 | @Meta(what = "other 'by' prefixes before author name", where = "", format = "comma-separated list|String", info = "used to identify the author") |
08fe2e33 | 40 | BYS, // |
b42117f1 | 41 | @Meta(what = "Chapter identification languages", where = "", format = "comma-separated list|String", info = "used to identify a starting chapter in text mode") |
08fe2e33 | 42 | CHAPTER, // |
b42117f1 | 43 | @Meta(what = "Chapter identification string", where = "String", format = "", info = "used to identify a starting chapter in text mode") |
08fe2e33 | 44 | CHAPTER_EN, // |
b42117f1 | 45 | @Meta(what = "Chapter identification string", where = "String", format = "", info = "used to identify a starting chapter in text mode") |
08fe2e33 | 46 | CHAPTER_FR, // |
b42117f1 | 47 | @Meta(what = "Login information", where = "", format = "String", info = "used to login on YiffStar to have access to all the stories (should not be necessary anymore)") |
6e06d2cc | 48 | LOGIN_YIFFSTAR_USER, // |
b42117f1 | 49 | @Meta(what = "Login information", where = "", format = "Password", info = "used to login on YiffStar to have access to all the stories (should not be necessary anymore)") |
6e06d2cc | 50 | LOGIN_YIFFSTAR_PASS, // |
b42117f1 NR |
51 | @Meta(what = "Minimum time between version update checks in days, or -1 for 'no checks' -- default is 1 day", where = "VersionCheck", format = "int", info = "If the last update check was done at least that many days, check for updates at startup") |
52 | UPDATE_INTERVAL, | |
08fe2e33 | 53 | } |