Config.java

   1 package be.nikiroo.fanfix.bundles;
   2
   3 import be.nikiroo.utils.resources.Meta;
   4 import be.nikiroo.utils.resources.Meta.Format;
   5
   6 /**
   7  * The configuration options.
   8  *
   9  * @author niki
  10  */
  11 @SuppressWarnings("javadoc")
  12 public enum Config {
  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)")
  14         LANG, //
  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")
  17         READER_TYPE, //
  18         @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)")
  19         CACHE_DIR, //
  20         @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")
  21         CACHE_MAX_TIME_CHANGING, //
  22         @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")
  23         CACHE_MAX_TIME_STABLE, //
  24         @Meta(description = "string", info = "The user-agent to use to download files")
  25         USER_AGENT, //
  26         @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")
  27         DEFAULT_COVERS_DIR, //
  28         @Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store the library")
  29         LIBRARY_DIR, //
  30         @Meta(description = "boolean", format = Format.BOOLEAN, info = "Show debug information on errors")
  31         DEBUG_ERR, //
  32         @Meta(description = "image format", format = Format.COMBO_LIST, list = {
  33                         "PNG", "JPG", "BMP" }, info = "Image format to use for cover images")
  34         IMAGE_FORMAT_COVER, //
  35         @Meta(description = "image format", format = Format.COMBO_LIST, list = {
  36                         "PNG", "JPG", "BMP" }, info = "Image format to use for content images")
  37         IMAGE_FORMAT_CONTENT, //
  38         @Meta(group = true)
  39         LATEX_LANG, //
  40         @Meta(description = "LaTeX output language: English", info = "LaTeX full name")
  41         LATEX_LANG_EN, //
  42         @Meta(description = "LaTeX output language: French", info = "LaTeX full name")
  43         LATEX_LANG_FR, //
  44         @Meta(description = "other 'by' prefixes before author name, used to identify the author", array = true)
  45         BYS, //
  46         @Meta(description = "List of languages codes used for chapter identification (should not be changed)", array = true, info = "EN,FR")
  47         CHAPTER, //
  48         @Meta(description = "Chapter identification String: English", info = "used to identify a starting chapter in text mode")
  49         CHAPTER_EN, //
  50         @Meta(description = "Chapter identification String: French", info = "used to identify a starting chapter in text mode")
  51         CHAPTER_FR, //
  52         @Meta(description = "Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)")
  53         LOGIN_YIFFSTAR_USER, //
  54         @Meta(description = "Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)", format = Format.PASSWORD)
  55         LOGIN_YIFFSTAR_PASS, //
  56         @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)
  57         UPDATE_INTERVAL, //
  58         @Meta(description = "An API key required to create a token from FimFiction", format = Format.STRING)
  59         LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
  60         @Meta(description = "An API key required to create a token from FimFiction", format = Format.PASSWORD)
  61         LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, //
  62         @Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping", format = Format.BOOLEAN)
  63         LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
  64         @Meta(description = "A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)", format = Format.PASSWORD)
  65         LOGIN_FIMFICTION_APIKEY_TOKEN, //
  66 }