Debian Codegraph @

translations/manual/plugins.pot

raw
1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) Kovid Goyal
3 # This file is distributed under the same license as the calibre package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: calibre 9.15.0\n"
10 "Report-Msgid-Bugs-To: \n"
11 "POT-Creation-Date: 2026-09-18 07:37+0530\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <[email protected]>\n"
15 "MIME-Version: 1.0\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18
19 #: ../../../home/kovid/work/calibre/manual/plugins.rst:4
20 msgid "API documentation for plugins"
21 msgstr ""
22
23 #: ../../../home/kovid/work/calibre/manual/plugins.rst:9
24 msgid "Defines various abstract base classes that can be subclassed to create powerful plugins. The useful classes are:"
25 msgstr ""
26
27 #: ../../../home/kovid/work/calibre/manual/plugins.rst:19
28 msgid "Plugin"
29 msgstr ""
30
31 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:1
32 msgid "A calibre plugin. Useful members include:"
33 msgstr ""
34
35 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:3
36 msgid "``self.installation_type``: Stores how the plugin was installed."
37 msgstr ""
38
39 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:4
40 msgid "``self.plugin_path``: Stores path to the ZIP file that contains"
41 msgstr ""
42
43 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:5
44 msgid "this plugin or None if it is a builtin plugin"
45 msgstr ""
46
47 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:7
48 msgid "``self.site_customization``: Stores a customization string entered"
49 msgstr ""
50
51 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:8
52 msgid "by the user."
53 msgstr ""
54
55 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:10
56 msgid "Methods that should be overridden in sub classes:"
57 msgstr ""
58
59 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:12
60 msgid ":meth:`initialize`"
61 msgstr ""
62
63 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:13
64 msgid ":meth:`customization_help`"
65 msgstr ""
66
67 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:15
68 msgid "Useful methods:"
69 msgstr ""
70
71 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:17
72 msgid ":meth:`temporary_file`"
73 msgstr ""
74
75 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:18
76 msgid ":meth:`__enter__`"
77 msgstr ""
78
79 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin:19
80 msgid ":meth:`load_resources`"
81 msgstr ""
82
83 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.InterfaceActionBase.supported_platforms:1
84 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.supported_platforms:1
85 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.supported_platforms:1
86 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.supported_platforms:1
87 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.supported_platforms:1
88 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.supported_platforms:1
89 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.supported_platforms:1
90 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.supported_platforms:1
91 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.supported_platforms:1
92 msgid "List of platforms this plugin works on. For example: ``['windows', 'osx', 'linux']``"
93 msgstr ""
94
95 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.name:1
96 msgid "The name of this plugin. You must set it something other than Trivial Plugin for it to work."
97 msgstr ""
98
99 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.version:1
100 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.version:1
101 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.version:1
102 msgid "The version of this plugin as a 3-tuple (major, minor, revision)"
103 msgstr ""
104
105 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.description:1
106 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.description:1
107 msgid "A short string describing what this plugin does"
108 msgstr ""
109
110 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.InterfaceActionBase.author:1
111 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.author:1
112 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.author:1
113 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.author:1
114 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.author:1
115 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.author:1
116 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.author:1
117 msgid "The author of this plugin"
118 msgstr ""
119
120 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.priority:1
121 msgid "When more than one plugin exists for a filetype, the plugins are run in order of decreasing priority. Plugins with higher priority will be run first. The highest possible priority is ``sys.maxsize``. Default priority is 1."
122 msgstr ""
123
124 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.minimum_calibre_version:1
125 msgid "The earliest version of calibre this plugin requires"
126 msgstr ""
127
128 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.installation_type:1
129 msgid "The way this plugin is installed"
130 msgstr ""
131
132 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.can_be_disabled:1
133 msgid "If False, the user will not be able to disable this plugin. Use with care."
134 msgstr ""
135
136 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.type:1
137 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.type:1
138 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.InterfaceActionBase.type:1
139 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.type:1
140 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.type:1
141 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.type:1
142 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.type:1
143 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.type:1
144 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.type:1
145 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.type:1
146 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.type:1
147 msgid "The type of this plugin. Used for categorizing plugins in the GUI"
148 msgstr ""
149
150 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.initialize:1
151 msgid "Called once when calibre plugins are initialized. Plugins are re-initialized every time a new plugin is added. Also note that if the plugin is run in a worker process, such as for adding books, then the plugin will be initialized for every new worker process."
152 msgstr ""
153
154 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.initialize:6
155 msgid "Perform any plugin specific initialization here, such as extracting resources from the plugin ZIP file. The path to the ZIP file is available as ``self.plugin_path``."
156 msgstr ""
157
158 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.initialize:10
159 msgid "Note that ``self.site_customization`` is **not** available at this point."
160 msgstr ""
161
162 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.config_widget:1
163 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.config_widget:1
164 msgid "Implement this method and :meth:`save_settings` in your plugin to use a custom configuration dialog, rather then relying on the simple string based default customization."
165 msgstr ""
166
167 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.config_widget:5
168 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.config_widget:5
169 msgid "This method, if implemented, must return a QWidget. The widget can have an optional method validate() that takes no arguments and is called immediately after the user clicks OK. Changes are applied if and only if the method returns True."
170 msgstr ""
171
172 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.config_widget:10
173 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.config_widget:10
174 msgid "If for some reason you cannot perform the configuration at this time, return a tuple of two strings (message, details), these will be displayed as a warning dialog to the user and the process will be aborted."
175 msgstr ""
176
177 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.save_settings:1
178 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.save_settings:1
179 msgid "Save the settings specified by the user with config_widget."
180 msgstr ""
181
182 #: ../../../home/kovid/work/calibre/manual/plugins.rst:0
183 msgid "Parameters"
184 msgstr ""
185
186 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.save_settings:3
187 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.save_settings:3
188 msgid "The widget returned by :meth:`config_widget`."
189 msgstr ""
190
191 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.do_user_config:1
192 msgid "This method shows a configuration dialog for this plugin. It returns True if the user clicks OK, False otherwise. The changes are automatically applied."
193 msgstr ""
194
195 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.load_resources:1
196 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.load_resources:1
197 msgid "If this plugin comes in a ZIP file (user added plugin), this method will allow you to load resources from the ZIP file."
198 msgstr ""
199
200 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.load_resources:4
201 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.load_resources:4
202 msgid "For example to load an image::"
203 msgstr ""
204
205 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.load_resources:10
206 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.load_resources:10
207 msgid "List of paths to resources in the ZIP file using / as separator"
208 msgstr ""
209
210 #: ../../../home/kovid/work/calibre/manual/plugins.rst:0
211 msgid "Returns"
212 msgstr ""
213
214 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.load_resources:12
215 msgid "A dictionary of the form ``{name: file_contents}``. Any names that were not found in the ZIP file will not be present in the dictionary."
216 msgstr ""
217
218 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.customization_help:1
219 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.customization_help:1
220 msgid "Return a string giving help on how to customize this plugin. By default raise a :class:`NotImplementedError`, which indicates that the plugin does not require customization."
221 msgstr ""
222
223 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.customization_help:5
224 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.customization_help:5
225 msgid "If you re-implement this method in your subclass, the user will be asked to enter a string as customization for this plugin. The customization string will be available as ``self.site_customization``."
226 msgstr ""
227
228 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.customization_help:10
229 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.customization_help:10
230 msgid "Site customization could be anything, for example, the path to a needed binary on the user's computer."
231 msgstr ""
232
233 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.customization_help:13
234 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.customization_help:13
235 msgid "If True return HTML help, otherwise return plain text help."
236 msgstr ""
237
238 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.temporary_file:1
239 msgid "Return a file-like object that is a temporary file on the file system. This file will remain available even after being closed and will only be removed on interpreter shutdown. Use the ``name`` member of the returned object to access the full path to the created temporary file."
240 msgstr ""
241
242 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.temporary_file:6
243 msgid "The suffix that the temporary file will have."
244 msgstr ""
245
246 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.Plugin.cli_main:1
247 msgid "This method is the main entry point for your plugins command line interface. It is called when the user does: calibre-debug -r \"Plugin Name\". Any arguments passed are present in the args variable."
248 msgstr ""
249
250 #: ../../../home/kovid/work/calibre/manual/plugins.rst:28
251 msgid "FileTypePlugin"
252 msgstr ""
253
254 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin:1
255 msgid "A plugin that is associated with a particular set of file types."
256 msgstr ""
257
258 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.file_types:1
259 msgid "Set of file types for which this plugin should be run. Use '*' for all file types. For example: ``{'lit', 'mobi', 'prc'}``"
260 msgstr ""
261
262 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.on_import:1
263 msgid "If True, this plugin is run when books are added to the database"
264 msgstr ""
265
266 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.on_postimport:1
267 msgid "If True, this plugin is run after books are added to the database. In this case the postimport and postadd methods of the plugin are called."
268 msgstr ""
269
270 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.on_postconvert:1
271 msgid "If True, this plugin is run after a book is converted. In this case the postconvert method of the plugin is called."
272 msgstr ""
273
274 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.on_postdelete:1
275 msgid "If True, this plugin is run after a book file is deleted from the database. In this case the postdelete method of the plugin is called."
276 msgstr ""
277
278 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.on_preprocess:1
279 msgid "If True, this plugin is run just before a conversion"
280 msgstr ""
281
282 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.on_postprocess:1
283 msgid "If True, this plugin is run after conversion on the final file produced by the conversion output plugin."
284 msgstr ""
285
286 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.run:1
287 msgid "Run the plugin. Must be implemented in subclasses. It should perform whatever modifications are required on the e-book and return the absolute path to the modified e-book. If no modifications are needed, it should return the path to the original e-book. If an error is encountered it should raise an Exception. The default implementation simply return the path to the original e-book. Note that the path to the original file (before any file type plugins are run, is available as self.original_path_to_file)."
288 msgstr ""
289
290 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.run:11
291 msgid "The modified e-book file should be created with the :meth:`temporary_file` method."
292 msgstr ""
293
294 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.run:14
295 msgid "Absolute path to the e-book."
296 msgstr ""
297
298 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.run:16
299 msgid "Absolute path to the modified e-book."
300 msgstr ""
301
302 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postimport:1
303 msgid "Called post import, i.e., after the book file has been added to the database. Note that this is different from :meth:`postadd` which is called when the book record is created for the first time. This method is called whenever a new file is added to a book record. It is useful for modifying the book record based on the contents of the newly added file."
304 msgstr ""
305
306 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postadd:8
307 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postconvert:5
308 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postdelete:6
309 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postimport:6
310 msgid "Database id of the added book."
311 msgstr ""
312
313 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postconvert:6
314 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postdelete:7
315 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postimport:7
316 msgid "The file type of the book that was added."
317 msgstr ""
318
319 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postconvert:7
320 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postdelete:8
321 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postimport:8
322 msgid "Library database."
323 msgstr ""
324
325 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postconvert:1
326 msgid "Called post conversion, i.e., after the conversion output book file has been added to the database. Note that it is run after a conversion only, not after a book is added. It is useful for modifying the book record based on the contents of the newly added file."
327 msgstr ""
328
329 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postdelete:1
330 msgid "Called post deletion, i.e., after the book file has been deleted from the database. Note that it is not run when a book record is deleted, only when one or more formats from the book are deleted. It is useful for modifying the book record based on the format of the deleted file."
331 msgstr ""
332
333 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postadd:1
334 msgid "Called post add, i.e. after a book has been added to the db. Note that this is different from :meth:`postimport`, which is called after a single book file has been added to a book. postadd() is called only when an entire book record with possibly more than one book file has been created for the first time. This is useful if you wish to modify the book record in the database when the book is first added to calibre."
335 msgstr ""
336
337 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postadd:9
338 msgid "Map of file format to path from which the file format was added. Note that this might or might not point to an actual existing file, as sometimes files are added as streams. In which case it might be a dummy value or a non-existent path."
339 msgstr ""
340
341 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.FileTypePlugin.postadd:13
342 msgid "Library database"
343 msgstr ""
344
345 #: ../../../home/kovid/work/calibre/manual/plugins.rst:39
346 msgid "Metadata plugins"
347 msgstr ""
348
349 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin:1
350 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin:1
351 msgid "A plugin that implements reading metadata from a set of file types."
352 msgstr ""
353
354 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.file_types:1
355 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.file_types:1
356 msgid "Set of file types for which this plugin should be run. For example: ``set(['lit', 'mobi', 'prc'])``"
357 msgstr ""
358
359 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.get_metadata:1
360 msgid "Return metadata for the file represented by stream (a file like object that supports reading). Raise an exception when there is an error with the input data."
361 msgstr ""
362
363 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.get_metadata:5
364 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.set_metadata:5
365 msgid "The type of file. Guaranteed to be one of the entries in :attr:`file_types`."
366 msgstr ""
367
368 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataReaderPlugin.get_metadata:7
369 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.set_metadata:7
370 msgid "A :class:`calibre.ebooks.metadata.book.Metadata` object"
371 msgstr ""
372
373 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.MetadataWriterPlugin.set_metadata:1
374 msgid "Set metadata for the file represented by stream (a file like object that supports reading). Raise an exception when there is an error with the input data."
375 msgstr ""
376
377 #: ../../../home/kovid/work/calibre/manual/plugins.rst:54
378 msgid "Catalog plugins"
379 msgstr ""
380
381 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin:1
382 msgid "A plugin that implements a catalog generator."
383 msgstr ""
384
385 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.file_types:1
386 msgid "Output file type for which this plugin should be run. For example: 'epub' or 'xml'"
387 msgstr ""
388
389 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.cli_options:1
390 msgid "CLI parser options specific to this plugin, declared as `namedtuple` `Option`:"
391 msgstr ""
392
393 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.cli_options:3
394 msgid "from collections import namedtuple Option = namedtuple('Option', 'option, default, dest, help') cli_options = [Option('--catalog-title', default = 'My Catalog', dest = 'catalog_title', help = (_('Title of generated catalog. \\nDefault:') + \" '\" + '%default' + \"'\"))] cli_options parsed in calibre.db.cli.cmd_catalog:option_parser()"
395 msgstr ""
396
397 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.initialize:1
398 msgid "If plugin is not a built-in, copy the plugin's .ui and .py files from the ZIP file to $TMPDIR. Tab will be dynamically generated and added to the Catalog Options dialog in calibre.gui2.dialogs.catalog.py:Catalog"
399 msgstr ""
400
401 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.run:1
402 msgid "Run the plugin. Must be implemented in subclasses. It should generate the catalog in the format specified in file_types, returning the absolute path to the generated catalog file. If an error is encountered it should raise an Exception."
403 msgstr ""
404
405 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.run:7
406 msgid "The generated catalog file should be created with the :meth:`temporary_file` method."
407 msgstr ""
408
409 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.run:10
410 msgid "Absolute path to the generated catalog file."
411 msgstr ""
412
413 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.run:11
414 msgid "A dictionary of keyword arguments"
415 msgstr ""
416
417 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.CatalogPlugin.run:12
418 msgid "A LibraryDatabase2 object"
419 msgstr ""
420
421 #: ../../../home/kovid/work/calibre/manual/plugins.rst:64
422 msgid "Metadata download plugins"
423 msgstr ""
424
425 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.capabilities:1
426 msgid "Set of capabilities supported by this plugin. Useful capabilities are: 'identify', 'cover'"
427 msgstr ""
428
429 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.touched_fields:1
430 msgid "List of metadata fields that can potentially be download by this plugin during the identify phase"
431 msgstr ""
432
433 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.has_html_comments:1
434 msgid "Set this to True if your plugin returns HTML formatted comments"
435 msgstr ""
436
437 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.supports_gzip_transfer_encoding:1
438 msgid "Setting this to True means that the browser object will indicate that it supports gzip transfer encoding. This can speedup downloads but make sure that the source actually supports gzip transfer encoding correctly first"
439 msgstr ""
440
441 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.ignore_ssl_errors:1
442 msgid "Set this to True to ignore HTTPS certificate errors when connecting to this source."
443 msgstr ""
444
445 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.cached_cover_url_is_reliable:1
446 msgid "Cached cover URLs can sometimes be unreliable (i.e. the download could fail or the returned image could be bogus). If that is often the case with this source, set to False"
447 msgstr ""
448
449 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.options:1
450 msgid "A list of :class:`Option` objects. They will be used to automatically construct the configuration widget for this plugin"
451 msgstr ""
452
453 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.config_help_message:1
454 msgid "A string that is displayed at the top of the config widget for this plugin"
455 msgstr ""
456
457 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.can_get_multiple_covers:1
458 msgid "If True this source can return multiple covers for a given query"
459 msgstr ""
460
461 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.auto_trim_covers:1
462 msgid "If set to True covers downloaded by this plugin are automatically trimmed."
463 msgstr ""
464
465 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.prefer_results_with_isbn:1
466 msgid "If set to True, and this source returns multiple results for a query, some of which have ISBNs and some of which do not, the results without ISBNs will be ignored"
467 msgstr ""
468
469 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.is_configured:1
470 msgid "Return False if your plugin needs to be configured before it can be used. For example, it might need a username/password/API key."
471 msgstr ""
472
473 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.get_author_tokens:1
474 msgid "Take a list of authors and return a list of tokens useful for an AND search query. This function tries to return tokens in first name middle names last name order, by assuming that if a comma is in the author name, the name is in lastname, other names form."
475 msgstr ""
476
477 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.get_title_tokens:1
478 msgid "Take a title and return a list of tokens useful for an AND search query. Excludes connectives(optionally) and punctuation."
479 msgstr ""
480
481 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.split_jobs:1
482 msgid "Split a list of jobs into at most num groups, as evenly as possible"
483 msgstr ""
484
485 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.test_fields:1
486 msgid "Return the first field from self.touched_fields that is null on the mi object"
487 msgstr ""
488
489 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.clean_downloaded_metadata:1
490 msgid "Call this method in your plugin's identify method to normalize metadata before putting the Metadata object into result_queue. You can of course, use a custom algorithm suited to your metadata source."
491 msgstr ""
492
493 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.get_book_url:1
494 msgid "Return a 3-tuple or None. The 3-tuple is of the form: (identifier_type, identifier_value, URL). The URL is the URL for the book identified by identifiers at this source. identifier_type, identifier_value specify the identifier corresponding to the URL. This URL must be browsable to by a human using a browser. It is meant to provide a clickable link for the user to easily visit the books page at this source. If no URL is found, return None. This method must be quick, and consistent, so only implement it if it is possible to construct the URL from a known scheme given identifiers."
495 msgstr ""
496
497 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.get_book_url_name:1
498 msgid "Return a human readable name from the return value of get_book_url()."
499 msgstr ""
500
501 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.get_book_urls:1
502 msgid "Override this method if you would like to return multiple URLs for this book. Return a list of 3-tuples. By default this method simply calls :func:`get_book_url`."
503 msgstr ""
504
505 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.get_cached_cover_url:1
506 msgid "Return cached cover URL for the book identified by the identifiers dictionary or None if no such URL exists."
507 msgstr ""
508
509 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.get_cached_cover_url:4
510 msgid "Note that this method must only return validated URLs, i.e. not URLS that could result in a generic cover image or a not found error."
511 msgstr ""
512
513 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.id_from_url:1
514 msgid "Parse a URL and return a tuple of the form: (identifier_type, identifier_value). If the URL does not match the pattern for the metadata source, return None."
515 msgstr ""
516
517 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify_results_keygen:1
518 msgid "Return a function that is used to generate a key that can sort Metadata objects by their relevance given a search query (title, authors, identifiers)."
519 msgstr ""
520
521 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify_results_keygen:5
522 msgid "These keys are used to sort the results of a call to :meth:`identify`."
523 msgstr ""
524
525 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify_results_keygen:7
526 msgid "For details on the default algorithm see :class:`InternalMetadataCompareKeyGen`. Re-implement this function in your plugin if the default algorithm is not suitable."
527 msgstr ""
528
529 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:1
530 msgid "Identify a book by its Title/Author/ISBN/etc."
531 msgstr ""
532
533 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:3
534 msgid "If identifiers(s) are specified and no match is found and this metadata source does not store all related identifiers (for example, all ISBNs of a book), this method should retry with just the title and author (assuming they were specified)."
535 msgstr ""
536
537 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:8
538 msgid "If this metadata source also provides covers, the URL to the cover should be cached so that a subsequent call to the get covers API with the same ISBN/special identifier does not need to get the cover URL again. Use the caching API for this."
539 msgstr ""
540
541 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:13
542 msgid "Every Metadata object put into result_queue by this method must have a `source_relevance` attribute that is an integer indicating the order in which the results were returned by the metadata source for this query. This integer will be used by :meth:`compare_identify_results`. If the order is unimportant, set it to zero for every result."
543 msgstr ""
544
545 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:19
546 msgid "Make sure that any cover/ISBN mapping information is cached before the Metadata object is put into result_queue."
547 msgstr ""
548
549 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:22
550 msgid "A log object, use it to output debugging information/errors"
551 msgstr ""
552
553 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:23
554 msgid "A result Queue, results should be put into it. Each result is a Metadata object"
555 msgstr ""
556
557 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:25
558 msgid "If abort.is_set() returns True, abort further processing and return as soon as possible"
559 msgstr ""
560
561 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:27
562 msgid "The title of the book, can be None"
563 msgstr ""
564
565 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:28
566 msgid "A list of authors of the book, can be None"
567 msgstr ""
568
569 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:29
570 msgid "A dictionary of other identifiers, most commonly {'isbn':'1234...'}"
571 msgstr ""
572
573 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:31
574 msgid "Timeout in seconds, no network request should hang for longer than timeout."
575 msgstr ""
576
577 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.identify:33
578 msgid "None if no errors occurred, otherwise a unicode representation of the error suitable for showing to the user"
579 msgstr ""
580
581 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.download_cover:1
582 msgid "Download a cover and put it into result_queue. The parameters all have the same meaning as for :meth:`identify`. Put (self, cover_data) into result_queue."
583 msgstr ""
584
585 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.download_cover:5
586 msgid "This method should use cached cover URLs for efficiency whenever possible. When cached data is not present, most plugins simply call identify and use its results."
587 msgstr ""
588
589 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.Source.download_cover:9
590 msgid "If the parameter get_best_cover is True and this plugin can get multiple covers, it should only get the \"best\" one."
591 msgstr ""
592
593 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:1
594 msgid "Generate a sort key for comparison of the relevance of Metadata objects, given a search query. This is used only to compare results from the same metadata source, not across different sources."
595 msgstr ""
596
597 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:5
598 msgid "The sort key ensures that an ascending order sort is a sort by order of decreasing relevance."
599 msgstr ""
600
601 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:8
602 msgid "The algorithm is:"
603 msgstr ""
604
605 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:10
606 msgid "Prefer results that have at least one identifier the same as for the query"
607 msgstr ""
608
609 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:11
610 msgid "Prefer results with a cached cover URL"
611 msgstr ""
612
613 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:12
614 msgid "Prefer results with all available fields filled in"
615 msgstr ""
616
617 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:13
618 msgid "Prefer results with the same language as the current user interface language"
619 msgstr ""
620
621 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:14
622 msgid "Prefer results that are an exact title match to the query"
623 msgstr ""
624
625 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:15
626 msgid "Prefer results with longer comments (greater than 10% longer)"
627 msgstr ""
628
629 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:16
630 msgid "Use the relevance of the result as reported by the metadata source's search"
631 msgstr ""
632
633 #: ../../../home/kovid/work/calibre/src/calibre/ebooks/metadata/sources/base.py:docstring of calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen:17
634 msgid "engine"
635 msgstr ""
636
637 #: ../../../home/kovid/work/calibre/manual/plugins.rst:76
638 msgid "Conversion plugins"
639 msgstr ""
640
641 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin:1
642 msgid "InputFormatPlugins are responsible for converting a document into HTML+OPF+CSS+etc. The results of the conversion *must* be encoded in UTF-8. The main action happens in :meth:`convert`."
643 msgstr ""
644
645 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.file_types:1
646 msgid "Set of file types for which this plugin should be run For example: ``set(['azw', 'mobi', 'prc'])``"
647 msgstr ""
648
649 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.is_image_collection:1
650 msgid "If True, this input plugin generates a collection of images, one per HTML file. This can be set dynamically, in the convert method if the input files can be both image collections and non-image collections. If you set this to True, you must implement the get_images() method that returns a list of images."
651 msgstr ""
652
653 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.core_usage:1
654 msgid "Number of CPU cores used by this plugin. A value of -1 means that it uses all available cores"
655 msgstr ""
656
657 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.for_viewer:1
658 msgid "If set to True, the input plugin will perform special processing to make its output suitable for viewing"
659 msgstr ""
660
661 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.output_encoding:1
662 msgid "The encoding that this input plugin creates files in. A value of None means that the encoding is undefined and must be detected individually"
663 msgstr ""
664
665 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.common_options:1
666 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.common_options:1
667 msgid "Options shared by all Input format plugins. Do not override in sub-classes. Use :attr:`options` instead. Every option must be an instance of :class:`OptionRecommendation`."
668 msgstr ""
669
670 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.options:1
671 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.options:1
672 msgid "Options to customize the behavior of this plugin. Every option must be an instance of :class:`OptionRecommendation`."
673 msgstr ""
674
675 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.recommendations:1
676 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.recommendations:1
677 msgid "A set of 3-tuples of the form (option_name, recommended_value, recommendation_level)"
678 msgstr ""
679
680 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.get_images:1
681 msgid "Return a list of absolute paths to the images, if this input plugin represents an image collection. The list of images is in the same order as the spine and the TOC."
682 msgstr ""
683
684 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.convert:1
685 msgid "This method must be implemented in sub-classes. It must return the path to the created OPF file or an :class:`OEBBook` instance. All output should be contained in the current folder. If this plugin creates files outside the current folder they must be deleted/marked for deletion before this method returns."
686 msgstr ""
687
688 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.convert:8
689 msgid "A file like object that contains the input file."
690 msgstr ""
691
692 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.convert:9
693 msgid "Options to customize the conversion process. Guaranteed to have attributes corresponding to all the options declared by this plugin. In addition, it will have a verbose attribute that takes integral values from zero upwards. Higher numbers mean be more verbose. Another useful attribute is ``input_profile`` that is an instance of :class:`calibre.customize.profiles.InputProfile`."
694 msgstr ""
695
696 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.convert:17
697 msgid "The extension (without the .) of the input file. It is guaranteed to be one of the `file_types` supported by this plugin."
698 msgstr ""
699
700 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.convert:20
701 msgid "A :class:`calibre.utils.logging.Log` object. All output should use this object."
702 msgstr ""
703
704 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.convert:22
705 msgid "A dictionary of various information that the input plugin can get easily that would speed up the subsequent stages of the conversion."
706 msgstr ""
707
708 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.postprocess_book:1
709 msgid "Called to allow the input plugin to perform postprocessing after the book has been parsed."
710 msgstr ""
711
712 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.specialize:1
713 msgid "Called to allow the input plugin to specialize the parsed book for a particular output format. Called after postprocess_book and before any transforms are performed on the parsed book."
714 msgstr ""
715
716 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.InputFormatPlugin.gui_configuration_widget:1
717 msgid "Called to create the widget used for configuring this plugin in the calibre GUI. The widget must be an instance of the PluginWidget class. See the builtin input plugins for examples."
718 msgstr ""
719
720 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin:1
721 msgid "OutputFormatPlugins are responsible for converting an OEB document (OPF+HTML) into an output e-book."
722 msgstr ""
723
724 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin:4
725 msgid "The OEB document can be assumed to be encoded in UTF-8. The main action happens in :meth:`convert`."
726 msgstr ""
727
728 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.file_type:1
729 msgid "The file type (extension without leading period) that this plugin outputs"
730 msgstr ""
731
732 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.description:1
733 msgid "str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str"
734 msgstr ""
735
736 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.description:4
737 msgid "Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'."
738 msgstr ""
739
740 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.convert:1
741 msgid "Render the contents of `oeb_book` (which is an instance of :class:`calibre.ebooks.oeb.OEBBook`) to the file specified by output."
742 msgstr ""
743
744 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.convert:4
745 msgid "Either a file like object or a string. If it is a string it is the path to a folder that may or may not exist. The output plugin should write its output into that folder. If it is a file like object, the output plugin should write its output into the file."
746 msgstr ""
747
748 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.convert:8
749 msgid "The input plugin that was used at the beginning of the conversion pipeline."
750 msgstr ""
751
752 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.convert:10
753 msgid "Conversion options. Guaranteed to have attributes corresponding to the OptionRecommendations of this plugin."
754 msgstr ""
755
756 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.convert:12
757 msgid "The logger. Print debug/info messages etc. using this."
758 msgstr ""
759
760 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.specialize_options:1
761 msgid "Can be used to change the values of conversion options, as used by the conversion pipeline."
762 msgstr ""
763
764 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.specialize_css_for_output:1
765 msgid "Can be used to make changes to the CSS during the CSS flattening process."
766 msgstr ""
767
768 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.specialize_css_for_output:4
769 msgid "The item (HTML file) being processed"
770 msgstr ""
771
772 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.specialize_css_for_output:5
773 msgid "A Stylizer object containing the flattened styles for item. You can get the style for any element by stylizer.style(element)."
774 msgstr ""
775
776 #: ../../../home/kovid/work/calibre/src/calibre/customize/conversion.py:docstring of calibre.customize.conversion.OutputFormatPlugin.gui_configuration_widget:1
777 msgid "Called to create the widget used for configuring this plugin in the calibre GUI. The widget must be an instance of the PluginWidget class. See the builtin output plugins for examples."
778 msgstr ""
779
780 #: ../../../home/kovid/work/calibre/manual/plugins.rst:91
781 msgid "Device drivers"
782 msgstr ""
783
784 #: ../../../home/kovid/work/calibre/manual/plugins.rst:95
785 msgid "The base class for all device drivers is :class:`DevicePlugin`. However, if your device exposes itself as a USBMS drive to the operating system, you should use the USBMS class instead as it implements all the logic needed to support these kinds of devices."
786 msgstr ""
787
788 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin:1
789 msgid "Defines the interface that should be implemented by backends that communicate with an e-book reader."
790 msgstr ""
791
792 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.FORMATS:1
793 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.FORMATS:1
794 msgid "Ordered list of supported formats"
795 msgstr ""
796
797 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.VENDOR_ID:1
798 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.VENDOR_ID:1
799 msgid "VENDOR_ID can be either an integer, a list of integers or a dictionary If it is a dictionary, it must be a dictionary of dictionaries, of the form::"
800 msgstr ""
801
802 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.PRODUCT_ID:1
803 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.PRODUCT_ID:1
804 msgid "An integer or a list of integers"
805 msgstr ""
806
807 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.BCD:1
808 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.BCD:1
809 msgid "BCD can be either None to not distinguish between devices based on BCD, or it can be a list of the BCD numbers of all devices supported by this driver."
810 msgstr ""
811
812 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.THUMBNAIL_HEIGHT:1
813 msgid "Height for thumbnails on the device"
814 msgstr ""
815
816 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.THUMBNAIL_COMPRESSION_QUALITY:1
817 msgid "Compression quality for thumbnails. Set this closer to 100 to have better quality thumbnails with fewer compression artifacts. Of course, the thumbnails get larger as well."
818 msgstr ""
819
820 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.WANTS_UPDATED_THUMBNAILS:1
821 msgid "Set this to True if the device supports updating cover thumbnails during sync_booklists. Setting it to true will ask device.py to refresh the cover thumbnails during book matching"
822 msgstr ""
823
824 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.CAN_SET_METADATA:1
825 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.CAN_SET_METADATA:1
826 msgid "Whether the metadata on books can be set via the GUI."
827 msgstr ""
828
829 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.CAN_DO_DEVICE_DB_PLUGBOARD:1
830 msgid "Whether the device can handle device_db metadata plugboards"
831 msgstr ""
832
833 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.path_sep:1
834 msgid "Path separator for paths to books on device"
835 msgstr ""
836
837 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.icon:1
838 msgid "Icon for this device"
839 msgstr ""
840
841 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.UserAnnotation.type:1
842 msgid "Alias for field number 0"
843 msgstr ""
844
845 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.UserAnnotation.value:1
846 msgid "Alias for field number 1"
847 msgstr ""
848
849 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.OPEN_FEEDBACK_MESSAGE:1
850 msgid "GUI displays this as a message if not None in the status bar. Useful if opening can take a long time"
851 msgstr ""
852
853 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.VIRTUAL_BOOK_EXTENSIONS:1
854 msgid "Set of extensions that are \"virtual books\" on the device and therefore cannot be viewed/saved/added to library. For example: ``frozenset(['kobo'])``"
855 msgstr ""
856
857 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.VIRTUAL_BOOK_EXTENSION_MESSAGE:1
858 msgid "Message to display to user for virtual book extensions."
859 msgstr ""
860
861 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.NUKE_COMMENTS:1
862 msgid "Whether to nuke comments in the copy of the book sent to the device. If not None this should be short string that the comments will be replaced by."
863 msgstr ""
864
865 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.MANAGES_DEVICE_PRESENCE:1
866 msgid "If True indicates that this driver completely manages device detection, ejecting and so forth. If you set this to True, you *must* implement the detect_managed_devices and debug_managed_device_detection methods. A driver with this set to true is responsible for detection of devices, managing a blacklist of devices, a list of ejected devices and so forth. calibre will periodically call the detect_managed_devices() method and if it returns a detected device, calibre will call open(). open() will be called every time a device is returned even if previous calls to open() failed, therefore the driver must maintain its own blacklist of failed devices. Similarly, when ejecting, calibre will call eject() and then assuming the next call to detect_managed_devices() returns None, it will call post_yank_cleanup()."
867 msgstr ""
868
869 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.SLOW_DRIVEINFO:1
870 msgid "If set the True, calibre will call the :meth:`get_driveinfo()` method after the books lists have been loaded to get the driveinfo."
871 msgstr ""
872
873 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.ASK_TO_ALLOW_CONNECT:1
874 msgid "If set to True, calibre will ask the user if they want to manage the device with calibre, the first time it is detected. If you set this to True you must implement :meth:`get_device_uid()` and :meth:`ignore_connected_device()` and :meth:`get_user_blacklisted_devices` and :meth:`set_user_blacklisted_devices`"
875 msgstr ""
876
877 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.user_feedback_after_callback:1
878 msgid "Set this to a dictionary of the form {'title':title, 'msg':msg, 'det_msg':detailed_msg} to have calibre popup a message to the user after some callbacks are run (currently only upload_books). Be careful to not spam the user with too many messages. This variable is checked after *every* callback, so only set it when you really need to."
879 msgstr ""
880
881 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_open_popup_message:1
882 msgid "GUI displays this as a non-modal popup. Should be an instance of OpenPopupMessage"
883 msgstr ""
884
885 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.model_metadata:1
886 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.model_metadata:1
887 msgid "Metadata about all the actual device models this driver supports"
888 msgstr ""
889
890 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.is_usb_connected:1
891 msgid "Return True, device_info if a device handled by this plugin is currently connected."
892 msgstr ""
893
894 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.is_usb_connected:3
895 msgid "List of devices currently connected"
896 msgstr ""
897
898 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.debug_managed_device_detection:1
899 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.detect_managed_devices:1
900 msgid "Called only if MANAGES_DEVICE_PRESENCE is True."
901 msgstr ""
902
903 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.detect_managed_devices:3
904 msgid "Scan for devices that this driver can handle. Should return a device object if a device is found. This object will be passed to the open() method as the connected_device. If no device is found, return None. The returned object can be anything, calibre does not use it, it is only passed to open()."
905 msgstr ""
906
907 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.detect_managed_devices:9
908 msgid "This method is called periodically by the GUI, so make sure it is not too resource intensive. Use a cache to avoid repeatedly scanning the system."
909 msgstr ""
910
911 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.detect_managed_devices:13
912 msgid "Set of USB devices found on the system."
913 msgstr ""
914
915 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.detect_managed_devices:15
916 msgid "If True and the driver uses a cache to prevent repeated scanning, the cache must be flushed."
917 msgstr ""
918
919 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.debug_managed_device_detection:3
920 msgid "Should write information about the devices detected on the system to output, which is a file like object."
921 msgstr ""
922
923 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.debug_managed_device_detection:6
924 msgid "Should return True if a device was detected and successfully opened, otherwise False."
925 msgstr ""
926
927 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.reset:1
928 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.reset:1
929 msgid "The key to unlock the device"
930 msgstr ""
931
932 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.reset:2
933 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.reset:2
934 msgid "If true the packet stream to/from the device is logged"
935 msgstr ""
936
937 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.reset:3
938 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_progress_reporter:3
939 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.reset:3
940 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.set_progress_reporter:3
941 msgid "Function that is called with a % progress (number between 0 and 100) for various tasks. If it is called with -1 that means that the task does not have any progress information"
942 msgstr ""
943
944 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.reset:7
945 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.reset:7
946 msgid "Device information from the device scanner"
947 msgstr ""
948
949 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.can_handle_windows:1
950 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.can_handle_windows:1
951 msgid "Optional method to perform further checks on a device to see if this driver is capable of handling it. If it is not it should return False. This method is only called after the vendor, product ids and the bcd have matched, so it can do some relatively time intensive checks. The default implementation returns True. This method is called only on Windows. See also :meth:`can_handle`."
952 msgstr ""
953
954 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.can_handle_windows:8
955 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.can_handle_windows:8
956 msgid "Note that for devices based on USBMS this method by default delegates to :meth:`can_handle`. So you only need to override :meth:`can_handle` in your subclass of USBMS."
957 msgstr ""
958
959 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.can_handle_windows:12
960 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.can_handle_windows:12
961 msgid "A usbdevice as returned by :func:`calibre.devices.winusb.scan_usb_devices`"
962 msgstr ""
963
964 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.can_handle:1
965 msgid "Unix version of :meth:`can_handle_windows`."
966 msgstr ""
967
968 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.can_handle:3
969 msgid "Is a tuple of (vid, pid, bcd, manufacturer, product, serial number)"
970 msgstr ""
971
972 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.open:1
973 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.open:1
974 msgid "Perform any device specific initialization. Called after the device is detected but before any other functions that communicate with the device. For example: For devices that present themselves as USB Mass storage devices, this method would be responsible for mounting the device or if the device has been automounted, for finding out where it has been mounted. The method :meth:`calibre.devices.usbms.device.Device.open` has an implementation of this function that should serve as a good example for USB Mass storage devices."
975 msgstr ""
976
977 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.open:11
978 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.open:11
979 msgid "This method can raise an OpenFeedback exception to display a message to the user."
980 msgstr ""
981
982 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.open:14
983 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.open:14
984 msgid "The device that we are trying to open. It is a tuple of (vendor id, product id, bcd, manufacturer name, product name, device serial number). However, some devices have no serial number and on Windows only the first three fields are present, the rest are None."
985 msgstr ""
986
987 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.open:20
988 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.open:20
989 msgid "The UUID of the current calibre library. Can be None if there is no library (for example when used from the command line)."
990 msgstr ""
991
992 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.eject:1
993 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.eject:1
994 msgid "Un-mount / eject the device from the OS. This does not check if there are pending GUI jobs that need to communicate with the device."
995 msgstr ""
996
997 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.eject:4
998 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.eject:4
999 msgid "NOTE: That this method may not be called on the same thread as the rest of the device methods."
1000 msgstr ""
1001
1002 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.post_yank_cleanup:1
1003 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.post_yank_cleanup:1
1004 msgid "Called if the user yanks the device without ejecting it first."
1005 msgstr ""
1006
1007 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_progress_reporter:1
1008 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.set_progress_reporter:1
1009 msgid "Set a function to report progress information."
1010 msgstr ""
1011
1012 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_device_information:1
1013 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.get_device_information:1
1014 msgid "Ask device for device information. See L{DeviceInfoQuery}."
1015 msgstr ""
1016
1017 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_device_information:3
1018 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.get_device_information:3
1019 msgid "(device name, device version, software version on device, MIME type) The tuple can optionally have a fifth element, which is a drive information dictionary. See usbms.driver for an example."
1020 msgstr ""
1021
1022 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_driveinfo:1
1023 msgid "Return the driveinfo dictionary. Usually called from get_device_information(), but if loading the driveinfo is slow for this driver, then it should set SLOW_DRIVEINFO. In this case, this method will be called by calibre after the book lists have been loaded. Note that it is not called on the device thread, so the driver should cache the drive info in the books() method and this function should return the cached data."
1024 msgstr ""
1025
1026 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.card_prefix:1
1027 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.card_prefix:1
1028 msgid "Return a 2 element list of the prefix to paths on the cards. If no card is present None is set for the card's prefix. E.G. ('/place', '/place2') (None, 'place2') ('place', None) (None, None)"
1029 msgstr ""
1030
1031 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.total_space:1
1032 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.total_space:1
1033 msgid "Get total space available on the mountpoints:"
1034 msgstr ""
1035
1036 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.free_space:2
1037 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.total_space:2
1038 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.free_space:2
1039 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.total_space:2
1040 msgid "Main memory"
1041 msgstr ""
1042
1043 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.total_space:3
1044 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.total_space:3
1045 msgid "Memory Card A"
1046 msgstr ""
1047
1048 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.total_space:4
1049 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.total_space:4
1050 msgid "Memory Card B"
1051 msgstr ""
1052
1053 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.total_space:6
1054 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.total_space:6
1055 msgid "A 3 element list with total space in bytes of (1, 2, 3). If a particular device doesn't have any of these locations it should return 0."
1056 msgstr ""
1057
1058 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.free_space:1
1059 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.free_space:1
1060 msgid "Get free space available on the mountpoints:"
1061 msgstr ""
1062
1063 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.free_space:3
1064 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.free_space:3
1065 msgid "Card A"
1066 msgstr ""
1067
1068 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.free_space:4
1069 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.free_space:4
1070 msgid "Card B"
1071 msgstr ""
1072
1073 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.free_space:6
1074 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.free_space:6
1075 msgid "A 3 element list with free space in bytes of (1, 2, 3). If a particular device doesn't have any of these locations it should return -1."
1076 msgstr ""
1077
1078 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.books:1
1079 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.books:1
1080 msgid "Return a list of e-books on the device."
1081 msgstr ""
1082
1083 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.books:3
1084 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.books:3
1085 msgid "If 'carda' or 'cardb' return a list of e-books on the specific storage card, otherwise return list of e-books in main memory of device. If a card is specified and no books are on the card return empty list."
1086 msgstr ""
1087
1088 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.books:8
1089 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.books:8
1090 msgid "A BookList."
1091 msgstr ""
1092
1093 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.upload_books:1
1094 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_books:1
1095 msgid "Upload a list of books to the device. If a file already exists on the device, it should be replaced. This method should raise a :class:`FreeSpaceError` if there is not enough free space on the device. The text of the FreeSpaceError must contain the word \"card\" if ``on_card`` is not None otherwise it must contain the word \"memory\"."
1096 msgstr ""
1097
1098 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.upload_books:7
1099 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_books:7
1100 msgid "A list of paths"
1101 msgstr ""
1102
1103 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.upload_books:8
1104 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_books:8
1105 msgid "A list of file names that the books should have once uploaded to the device. len(names) == len(files)"
1106 msgstr ""
1107
1108 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.upload_books:10
1109 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_books:10
1110 msgid "If not None, it is a list of :class:`Metadata` objects. The idea is to use the metadata to determine where on the device to put the book. len(metadata) == len(files). Apart from the regular cover (path to cover), there may also be a thumbnail attribute, which should be used in preference. The thumbnail attribute is of the form (width, height, cover_data as jpeg)."
1111 msgstr ""
1112
1113 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.upload_books:17
1114 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_books:17
1115 msgid "A list of 3-element tuples. The list is meant to be passed to :meth:`add_books_to_metadata`."
1116 msgstr ""
1117
1118 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.add_books_to_metadata:1
1119 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.add_books_to_metadata:1
1120 msgid "Add locations to the booklists. This function must not communicate with the device."
1121 msgstr ""
1122
1123 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.add_books_to_metadata:4
1124 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.add_books_to_metadata:4
1125 msgid "Result of a call to L{upload_books}"
1126 msgstr ""
1127
1128 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.add_books_to_metadata:5
1129 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.add_books_to_metadata:5
1130 msgid "List of :class:`Metadata` objects, same as for :meth:`upload_books`."
1131 msgstr ""
1132
1133 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.add_books_to_metadata:7
1134 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.remove_books_from_metadata:5
1135 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.sync_booklists:3
1136 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.add_books_to_metadata:7
1137 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.remove_books_from_metadata:5
1138 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.sync_booklists:3
1139 msgid "A tuple containing the result of calls to (:meth:`books(oncard=None)`, :meth:`books(oncard='carda')`, :meth`books(oncard='cardb')`)."
1140 msgstr ""
1141
1142 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.delete_books:1
1143 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.delete_books:1
1144 msgid "Delete books at paths on device."
1145 msgstr ""
1146
1147 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.remove_books_from_metadata:1
1148 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.remove_books_from_metadata:1
1149 msgid "Remove books from the metadata list. This function must not communicate with the device."
1150 msgstr ""
1151
1152 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.remove_books_from_metadata:4
1153 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.remove_books_from_metadata:4
1154 msgid "paths to books on the device."
1155 msgstr ""
1156
1157 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.sync_booklists:1
1158 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.sync_booklists:1
1159 msgid "Update metadata on device."
1160 msgstr ""
1161
1162 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_file:1
1163 msgid "Read the file at ``path`` on the device and write it to outfile."
1164 msgstr ""
1165
1166 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_file:3
1167 msgid "file object like ``sys.stdout`` or the result of an :func:`open` call."
1168 msgstr ""
1169
1170 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.config_widget:1
1171 msgid "Should return a QWidget. The QWidget contains the settings for the device interface"
1172 msgstr ""
1173
1174 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.save_settings:1
1175 msgid "Should save settings to disk. Takes the widget created in :meth:`config_widget` and saves all settings to disk."
1176 msgstr ""
1177
1178 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.settings:1
1179 msgid "Should return an opts object. The opts object should have at least one attribute `format_map` which is an ordered list of formats for the device."
1180 msgstr ""
1181
1182 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_plugboards:1
1183 msgid "provide the driver the current set of plugboards and a function to select a specific plugboard. This method is called immediately before add_books and sync_booklists."
1184 msgstr ""
1185
1186 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_plugboards:5
1187 msgid "pb_func is a callable with the following signature::"
1188 msgstr ""
1189
1190 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_plugboards:6
1191 msgid "def pb_func(device_name, format, plugboards)"
1192 msgstr ""
1193
1194 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_plugboards:8
1195 msgid "You give it the current device name (either the class name or DEVICE_PLUGBOARD_NAME), the format you are interested in (a 'real' format or 'device_db'), and the plugboards (you were given those by set_plugboards, the same place you got this method)."
1196 msgstr ""
1197
1198 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_plugboards:13
1199 msgid "None or a single plugboard instance."
1200 msgstr ""
1201
1202 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_driveinfo_name:1
1203 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.set_driveinfo_name:1
1204 msgid "Set the device name in the driveinfo file to 'name'. This setting will persist until the file is re-created or the name is changed again."
1205 msgstr ""
1206
1207 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_driveinfo_name:4
1208 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.set_driveinfo_name:4
1209 msgid "Non-disk devices should implement this method based on the location codes returned by the get_device_information() method."
1210 msgstr ""
1211
1212 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.prepare_addable_books:1
1213 msgid "Given a list of paths, returns another list of paths. These paths point to addable versions of the books."
1214 msgstr ""
1215
1216 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.prepare_addable_books:4
1217 msgid "If there is an error preparing a book, then instead of a path, the position in the returned list for that book should be a three tuple: (original_path, the exception instance, traceback)"
1218 msgstr ""
1219
1220 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.startup:1
1221 msgid "Called when calibre is starting the device. Do any initialization required. Note that multiple instances of the class can be instantiated, and thus __init__ can be called multiple times, but only one instance will have this method called. This method is called on the device thread, not the GUI thread."
1222 msgstr ""
1223
1224 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.shutdown:1
1225 msgid "Called when calibre is shutting down, either for good or in preparation to restart. Do any cleanup required. This method is called on the device thread, not the GUI thread."
1226 msgstr ""
1227
1228 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_device_uid:1
1229 msgid "Must return a unique id for the currently connected device (this is called immediately after a successful call to open()). You must implement this method if you set ASK_TO_ALLOW_CONNECT = True"
1230 msgstr ""
1231
1232 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.ignore_connected_device:1
1233 msgid "Should ignore the device identified by uid (the result of a call to get_device_uid()) in the future. You must implement this method if you set ASK_TO_ALLOW_CONNECT = True. Note that this function is called immediately after open(), so if open() caches some state, the driver should reset that state."
1234 msgstr ""
1235
1236 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_user_blacklisted_devices:1
1237 msgid "Return map of device uid to friendly name for all devices that the user has asked to be ignored."
1238 msgstr ""
1239
1240 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_user_blacklisted_devices:1
1241 msgid "Set the list of device uids that should be ignored by this driver."
1242 msgstr ""
1243
1244 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.specialize_global_preferences:1
1245 msgid "Implement this method if your device wants to override a particular preference. You must ensure that all call sites that want a preference that can be overridden use device_prefs['something'] instead of prefs['something']. Your method should call device_prefs.set_overrides(pref=val, pref=val, ...). Currently used for: metadata management (prefs['manage_device_metadata'])"
1246 msgstr ""
1247
1248 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_library_info:1
1249 msgid "Implement this method if you want information about the current calibre library. This method is called at startup and when the calibre library changes while connected."
1250 msgstr ""
1251
1252 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.is_dynamically_controllable:1
1253 msgid "Called by the device manager when starting plugins. If this method returns a string, then a) it supports the device manager's dynamic control interface, and b) that name is to be used when talking to the plugin."
1254 msgstr ""
1255
1256 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_option:5
1257 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.is_dynamically_controllable:5
1258 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.is_running:3
1259 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_option:4
1260 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.start_plugin:5
1261 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.stop_plugin:6
1262 msgid "This method can be called on the GUI thread. A driver that implements this method must be thread safe."
1263 msgstr ""
1264
1265 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.start_plugin:1
1266 msgid "This method is called to start the plugin. The plugin should begin to accept device connections however it does that. If the plugin is already accepting connections, then do nothing."
1267 msgstr ""
1268
1269 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.stop_plugin:1
1270 msgid "This method is called to stop the plugin. The plugin should no longer accept connections, and should cleanup behind itself. It is likely that this method should call shutdown. If the plugin is already not accepting connections, then do nothing."
1271 msgstr ""
1272
1273 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.get_option:1
1274 msgid "Return the value of the option indicated by opt_string. This method can be called when the plugin is not started. Return None if the option does not exist."
1275 msgstr ""
1276
1277 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.set_option:1
1278 msgid "Set the value of the option indicated by opt_string. This method can be called when the plugin is not started."
1279 msgstr ""
1280
1281 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.is_running:1
1282 msgid "Return True if the plugin is started, otherwise false"
1283 msgstr ""
1284
1285 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.synchronize_with_db:1
1286 msgid "Called during book matching when a book on the device is matched with a book in calibre's db. The method is responsible for synchronizing data from the device to calibre's db (if needed)."
1287 msgstr ""
1288
1289 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.synchronize_with_db:5
1290 msgid "The method must return a two-value tuple. The first value is a set of calibre book ids changed if calibre's database was changed or None if the database was not changed. If the first value is an empty set then the metadata for the book on the device is updated with calibre's metadata and given back to the device, but no GUI refresh of that book is done. This is useful when the calibre data is correct but must be sent to the device."
1291 msgstr ""
1292
1293 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.synchronize_with_db:13
1294 msgid "The second value is itself a 2-value tuple. The first value in the tuple specifies whether a book format should be sent to the device. The intent is to permit verifying that the book on the device is the same as the book in calibre. This value must be None if no book is to be sent, otherwise return the base file name on the device (a string like foobar.epub). Be sure to include the extension in the name. The device subsystem will construct a send_books job for all books with not- None returned values. Note: other than to later retrieve the extension, the name is ignored in cases where the device uses a template to generate the file name, which most do. The second value in the returned tuple indicated whether the format is future-dated. Return True if it is, otherwise return False. calibre will display a dialog to the user listing all future dated books."
1295 msgstr ""
1296
1297 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.synchronize_with_db:27
1298 msgid "Extremely important: this method is called on the GUI thread. It must be threadsafe with respect to the device manager's thread."
1299 msgstr ""
1300
1301 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.DevicePlugin.synchronize_with_db:30
1302 msgid "book_id: the calibre id for the book in the database. book_metadata: the Metadata object for the book coming from the device. first_call: True if this is the first call during a sync, False otherwise"
1303 msgstr ""
1304
1305 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:1
1306 msgid "A list of books. Each Book object must have the fields"
1307 msgstr ""
1308
1309 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:3
1310 msgid "title"
1311 msgstr ""
1312
1313 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:4
1314 msgid "authors"
1315 msgstr ""
1316
1317 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:5
1318 msgid "size (file size of the book)"
1319 msgstr ""
1320
1321 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:6
1322 msgid "datetime (a UTC time tuple)"
1323 msgstr ""
1324
1325 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:7
1326 msgid "path (path on the device to the book)"
1327 msgstr ""
1328
1329 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:8
1330 msgid "thumbnail (can be None) thumbnail is either a str/bytes object with the image data or it should have an attribute image_path that stores an absolute (platform native) path to the image"
1331 msgstr ""
1332
1333 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList:11
1334 msgid "tags (a list of strings, can be empty)."
1335 msgstr ""
1336
1337 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList.supports_collections:1
1338 msgid "Return True if the device supports collections for this book list."
1339 msgstr ""
1340
1341 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList.add_book:1
1342 msgid "Add the book to the booklist. Intent is to maintain any device-internal metadata. Return True if booklists must be sync'ed"
1343 msgstr ""
1344
1345 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList.remove_book:1
1346 msgid "Remove a book from the booklist. Correct any device metadata at the same time"
1347 msgstr ""
1348
1349 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList.get_collections:1
1350 msgid "Return a dictionary of collections created from collection_attributes. Each entry in the dictionary is of the form collection name:[list of books]"
1351 msgstr ""
1352
1353 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList.get_collections:5
1354 msgid "The list of books is sorted by book title, except for collections created from series, in which case series_index is used."
1355 msgstr ""
1356
1357 #: ../../../home/kovid/work/calibre/src/calibre/devices/interface.py:docstring of calibre.devices.interface.BookList.get_collections:8
1358 msgid "A list of attributes of the Book object"
1359 msgstr ""
1360
1361 #: ../../../home/kovid/work/calibre/manual/plugins.rst:110
1362 msgid "USB Mass Storage based devices"
1363 msgstr ""
1364
1365 #: ../../../home/kovid/work/calibre/manual/plugins.rst:112
1366 msgid "The base class for such devices is :class:`calibre.devices.usbms.driver.USBMS`. This class in turn inherits some of its functionality from its bases, documented below. A typical basic USBMS based driver looks like this:"
1367 msgstr ""
1368
1369 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device:1
1370 msgid "This class provides logic common to all drivers for devices that export themselves as USB Mass Storage devices. Provides implementations for mounting/ejecting of USBMS devices on all platforms."
1371 msgstr ""
1372
1373 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.WINDOWS_MAIN_MEM:1
1374 msgid "String identifying the main memory of the device in the Windows PnP id strings This can be None, string, list of strings or compiled regex"
1375 msgstr ""
1376
1377 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.WINDOWS_CARD_A_MEM:1
1378 msgid "String identifying the first card of the device in the Windows PnP id strings This can be None, string, list of strings or compiled regex"
1379 msgstr ""
1380
1381 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.WINDOWS_CARD_B_MEM:1
1382 msgid "String identifying the second card of the device in the Windows PnP id strings This can be None, string, list of strings or compiled regex"
1383 msgstr ""
1384
1385 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.OSX_MAIN_MEM_VOL_PAT:1
1386 msgid "Used by the new driver detection to disambiguate main memory from storage cards. Should be a regular expression that matches the main memory mount point assigned by macOS"
1387 msgstr ""
1388
1389 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.MAX_PATH_LEN:1
1390 msgid "The maximum length of paths created on the device"
1391 msgstr ""
1392
1393 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.NEWS_IN_FOLDER:1
1394 msgid "Put news in its own folder"
1395 msgstr ""
1396
1397 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.windows_sort_drives:1
1398 msgid "Called to disambiguate main memory and storage card for devices that do not distinguish between them on the basis of `WINDOWS_CARD_NAME`. For example: The EB600"
1399 msgstr ""
1400
1401 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.sanitize_callback:1
1402 msgid "Callback to allow individual device drivers to override the path sanitization used by :meth:`create_upload_path`."
1403 msgstr ""
1404
1405 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.filename_callback:1
1406 msgid "Callback to allow drivers to change the default file name set by :meth:`create_upload_path`."
1407 msgstr ""
1408
1409 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.sanitize_path_components:1
1410 msgid "Perform any device specific sanitization on the path components for files to be uploaded to the device"
1411 msgstr ""
1412
1413 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.get_annotations:1
1414 msgid "Resolve path_map to annotation_map of files found on the device"
1415 msgstr ""
1416
1417 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/device.py:docstring of calibre.devices.usbms.device.Device.add_annotation_to_library:1
1418 msgid "Add an annotation to the calibre library"
1419 msgstr ""
1420
1421 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS:1
1422 msgid "The base class for all USBMS devices. Implements the logic for sending/getting/updating metadata/caching metadata/etc."
1423 msgstr ""
1424
1425 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_cover:1
1426 msgid "Upload book cover to the device. Default implementation does nothing."
1427 msgstr ""
1428
1429 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_cover:3
1430 msgid "The full path to the folder where the associated book is located."
1431 msgstr ""
1432
1433 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_cover:4
1434 msgid "The name of the book file without the extension."
1435 msgstr ""
1436
1437 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_cover:5
1438 msgid "metadata belonging to the book. Use metadata.thumbnail for cover"
1439 msgstr ""
1440
1441 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.upload_cover:7
1442 msgid "The full path to the e-book file"
1443 msgstr ""
1444
1445 #: ../../../home/kovid/work/calibre/src/calibre/devices/usbms/driver.py:docstring of calibre.devices.usbms.driver.USBMS.normalize_path:1
1446 msgid "Return path with platform native path separators"
1447 msgstr ""
1448
1449 #: ../../../home/kovid/work/calibre/manual/plugins.rst:157
1450 msgid "User interface actions"
1451 msgstr ""
1452
1453 #: ../../../home/kovid/work/calibre/manual/plugins.rst:159
1454 msgid "If you are adding your own plugin in a ZIP file, you should subclass both InterfaceActionBase and InterfaceAction. The :meth:`load_actual_plugin` method of your InterfaceActionBase subclass must return an instantiated object of your InterfaceAction subclass."
1455 msgstr ""
1456
1457 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction:1
1458 msgid "A plugin representing an \"action\" that can be taken in the graphical user interface. All the items in the toolbar and context menus are implemented by these plugins."
1459 msgstr ""
1460
1461 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction:5
1462 msgid "Note that this class is the base class for these plugins, however, to integrate the plugin with calibre's plugin system, you have to make a wrapper class that references the actual plugin. See the :mod:`calibre.customize.builtins` module for examples."
1463 msgstr ""
1464
1465 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction:10
1466 msgid "If two :class:`InterfaceAction` objects have the same name, the one with higher priority takes precedence."
1467 msgstr ""
1468
1469 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction:13
1470 msgid "Sub-classes should implement the :meth:`genesis`, :meth:`library_changed`, :meth:`location_selected`, :meth:`shutting_down`, :meth:`initialization_complete` and :meth:`tag_browser_context_action` methods."
1471 msgstr ""
1472
1473 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction:17
1474 msgid "Once initialized, this plugin has access to the main calibre GUI via the :attr:`gui` member. You can access other plugins by name, for example::"
1475 msgstr ""
1476
1477 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction:22
1478 msgid "To access the actual plugin, use the :attr:`interface_action_base_plugin` attribute, this attribute only becomes available after the plugin has been initialized. Useful if you want to use methods from the plugin class like do_user_config()."
1479 msgstr ""
1480
1481 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction:27
1482 msgid "The QAction specified by :attr:`action_spec` is automatically create and made available as ``self.qaction``."
1483 msgstr ""
1484
1485 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.name:1
1486 msgid "The plugin name. If two plugins with the same name are present, the one with higher priority takes precedence."
1487 msgstr ""
1488
1489 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.priority:1
1490 msgid "The plugin priority. If two plugins with the same name are present, the one with higher priority takes precedence."
1491 msgstr ""
1492
1493 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.popup_type:1
1494 msgid "The menu popup type for when this plugin is added to a toolbar"
1495 msgstr ""
1496
1497 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.auto_repeat:1
1498 msgid "Whether this action should be auto repeated when its shortcut key is held down."
1499 msgstr ""
1500
1501 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.action_spec:1
1502 msgid "Of the form: (text, icon_path, tooltip, keyboard shortcut). icon, tooltip and keyboard shortcut can be None. keyboard shortcut must be either a string, None or tuple of shortcuts. If None, a keyboard shortcut corresponding to the action is not registered. If you pass an empty tuple, then the shortcut is registered with no default key binding."
1503 msgstr ""
1504
1505 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.action_shortcut_name:1
1506 msgid "If not None, used for the name displayed to the user when customizing the keyboard shortcuts for the above action spec instead of action_spec[0]"
1507 msgstr ""
1508
1509 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.action_add_menu:1
1510 msgid "If True, a menu is automatically created and added to self.qaction"
1511 msgstr ""
1512
1513 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.action_menu_clone_qaction:1
1514 msgid "If True, a clone of self.qaction is added to the menu of self.qaction If you want the text of this action to be different from that of self.qaction, set this variable to the new text"
1515 msgstr ""
1516
1517 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.dont_add_to:1
1518 msgid "Set of locations to which this action must not be added. See :attr:`all_locations` for a list of possible locations"
1519 msgstr ""
1520
1521 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.dont_remove_from:1
1522 msgid "Set of locations from which this action must not be removed. See :attr:`all_locations` for a list of possible locations"
1523 msgstr ""
1524
1525 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.action_type:1
1526 msgid "Type of action 'current' means acts on the current view 'global' means an action that does not act on the current view, but rather on calibre as a whole"
1527 msgstr ""
1528
1529 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.accepts_drops:1
1530 msgid "If True, then this InterfaceAction will have the opportunity to interact with drag and drop events. See the methods, :meth:`accept_enter_event`, :meth`:accept_drag_move_event`, :meth:`drop_event` for details."
1531 msgstr ""
1532
1533 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.accept_drag_move_event:1
1534 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.accept_enter_event:1
1535 msgid "This method should return True iff this interface action is capable of handling the drag event. Do not call accept/ignore on the event, that will be taken care of by the calibre UI."
1536 msgstr ""
1537
1538 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.drop_event:1
1539 msgid "This method should perform some useful action and return True iff this interface action is capable of handling the drop event. Do not call accept/ignore on the event, that will be taken care of by the calibre UI. You should not perform blocking/long operations in this function. Instead emit a signal or use QTimer.singleShot and return quickly. See the builtin actions for examples."
1540 msgstr ""
1541
1542 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:1
1543 msgid "Convenience method to easily add actions to a QMenu. Returns the created QAction. This action has one extra attribute calibre_shortcut_unique_name which if not None refers to the unique name under which this action is registered with the keyboard manager."
1544 msgstr ""
1545
1546 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:6
1547 msgid "The QMenu the newly created action will be added to"
1548 msgstr ""
1549
1550 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:7
1551 msgid "A unique name for this action, this must be globally unique, so make it as descriptive as possible. If in doubt, add an UUID to it."
1552 msgstr ""
1553
1554 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:10
1555 msgid "The text of the action."
1556 msgstr ""
1557
1558 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:11
1559 msgid "Either a QIcon or a file name. The file name is passed to the QIcon.ic() builtin, so you do not need to pass the full path to the images folder."
1560 msgstr ""
1561
1562 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:14
1563 msgid "A string, a list of strings, None or False. If False, no keyboard shortcut is registered for this action. If None, a keyboard shortcut with no default keybinding is registered. String and list of strings register a shortcut with default keybinding as specified."
1564 msgstr ""
1565
1566 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:18
1567 msgid "A description for this action. Used to set tooltips."
1568 msgstr ""
1569
1570 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:20
1571 msgid "A callable which is connected to the triggered signal of the created action."
1572 msgstr ""
1573
1574 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:22
1575 msgid "The text displayed to the user when customizing the keyboard shortcuts for this action. By default it is set to the value of ``text``."
1576 msgstr ""
1577
1578 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.create_menu_action:25
1579 msgid "Shortcuts for actions that don't always appear, or are library dependent, may disappear when other keyboard shortcuts are edited unless ```persist_shortcut``` is set True."
1580 msgstr ""
1581
1582 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.load_resources:12
1583 msgid "A dictionary of the form ``{name : file_contents}``. Any names that were not found in the ZIP file will not be present in the dictionary."
1584 msgstr ""
1585
1586 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.genesis:1
1587 msgid "Setup this plugin. Only called once during initialization. self.gui is available. The action specified by :attr:`action_spec` is available as ``self.qaction``."
1588 msgstr ""
1589
1590 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.location_selected:1
1591 msgid "Called whenever the book list being displayed in calibre changes. Currently values for loc are: ``library, main, card and cardb``."
1592 msgstr ""
1593
1594 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.location_selected:4
1595 msgid "This method should enable/disable this action and its sub actions as appropriate for the location."
1596 msgstr ""
1597
1598 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.library_about_to_change:1
1599 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.library_changed:1
1600 msgid "Called whenever the current library is changed."
1601 msgstr ""
1602
1603 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.library_about_to_change:3
1604 msgid "The LibraryDatabase corresponding to the previous library."
1605 msgstr ""
1606
1607 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.library_about_to_change:4
1608 msgid "The LibraryDatabase corresponding to the new library."
1609 msgstr ""
1610
1611 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.library_changed:3
1612 msgid "The LibraryDatabase corresponding to the current library."
1613 msgstr ""
1614
1615 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.gui_layout_complete:1
1616 msgid "Called once per action when the layout of the main GUI is completed. If your action needs to make changes to the layout, they should be done here, rather than in :meth:`initialization_complete`."
1617 msgstr ""
1618
1619 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.initialization_complete:1
1620 msgid "Called once per action when the initialization of the main GUI is completed."
1621 msgstr ""
1622
1623 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.tag_browser_context_action:1
1624 msgid "Called when displaying the context menu in the Tag browser. ``index`` is the QModelIndex that points to the Tag browser item that was right clicked. Test it for validity with index.valid() and get the underlying TagTreeItem object with index.data(Qt.ItemDataRole.UserRole). Any action objects yielded by this method will be added to the context menu."
1625 msgstr ""
1626
1627 #: ../../../home/kovid/work/calibre/src/calibre/gui2/actions/__init__.py:docstring of calibre.gui2.actions.InterfaceAction.shutting_down:1
1628 msgid "Called once per plugin when the main GUI is in the process of shutting down. Release any used resources, but try not to block the shutdown for long periods of time."
1629 msgstr ""
1630
1631 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.InterfaceActionBase.load_actual_plugin:1
1632 msgid "This method must return the actual interface action plugin object."
1633 msgstr ""
1634
1635 #: ../../../home/kovid/work/calibre/manual/plugins.rst:175
1636 msgid "Preferences plugins"
1637 msgstr ""
1638
1639 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin:1
1640 msgid "A plugin representing a widget displayed in the Preferences dialog."
1641 msgstr ""
1642
1643 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin:3
1644 msgid "This plugin has only one important method :meth:`create_widget`. The various fields of the plugin control how it is categorized in the UI."
1645 msgstr ""
1646
1647 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.config_widget:1
1648 msgid "Import path to module that contains a class named ConfigWidget which implements the ConfigWidgetInterface. Used by :meth:`create_widget`."
1649 msgstr ""
1650
1651 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.category_order:1
1652 msgid "Where in the list of categories the :attr:`category` of this plugin should be."
1653 msgstr ""
1654
1655 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.name_order:1
1656 msgid "Where in the list of names in a category, the :attr:`gui_name` of this plugin should be"
1657 msgstr ""
1658
1659 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.category:1
1660 msgid "The category this plugin should be in"
1661 msgstr ""
1662
1663 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.gui_category:1
1664 msgid "The category name displayed to the user for this plugin"
1665 msgstr ""
1666
1667 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.gui_name:1
1668 msgid "The name displayed to the user for this plugin"
1669 msgstr ""
1670
1671 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.icon:1
1672 msgid "The icon for this plugin, should be an absolute path"
1673 msgstr ""
1674
1675 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.description:1
1676 msgid "The description used for tooltips and the like"
1677 msgstr ""
1678
1679 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.create_widget:1
1680 msgid "Create and return the actual Qt widget used for setting this group of preferences. The widget must implement the :class:`calibre.gui2.preferences.ConfigWidgetInterface`."
1681 msgstr ""
1682
1683 #: ../../../home/kovid/work/calibre/src/calibre/customize/__init__.py:docstring of calibre.customize.PreferencesPlugin.create_widget:5
1684 msgid "The default implementation uses :attr:`config_widget` to instantiate the widget."
1685 msgstr ""
1686
1687 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface:1
1688 msgid "This class defines the interface that all widgets displayed in the Preferences dialog must implement. See :class:`ConfigWidgetBase` for a base class that implements this interface and defines various convenience methods as well."
1689 msgstr ""
1690
1691 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.changed_signal:1
1692 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.changed_signal:1
1693 msgid "This signal must be emitted whenever the user changes a value in this widget"
1694 msgstr ""
1695
1696 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.supports_restoring_to_defaults:1
1697 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.supports_restoring_to_defaults:1
1698 msgid "Set to True iff the :meth:`restore_to_defaults` method is implemented."
1699 msgstr ""
1700
1701 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.restore_defaults_desc:1
1702 msgid "The tooltip for the \"Restore defaults\" button"
1703 msgstr ""
1704
1705 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.restart_critical:1
1706 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.restart_critical:1
1707 msgid "If True the Preferences dialog will not allow the user to set any more preferences. Only has effect if :meth:`commit` returns True."
1708 msgstr ""
1709
1710 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.genesis:1
1711 msgid "Called once before the widget is displayed, should perform any necessary setup."
1712 msgstr ""
1713
1714 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.genesis:4
1715 msgid "The main calibre graphical user interface"
1716 msgstr ""
1717
1718 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.initialize:1
1719 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.initialize:1
1720 msgid "Should set all config values to their initial values (the values stored in the config files). A \"return\" statement is optional. Return False if the dialog is not to be shown."
1721 msgstr ""
1722
1723 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.restore_defaults:1
1724 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.restore_defaults:1
1725 msgid "Should set all config values to their defaults."
1726 msgstr ""
1727
1728 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.commit:1
1729 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.commit:1
1730 msgid "Save any changed settings. Return True if the changes require a restart, False otherwise. Raise an :class:`AbortCommit` exception to indicate that an error occurred. You are responsible for giving the user feedback about what the error is and how to correct it."
1731 msgstr ""
1732
1733 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.refresh_gui:1
1734 msgid "Called once after this widget is committed. Responsible for causing the gui to reread any changed settings. Note that by default the GUI re-initializes various elements anyway, so most widgets won't need to use this method."
1735 msgstr ""
1736
1737 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetInterface.initial_tab_changed:1
1738 msgid "Called if the initially displayed tab is changed before the widget is shown, but after it is initialized."
1739 msgstr ""
1740
1741 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase:1
1742 msgid "Base class that contains code to easily add standard config widgets like checkboxes, combo boxes, text fields and so on. See the :meth:`register` method."
1743 msgstr ""
1744
1745 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase:5
1746 msgid "This class automatically handles change notification, resetting to default, translation between gui objects and config objects, etc. for registered settings."
1747 msgstr ""
1748
1749 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase:9
1750 msgid "If your config widget inherits from this class but includes setting that are not registered, you should override the :class:`ConfigWidgetInterface` methods and call the base class methods inside the overrides."
1751 msgstr ""
1752
1753 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.register:1
1754 msgid "Register a setting."
1755 msgstr ""
1756
1757 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.register:3
1758 msgid "The setting name"
1759 msgstr ""
1760
1761 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.register:4
1762 msgid "The config object that reads/writes the setting"
1763 msgstr ""
1764
1765 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.register:5
1766 msgid "The name of the GUI object that presents an interface to change the setting. By default it is assumed to be ``'opt_' + name``."
1767 msgstr ""
1768
1769 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.register:8
1770 msgid "If this setting is a multiple choice (combobox) based setting, the list of choices. The list is a list of two element tuples of the form: ``[(gui name, value), ...]``"
1771 msgstr ""
1772
1773 #: ../../../home/kovid/work/calibre/src/calibre/gui2/preferences/__init__.py:docstring of calibre.gui2.preferences.ConfigWidgetBase.register:11
1774 msgid "The class responsible for managing this setting. The default class handles almost all cases, so this param is rarely used."
1775 msgstr ""