Skip to content

Commit

Permalink
Additional small rephrasings
Browse files Browse the repository at this point in the history
  • Loading branch information
kelson42 committed Mar 5, 2024
1 parent 01edc5d commit dd81063
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/parameterList.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ export const requiredParams = ['mwUrl', 'adminEmail']
export const parameterDescriptions = {
mwUrl: 'MediaWiki base URL (any URL paths appending)',
adminEmail: 'Email of the MWoffliner operator. Will be put in the HTTP user-agent string for information only',
articleList: 'List of articles to include. Can be a comma separated list of titles or a local path or http(s) URL to a file with one title (in UTF8) per line',
articleList: 'List of articles to include. Comma separated list of titles or a local path or HTTP(S) URL to a file with one title (in UTF8) per line',
articleListToIgnore: 'List of articles to ignore. Comma separated list of titles or local path or HTTP(S) URL to a file with one title (in UTF8) per line',
customZimFavicon: 'Path/URL to a PNG favicon (will be resized to 49x49). Default to MediaWiki if not set',
customZimFavicon: 'Local path or HTTP(S) URL to a PNG favicon (will be resized to 48x48). Default to MediaWiki if not set',
customZimTitle: 'ZIM custom title metadata (30 characters max)',
customZimDescription: 'ZIM custom description (80 characters max)',
customZimLongDescription: 'ZIM custom long description (4000 characters max)',
customZimTags: 'ZIM tags metadata (semi-colon separated)',
customZimLanguage: 'ZIM ISO639-3 content language code',
customMainPage: 'Allow to configure a custom page as welcome page.',
customZimLanguage: 'ZIM ISO 639-3 content language code',
customMainPage: 'Custom page to be used as welcome page.',
filenamePrefix: 'Part of the ZIM filename which is before the format & date parts.',
format:
'Specify a flavour for the scraping. If missing, scrape all article contents. Each --format argument will cause a new local file to be created but options can be combined. Supported options are:\n * novid: no video & audio content\n * nopic: no pictures (implies "novid")\n * nopdf: no PDF files\n * nodet: only the first/head paragraph (implies "novid")\nFlavour can be named (and corresponding ZIM metadata will be created) using a ":":\nExample: "--format=nopic,nodet:mini"',
'Flavour for the scraping. If missing, scrape all article contents. Each --format argument will cause a new local file to be created but options can be combined. Supported options are:\n * novid: no video & audio content\n * nopic: no pictures (implies "novid")\n * nopdf: no PDF files\n * nodet: only the first/head paragraph (implies "novid")\nFlavour can be named (and corresponding ZIM metadata will be created) using a ":":\nExample: "--format=nopic,nodet:mini"',
keepEmptyParagraphs: 'Keep all paragraphs, even empty ones.',
mwWikiPath: 'MediaWiki wiki base path (by default "/wiki/")',
mwActionApiPath: 'MediaWiki API path (by default "/w/api.php")',
Expand All @@ -28,8 +28,8 @@ export const parameterDescriptions = {
outputDirectory: 'Directory to write the downloaded content',
publisher: "ZIM publisher meta data, by default 'Kiwix'",
redis: 'Redis path (redis:// URL or path to UNIX socket)',
requestTimeout: 'Request timeout - in seconds(default value is 120 seconds)',
resume: 'Do not overwrite if ZIM file already created and goes to next one to create (or ends)',
requestTimeout: 'Request timeout in seconds (defaultis 120s)',
resume: 'Skip already existing/created ZIM files',
speed: 'Multiplicator for the number of parallel HTTP requests on Parsoid backend (by default the number of CPU cores). The default value is 1.',
verbose:
'Print logging information to standard streams. To filter messages, one of the following values can be given: "info", "log", "warn", "error" or "quiet" (default level being "error"). All messages are printed from the given value and higher/worse.',
Expand Down

0 comments on commit dd81063

Please sign in to comment.