1 package be
.nikiroo
.fanfix
.bundles
;
3 import java
.io
.IOException
;
6 import be
.nikiroo
.utils
.resources
.Bundle
;
7 import be
.nikiroo
.utils
.resources
.Meta
;
10 * The {@link Enum} representing textual information to be translated to the
13 * Note that each key that should be translated <b>must</b> be annotated with a
14 * {@link Meta} annotation.
18 public enum StringId
{
20 * A special key used for technical reasons only, without annotations so it
21 * is not visible in <tt>.properties</tt> files.
23 * Use it when you need NO translation.
27 * A special key used for technical reasons only, without annotations so it
28 * is not visible in <tt>.properties</tt> files.
30 * Use it when you need a real translation but still don't have a key.
33 @Meta(what
= "help message", where
= "cli", format
= "%s = supported input, %s = supported output", info
= "help message for the syntax")
35 @Meta(what
= "error message", where
= "cli", format
= "", info
= "syntax error message")
37 @Meta(what
= "error message", where
= "cli", format
= "%s = support name, %s = support desc", info
= "an input or output support type description")
39 @Meta(what
= "error message", where
= "cli", format
= "%s = input string", info
= "Error when retrieving data")
41 @Meta(what
= "error message", where
= "cli", format
= "%s = save target", info
= "Error when saving to given target")
43 @Meta(what
= "error message", where
= "cli", format
= "%s = bad output format", info
= "Error when unknown output format")
44 ERR_BAD_OUTPUT_TYPE
, //
45 @Meta(what
= "error message", where
= "cli", format
= "%s = input string", info
= "Error when converting input to URL/File")
47 @Meta(what
= "error message", where
= "cli", format
= "%s = input url", info
= "URL/File not supported")
49 @Meta(what
= "error message", where
= "BasicSupport", format
= "%s = cover URL", info
= "Failed to download cover : %s")
51 @Meta(what
= "char", where
= "LaTeX/BasicSupport", format
= "single char", info
= "Canonical OPEN SINGLE QUOTE char (for instance: `)")
53 @Meta(what
= "char", where
= "LaTeX/BasicSupport", format
= "single char", info
= "Canonical CLOSE SINGLE QUOTE char (for instance: ‘)")
54 CLOSE_SINGLE_QUOTE
, //
55 @Meta(what
= "char", where
= "LaTeX/BasicSupport", format
= "single char", info
= "Canonical OPEN DOUBLE QUOTE char (for instance: “)")
57 @Meta(what
= "char", where
= "LaTeX/BasicSupport", format
= "single char", info
= "Canonical CLOSE DOUBLE QUOTE char (for instance: ”)")
58 CLOSE_DOUBLE_QUOTE
, //
59 @Meta(what
= "chapter name", where
= "BasicSupport", format
= "", info
= "Name of the description fake chapter")
61 @Meta(what
= "chapter name", where
= "", format
= "%d = number, %s = name", info
= "Name of a chapter with a name")
63 @Meta(what
= "chapter name", where
= "", format
= "%d = number, %s = name", info
= "Name of a chapter without name")
65 @Meta(what
= "input format description", where
= "SupportType", format
= "%s = type", info
= "Default description when the type is not known by i18n")
67 @Meta(what
= "input format description", where
= "SupportType", format
= "", info
= "Description of this input type")
69 @Meta(what
= "input format description", where
= "SupportType", format
= "", info
= "Description of this input type")
71 @Meta(what
= "input format description", where
= "SupportType", format
= "", info
= "Description of this input type")
72 INPUT_DESC_INFO_TEXT
, //
73 @Meta(what
= "input format description", where
= "SupportType", format
= "", info
= "Description of this input type")
74 INPUT_DESC_FANFICTION
, //
75 @Meta(what
= "input format description", where
= "SupportType", format
= "", info
= "Description of this input type")
76 INPUT_DESC_FIMFICTION
, //
77 @Meta(what
= "input format description", where
= "SupportType", format
= "", info
= "Description of this input type")
78 INPUT_DESC_MANGAFOX
, //
79 @Meta(what
= "input format description", where
= "SupportType", format
= "", info
= "Description of this input type")
81 @Meta(what
= "output format description", where
= "OutputType", format
= "%s = type", info
= "Default description when the type is not known by i18n")
83 @Meta(what
= "output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
85 @Meta(what
= "output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
87 @Meta(what
= "output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
88 OUTPUT_DESC_INFO_TEXT
, //
89 @Meta(what
= "output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
91 @Meta(what
= "output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
93 @Meta(what
= "short output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
94 OUTPUT_DESC_SYSOUT
, //
96 @Meta(what
= "short output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
97 OUTPUT_DESC_SHORT_EPUB
, //
98 @Meta(what
= "short output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
99 OUTPUT_DESC_SHORT_TEXT
, //
100 @Meta(what
= "short output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
101 OUTPUT_DESC_SHORT_INFO_TEXT
, //
102 @Meta(what
= "short output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
103 OUTPUT_DESC_SHORT_CBZ
, //
104 @Meta(what
= "short output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
105 OUTPUT_DESC_SHORT_LATEX
, //
106 @Meta(what
= "short output format description", where
= "OutputType", format
= "", info
= "Description of this output type")
107 OUTPUT_DESC_SHORT_SYSOUT
, //
108 @Meta(what
= "error message", where
= "LaTeX", format
= "%s = the unknown 2-code language", info
= "Error message for unknown 2-letter LaTeX language code")
109 LATEX_LANG_UNKNOWN
, //
110 @Meta(what
= "'by' prefix before author name", where
= "", format
= "", info
= "used to output the author, make sure it is covered by Config.BYS for input detection")
116 * Write the header found in the configuration <tt>.properties</tt> file of
117 * this {@link Bundle}.
120 * the {@link Writer} to write the header in
124 * @throws IOException
125 * in case of IO error
127 static public void writeHeader(Writer writer
, String name
)
129 writer
.write("# " + name
+ " translation file (UTF-8)\n");
130 writer
.write("# \n");
131 writer
.write("# Note that any key can be doubled with a _NOUTF suffix\n");
132 writer
.write("# to use when the NOUTF env variable is set to 1\n");
133 writer
.write("# \n");
134 writer
.write("# Also, the comments always refer to the key below them.\n");
135 writer
.write("# \n");