src/be/nikiroo/fanfix/bundles/Config.java

   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 {
  11         @Meta(what = "language", where = "", format = "language (example: en-GB) or nothing for default system language", info = "Force the language (can be overwritten again with the env variable $LANG)")
  12         LANG, //
  13         @Meta(what = "reader type", where = "", format = "CLI or LOCAL", info = "Select the reader to use to read stories (CLI = simple output to console, LOCAL = use local system file handler)")
  14         READER_TYPE, //
  15         @Meta(what = "directory", where = "", format = "absolute path, $HOME variable supported, / is always accepted as dir separator", info = "The directory where to store temporary files, defaults to a directory 'fanfic-tmp' in the system default temporary directory")
  16         CACHE_DIR, //
  17         @Meta(what = "directory", where = "", format = "absolute path, $HOME variable supported, / is always accepted as dir separator", info = "The directory where to store temporary files, defaults to a directory 'fanfic-reader' in the system default temporary directory")
  18         CACHE_DIR_LOCAL_READER, //
  19         @Meta(what = "delay in hours", where = "", format = "integer | 0: no cache | -1: infinite time cache which is default", info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh")
  20         CACHE_MAX_TIME_CHANGING, //
  21         @Meta(what = "delay in hours", where = "", format = "integer | 0: no cache | -1: infinite time cache which is default", info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh")
  22         CACHE_MAX_TIME_STABLE, //
  23         @Meta(what = "string", where = "", format = "", info = "The user-agent to use to download files")
  24         USER_AGENT, //
  25         @Meta(what = "directory", where = "", format = "absolute path, $HOME variable supported, / is always accepted as dir separator", info = "The directory where to get the default story covers")
  26         DEFAULT_COVERS_DIR, //
  27         @Meta(what = "directory", where = "", format = "absolute path, $HOME variable supported, / is always accepted as dir separator", info = "The directory where to store the library")
  28         LIBRARY_DIR, //
  29         @Meta(what = "boolean", where = "", format = "'true' or 'false'", info = "Show debug information on errors")
  30         DEBUG_ERR, //
  31         @Meta(what = "image format", where = "", format = "PNG, JPG, BMP...", info = "Image format to use for cover images")
  32         IMAGE_FORMAT_COVER, //
  33         @Meta(what = "image format", where = "", format = "PNG, JPG, BMP...", info = "Image format to use for content images")
  34         IMAGE_FORMAT_CONTENT, //
  35         @Meta(what = "", where = "", format = "not used", info = "This key is only present to allow access to suffixes")
  36         LATEX_LANG, //
  37         @Meta(what = "LaTeX output language", where = "LaTeX", format = "", info = "LaTeX full name for English")
  38         LATEX_LANG_EN, //
  39         @Meta(what = "LaTeX output language", where = "LaTeX", format = "", info = "LaTeX full name for French")
  40         LATEX_LANG_FR, //
  41         @Meta(what = "other 'by' prefixes before author name", where = "", format = "comma-separated list", info = "used to identify the author")
  42         BYS, //
  43         @Meta(what = "Chapter identification languages", where = "", format = "comma-separated list", info = "used to identify a starting chapter in text mode")
  44         CHAPTER, //
  45         @Meta(what = "Chapter identification string", where = "", format = "", info = "used to identify a starting chapter in text mode")
  46         CHAPTER_EN, //
  47         @Meta(what = "Chapter identification string", where = "", format = "", info = "used to identify a starting chapter in text mode")
  48         CHAPTER_FR, //
  49         @Meta(what = "Output type", where = "Local Reader", format = "One of the known output type", info = "The type of output for the Local Reader for non-images documents")
  50         LOCAL_READER_NON_IMAGES_DOCUMENT_TYPE, //
  51         @Meta(what = "Output type", where = "Local Reader", format = "One of the known output type", info = "The type of output for the Local Reader for images documents")
  52         LOCAL_READER_IMAGES_DOCUMENT_TYPE, //
  53
  54 }