diff --git a/FolderScanning.md b/FolderScanning.md new file mode 100644 index 000000000..309b063c2 --- /dev/null +++ b/FolderScanning.md @@ -0,0 +1,41 @@ +## User Guide for Local Directory Scanning and File Processing + +### Whilst Pipelines are in alpha... +You must enable this alpha functionality by setting +``` +system: + enableAlphaFunctionality: true +``` +To true like in the above for your `/config/settings.yml` file, after restarting Stirling-PDF you should see both UI and folder scanning enabled. + +### Setting Up Watched Folders: +- Create a folder where you want your files to be monitored. This is your 'watched folder'. +- The default directory for this is `./pipeline/watchedFolders/` +- Place any directories you want to be scanned into this folder, this folder should contain multiple folders each for their own tasks and pipelines. + +### Configuring Processing with JSON Files: +- In each directory you want processed (e.g `./pipeline/watchedFolders/officePrinter`), include a JSON configuration file. +- This JSON file should specify how you want the files in the directory to be handled (e.g., what operations to perform on them) which can be made, configured and downloaded from Stirling-PDF Pipeline interface.r + +### Automatic Scanning and Processing: +- The system automatically checks the watched folder every minute for new directories and files to process. +- When a directory with a valid JSON configuration file is found, it begins processing the files inside as per the configuration. + +### Processing Steps: +- Files in each directory are processed according to the instructions in the JSON file. +- This might involve file conversions, data filtering, renaming files, etc. If the output of a step is a zip, this zip will be automatically unzipped as it passes to next process. + +### Results and Output: +- After processing, the results are saved in a specified output location. This could be a different folder or location as defined in the JSON file or the default location `./pipeline/finishedFolders/`. +- Each processed file is named and organized according to the rules set in the JSON configuration. + +### Completion and Cleanup: +- Once processing is complete, the original files in the watched folder's directory are removed. +- You can find the processed files in the designated output location. + +### Error Handling: +- If there's an error during processing, the system will not delete the original files, allowing you to check and retry if necessary. + +### User Interaction: +- As a user, your main tasks are to set up the watched folders, place directories with files for processing, and create the corresponding JSON configuration files. +- The system handles the rest, including scanning, processing, and outputting results. diff --git a/PipelineUsage.md b/PipelineUsage.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/main/resources/messages_ar_AR.properties b/src/main/resources/messages_ar_AR.properties index 1af763deb..cac25052e 100644 --- a/src/main/resources/messages_ar_AR.properties +++ b/src/main/resources/messages_ar_AR.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_bg_BG.properties b/src/main/resources/messages_bg_BG.properties index af6616981..e31749ca8 100644 --- a/src/main/resources/messages_bg_BG.properties +++ b/src/main/resources/messages_bg_BG.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_ca_CA.properties b/src/main/resources/messages_ca_CA.properties index a8b78d387..406eee890 100644 --- a/src/main/resources/messages_ca_CA.properties +++ b/src/main/resources/messages_ca_CA.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_de_DE.properties b/src/main/resources/messages_de_DE.properties index 2d17a376e..082918c37 100644 --- a/src/main/resources/messages_de_DE.properties +++ b/src/main/resources/messages_de_DE.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_el_GR.properties b/src/main/resources/messages_el_GR.properties index cbfa8e0cd..83bf96b46 100644 --- a/src/main/resources/messages_el_GR.properties +++ b/src/main/resources/messages_el_GR.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_en_GB.properties b/src/main/resources/messages_en_GB.properties index 21fcf4de6..c6da18c2b 100644 --- a/src/main/resources/messages_en_GB.properties +++ b/src/main/resources/messages_en_GB.properties @@ -66,8 +66,9 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here +pipelineOptions.selectOperation=Select Operation pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: pipelineOptions.saveButton=Download diff --git a/src/main/resources/messages_en_US.properties b/src/main/resources/messages_en_US.properties index bb432428e..d6f7ef711 100644 --- a/src/main/resources/messages_en_US.properties +++ b/src/main/resources/messages_en_US.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_es_ES.properties b/src/main/resources/messages_es_ES.properties index b363db4bf..887b14de0 100644 --- a/src/main/resources/messages_es_ES.properties +++ b/src/main/resources/messages_es_ES.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_eu_ES.properties b/src/main/resources/messages_eu_ES.properties index 57bf53e75..ef9b628a6 100644 --- a/src/main/resources/messages_eu_ES.properties +++ b/src/main/resources/messages_eu_ES.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_fr_FR.properties b/src/main/resources/messages_fr_FR.properties index e74a5b771..80da3038d 100644 --- a/src/main/resources/messages_fr_FR.properties +++ b/src/main/resources/messages_fr_FR.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_hi_IN.properties b/src/main/resources/messages_hi_IN.properties index 5e1df2e56..a44f3c5b4 100644 --- a/src/main/resources/messages_hi_IN.properties +++ b/src/main/resources/messages_hi_IN.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_hu_HU.properties b/src/main/resources/messages_hu_HU.properties index f25f07c1f..7a43b8ce3 100644 --- a/src/main/resources/messages_hu_HU.properties +++ b/src/main/resources/messages_hu_HU.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_id_ID.properties b/src/main/resources/messages_id_ID.properties index 100035701..b3ed56a9b 100644 --- a/src/main/resources/messages_id_ID.properties +++ b/src/main/resources/messages_id_ID.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_ja_JP.properties b/src/main/resources/messages_ja_JP.properties index 429eb87a8..7ba8b2062 100644 --- a/src/main/resources/messages_ja_JP.properties +++ b/src/main/resources/messages_ja_JP.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_ko_KR.properties b/src/main/resources/messages_ko_KR.properties index 881803da1..0213dc79b 100644 --- a/src/main/resources/messages_ko_KR.properties +++ b/src/main/resources/messages_ko_KR.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_nl_NL.properties b/src/main/resources/messages_nl_NL.properties index 88a162cb5..bcfa528c0 100644 --- a/src/main/resources/messages_nl_NL.properties +++ b/src/main/resources/messages_nl_NL.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_pl_PL.properties b/src/main/resources/messages_pl_PL.properties index 9a17999aa..5d08a3467 100644 --- a/src/main/resources/messages_pl_PL.properties +++ b/src/main/resources/messages_pl_PL.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_pt_BR.properties b/src/main/resources/messages_pt_BR.properties index a7c1aa06c..5002f064f 100644 --- a/src/main/resources/messages_pt_BR.properties +++ b/src/main/resources/messages_pt_BR.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_ro_RO.properties b/src/main/resources/messages_ro_RO.properties index 6dfe1052b..dbbd73d2c 100644 --- a/src/main/resources/messages_ro_RO.properties +++ b/src/main/resources/messages_ro_RO.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_ru_RU.properties b/src/main/resources/messages_ru_RU.properties index 7caaf4427..1b6fa7f0a 100644 --- a/src/main/resources/messages_ru_RU.properties +++ b/src/main/resources/messages_ru_RU.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_sv_SE.properties b/src/main/resources/messages_sv_SE.properties index cf26689b8..85e2559cf 100644 --- a/src/main/resources/messages_sv_SE.properties +++ b/src/main/resources/messages_sv_SE.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_tr_TR.properties b/src/main/resources/messages_tr_TR.properties index d55302269..f3071b007 100644 --- a/src/main/resources/messages_tr_TR.properties +++ b/src/main/resources/messages_tr_TR.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_zh_CN.properties b/src/main/resources/messages_zh_CN.properties index 737b221dc..7498b0c93 100644 --- a/src/main/resources/messages_zh_CN.properties +++ b/src/main/resources/messages_zh_CN.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/messages_zh_TW.properties b/src/main/resources/messages_zh_TW.properties index 4caa4e842..b6a8811c6 100644 --- a/src/main/resources/messages_zh_TW.properties +++ b/src/main/resources/messages_zh_TW.properties @@ -66,7 +66,7 @@ pipeline.submitButton=Submit ###################### pipelineOptions.header=Pipeline Configuration pipelineOptions.pipelineNameLabel=Pipeline Name -pipelineOptions.saveSettings=Save Settings +pipelineOptions.saveSettings=Save Operation Settings pipelineOptions.pipelineNamePrompt=Enter pipeline name here pipelineOptions.addOperationButton=Add operation pipelineOptions.pipelineHeader=Pipeline: diff --git a/src/main/resources/static/js/languageSelection.js b/src/main/resources/static/js/languageSelection.js index c554c2a7a..a5e7be2a3 100644 --- a/src/main/resources/static/js/languageSelection.js +++ b/src/main/resources/static/js/languageSelection.js @@ -61,9 +61,7 @@ document.addEventListener('DOMContentLoaded', function() { //Sort languages by alphabet const list = Array.from(document.querySelector('.dropdown-menu[aria-labelledby="languageDropdown"]').children).filter(child => child.matches('a')); list.sort(function(a, b) { - var A = a.textContent.toUpperCase(); - var B = b.textContent.toUpperCase(); - return (A < B) ? -1 : (A > B) ? 1 : 0; + return a.textContent.toUpperCase().localeCompare(b.textContent.toUpperCase()); }).forEach(node => document.querySelector('.dropdown-menu[aria-labelledby="languageDropdown"]').appendChild(node)); }); \ No newline at end of file diff --git a/src/main/resources/templates/fragments/languages.html b/src/main/resources/templates/fragments/languages.html index fba197f5e..3ca0092ff 100644 --- a/src/main/resources/templates/fragments/languages.html +++ b/src/main/resources/templates/fragments/languages.html @@ -1,81 +1,107 @@ - - icon Български - - - icon العربية - - - icon Català - - - icon 简体中文 - - - icon 正體中文 - - - icon Deutsch - - - icon English (GB) - - - icon English (US) - - - icon Euskara - - - icon Español - - - icon Français - - - icon Indonesia - - - icon Italiano - - - icon Nederlands - - - icon Polski - - - icon Português (BR) - - - icon Romanian - - - icon Svenska - - - icon Türkçe - - - icon Русский - - - icon 한국어 - - - icon 日本語 - - - icon Ελληνικά - - - icon Hungarian - - - icon हिन्दी - - - icon Srpski - + icon Български + + icon العربية + + icon Català + + icon 简体中文 + + icon 正體中文 + + icon Deutsch + + icon English (GB) + + icon English (US) + + icon Euskara + + icon Español + + icon Français + + icon Indonesia + + icon Italiano + + icon Nederlands + + icon Polski + + icon Português (BR) + + icon Romanian + + icon Svenska + + icon Türkçe + + icon Русский + + icon 한국어 + + icon 日本語 + + icon Ελληνικά + + icon Hungarian + + icon हिन्दी + + icon Srpski + diff --git a/src/main/resources/templates/pipeline.html b/src/main/resources/templates/pipeline.html index 1d976e09e..36535a9b0 100644 --- a/src/main/resources/templates/pipeline.html +++ b/src/main/resources/templates/pipeline.html @@ -80,6 +80,7 @@ +

Below info is Alpha only, will be removed and hence not translated

Current Limitations