Changeset 31987 for main/trunk/greenstone2/perllib

Timestamp:

2017-09-25T11:30:01+13:00 (7 years ago)

Author:

kjdon

Message:

changed a couple of descriptions after queries from John Rose

File:

• main/trunk/greenstone2/perllib/strings.properties (modified) (2 diffs)

main/trunk/greenstone2/perllib/strings.properties

@@ -285 +285 @@
 import.maxdocs:Maximum number of documents to import.
 
-import.NO_IMPORT:Prevents import.pl from running. Set this in the collection's config file if you are using web document editing, to prevent import.pl from being run and deleting all your edits.
+import.NO_IMPORT:Prevents import.pl from running. (Note, for Greenstone 3 collections with document editing via the web enabled, running import.pl will delete any edits. Set this option in the collection's configuration file to prevent import.pl from being run accidentally.)
 
 import.NO_IMPORT_set:Not continuing with import as -NO_IMPORT is set.
@@ -1271 +1271 @@
 TextPlugin.title_sub:Substitution expression to modify string stored as Title. Used by, for example, PostScriptPlugin to remove "Page 1" etc from text used as the title.
 
-UnknownConverterPlugin.desc:If you have a custom conversion tool installed that you're able to run from the command line to convert from an unsupported document format to text, HTML or a series of images in jpg, png or gif form, then provide that command to this Plugin. It will then run the command for you, capturing the output for indexing by Greenstone, making any documents that aren't converted to images searchable. Set the process_extension to the suffix of files to be converted. Set convert_to to be the output format that the conversion command will generate, which will determine the output file's suffix. Use %INPUT_FILE and %OUTPUT as place holders in the command, which Greenstone will replace. It will pass in the full path to each file that matches the process_extension suffix in turn as %INPUT_FILE. %OUTPUT will be replaced with a path in the temporary folder of the output file with suffix determined by the value of convert_to. If convert_to is a pagedimg type, Greenstone sets %OUTPUT to be a directory to contain the expected files and will create an item file collating the parts of the document.
-
-UnknownConverterPlugin.exec_cmd:Command line command string to execute that will do the conversion. Quoted elements need to have the quotes escaped with a backslash to preserve them. Use %INPUT_FILE and %OUTPUT as place holders in the command.
+UnknownConverterPlugin.desc:If you have a custom conversion tool installed that you're able to run from the command line to convert from an unsupported document format to text, HTML or a series of images in jpg, png or gif form, then provide that command to this Plugin. It will then run the command for you, capturing the output for indexing by Greenstone, making the documents (if converted to text or HTML) searchable. Set the -process_extension option to the suffix of files to be converted. Set -convert_to to be the output format that the conversion command will generate, which will determine the output file's suffix. -exec_cmd supplies the command to be run. 
+
+UnknownConverterPlugin.exec_cmd:Command line command string to execute that will do the conversion. Quoted elements need to have the quotes escaped with a backslash to preserve them. Use %%INPUT_FILE and %%OUTPUT as place holders in the command for input filename, and output filename, respectively. Greenstone will replace these with the correct values when calling the command. If -convert_to is a pagedimg type, Greenstone sets %%OUTPUT to be a directory to contain the expected files and will create an item file collating the parts of the document.
 
 UnknownConverterPlugin.output_file_or_dir_name: Full pathname of the output file or of the directory (of output files) that get generated by the conversion