Add docs for word_translator project

Author: kern-ding

README.md

@@ -7,6 +7,7 @@ Scripts are invoked by **Laserfiche Remote Agent** which is a service installed
 ## Prerequisites
 
 - [Python 3.6 or later](https://www.python.org/downloads/)
+  - If your windows login user is different than the user running the remote agent, you need to install Python for all users.
 - [Visual Studio Code v1.80 or later](https://code.visualstudio.com/download)
 - [A Laserfiche Cloud Account](https://www.laserfiche.com/signon/)
 - [Creating a Python Script Documentation](https://doc.laserfiche.com/laserfiche.documentation/en-us/Default.htm#../Subsystems/ProcessAutomation/Content/Resources/Rules/pythonscript.htm?TocPath=Process%2520Automation%257CRules%257CGetting%2520Started%2520With%2520Scripts%257C_____2)
@@ -29,9 +30,15 @@ This project is using a mono-repo structure with multiple packages. Please refer
 ## Deployment
  - Copy the whole repo into the remote agent folder
     - e.g., `C:\Program Files\Laserfiche\Server\RemoteAgent\ScriptRunner\Python\lf-sample-python-script-rules`
- - Add the remote agent location into the **PYTHONPATH**
-   ```python
-   import os
-   os.environ['PYTHONPATH'] = r'C:\Program Files\Laserfiche\Server\RemoteAgent\ScriptRunner\Python\lf-sample-python-script-rules'
-   ```
+ 
+ - Add the destination folder into the **PYTHONPATH** environment variable
+   - if your windows login user is different than the user running the remote agent, you need to add the environment variable to `System variables`.
+   - ```python
+     import os
+     os.environ['PYTHONPATH'] = r'C:\Program Files\Laserfiche\Server\RemoteAgent\ScriptRunner\Python\lf-sample-python-script-rules'
+     ```
+
  - Install dependencies: `pip install -r requirements.txt`
+   - If your windows login user is different than the user running the remote agent, you need to make `pip install` to install dependencies for all the user. 
+   - e.g, `pip install --target="C:\Program Files\Python312\Lib\site-packages" -r requirements.txt`
+   - Please update the `--target` based on your python installation folder.

doc/template/readme.md

@@ -1,15 +1,11 @@
 # Laserfiche Python Rule script Template project
+
 This project is a template for creating a Laserfiche Python Rule script project. It contains a sample script that can be used as a starting point for creating your own script.
 
 ## Deploy script to your remote agent
-- Copy the whole repo into the remote agent folder
-    - e.g., `C:\Program Files\Laserfiche\Server\RemoteAgent\ScriptRunner\Python\lf-sample-python-script-rules`
-- Add the remote agent location into the **PYTHONPATH**
-  ```python
-  import os
-  os.environ['PYTHONPATH'] = r'C:\Program Files\Laserfiche\Server\RemoteAgent\ScriptRunner\Python\lf-sample-python-script-rules'
-  ```
-  
+
+Refer to the [Deployment](../../README.md#deployment) for details.
+
 ## Configure and test this script rule in your Laserfiche Cloud Account -> Process Automation -> Rules
 
 Create a new rule:

doc/word_translator/readme.md

@@ -0,0 +1,30 @@
+# Laserfiche Python Rule script Word Translator project
+
+This project is a sample script to show how to import 3rd party pip packages in a Laserfiche Python Rule script project.
+
+## Deploy script to your remote agent
+ Refer to the [Deployment](../../README.md#deployment) for details.
+
+## Configure and test this script rule in your Laserfiche Cloud Account -> Process Automation -> Rules
+
+Create a new rule:
+
+- Select the script rule type: Python
+- Script location: `C:\Program Files\Laserfiche\Server\RemoteAgent\ScriptRunner\Python\lf-sample-python-script-rules\source\word_translator\launcher.py`
+- Input:
+    - Sentence: the words to translate
+    - fr: translate to French
+- Output:
+    - translated: the translated words
+
+![Script Rule Configuration](script-rule-configuration.png)
+
+## Test the rule
+
+Providing sentence and language code to be translated, this script would translate the sentence. 
+![Script Test Inputs](script-test-inputs.png)
+
+## Test script rule in a workflow
+
+Run the workflow and verify the script translate the sentence
+![Workflow Script Rule Sample](workflow-script-rule-sample.png)