add troubleshot section for ofs integration

Author: arch

docs/app/docs/user-guide/ofs-integration.md

@@ -4,14 +4,37 @@ Currently we use a hacky lua script to communicate between the Python Funscript
 
 ## Installation (Windows)
 
-1. Download the latest packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
+1. Download the **latest** packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
 2. Extract the Archiv.
-3. Copy the `funscript_generator.lua` script ([`Repository/contrib/OpenFunscripter`](https://github.com/michael-mueller-git/Python-Funscript-Editor/tree/main/contrib/OpenFunscripter)) to `data/lua` in your OFS directory.
-4. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
-   - NOTE: Since release `v0.0.4` you should use `/` instead of `\\` for the path.
-   - `Settings.FunscriptGenerator`: Point to the extracted Python Funscript Editor program.
+3. Download the **latest** `funscript_generator.lua` script from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
+4. Move the downloaded `funscript_generator.lua` script to `data/lua` in your OFS directory.
+5. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
+   - **NOTE:** You have to use use `/` or `\\` for the `\` symbols in your path!
+   - `Settings.FunscriptGenerator`: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).
    - `Settings.TmpFile`: Specifies a temporary file location where to store the result (must be a file not a directory!). The file does not have to exist at the moment. The specified file will be generated from the Python Funscript Editor and will be overwritten automatically at the next time the generator is started!
-5. Now launch OFS.
-6. Navigate to `View : Special functions : Custom Functions` and select the `funscript_generator.lua` entry. Click the Button `Bind Script` (This may trigger the funscript generator, just ignore it for now).
-7. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.
-8. Now you can use the shortcut at any position in the video to start the funscript generator.
+6. Now launch OFS.
+7. Navigate to `View : Special functions : Custom Functions` and select the `funscript_generator.lua` entry. Click the Button `Bind Script` (This may trigger the funscript generator, just ignore it for now).
+8. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.
+9. Now you can use the shortcut at any position in the video to start the funscript generator.
+
+## Troubleshot
+
+### After setting the min and max value after tracking no points are inserted in OFS
+
+If the points are missing in OFS then most likely the variable `Settings.TmpFile` in the `funscript_generator.lua` script is set incorrectly.
+
+### Noting happens when i press the Shortcut for the Funscript Generator
+
+In most cases, the variable `Settings.FunscriptGenerator` in the `funscript_generator.lua` script was not set correctly.
+
+If you are using an older version of the `funscript_generator.lua` you should download the latest version of the script from the [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases). With older `funscript_generator.lua` scripts there were e.g. problems with blanks in the path.
+
+### When calling the generator, only a message box is displayed with the message: "Video file was not specified!"
+
+In some cases OFS does not set the path to the video file within the lua script correctly (the variable `VideoFilePath` is empty). Mostly it helps to save the current project and/or create a new project. Then the variable should be set by OFS and the generator should work.
+
+### Tracking stops automatically
+
+If a tacker does not find the selected feature in the next frame, the tracing process stops. If more than 120 frames have already been tracked, a window appears to select the minimum and maximum value in which the reason for the abort is displayed with e.g. `Info: Tracker Woman Lost`.
+
+If less than 120 frames have been processed, a message box should pop up with the message `Tracking time insufficient`. In this case, no output is generated because there is not enough data for the algorithm to work with.

docs/app/site/index.html

@@ -204,5 +204,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.1.2
-Build Date UTC : 2021-06-26 15:52:42.322241+00:00
+Build Date UTC : 2021-06-27 07:47:45.353935+00:00
 -->

docs/app/site/search/search_index.json

@@ -1,27 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
      <loc>None</loc>
-     <lastmod>2021-06-26</lastmod>
+     <lastmod>2021-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-06-26</lastmod>
+     <lastmod>2021-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-06-26</lastmod>
+     <lastmod>2021-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-06-26</lastmod>
+     <lastmod>2021-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-06-26</lastmod>
+     <lastmod>2021-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-06-26</lastmod>
+     <lastmod>2021-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
 </urlset>

docs/app/site/sitemap.xml

@@ -102,6 +102,10 @@
             <li class="nav-item" data-level="2"><a href="#installation-windows" class="nav-link">Installation (Windows)</a>
               <ul class="nav flex-column">
               </ul>
+            </li>
+            <li class="nav-item" data-level="2"><a href="#troubleshot" class="nav-link">Troubleshot</a>
+              <ul class="nav flex-column">
+              </ul>
             </li>
               </ul>
             </li>
@@ -114,17 +118,30 @@ <h1 id="open-funscripter-integration">Open Funscripter Integration</h1>
 <p>Currently we use a hacky lua script to communicate between the Python Funscript Generator and the Open Funscripter.</p>
 <h2 id="installation-windows">Installation (Windows)</h2>
 <ol>
-<li>Download the latest packed Python Funscript Editor from <a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/releases">github release page</a>.</li>
-<li>Extract the Archiv to an Path without special character or spaces.</li>
-<li>Copy the <code>funscript_generator.lua</code> script (<a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/tree/main/contrib/OpenFunscripter"><code>Repository/contrib/OpenFunscripter</code></a>) to <code>data/lua</code> in your OFS directory.</li>
+<li>Download the <strong>latest</strong> packed Python Funscript Editor from <a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/releases">github release page</a>.</li>
+<li>Extract the Archiv.</li>
+<li>Download the <strong>latest</strong> <code>funscript_generator.lua</code> script from <a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/releases">github release page</a>.</li>
+<li>Move the downloaded <code>funscript_generator.lua</code> script to <code>data/lua</code> in your OFS directory.</li>
 <li>Open the <code>funscript_generator.lua</code> file and adjust the <code>Settings.FunscriptGenerator</code> and <code>Settings.TmpFile</code> variable.</li>
-<li><code>Settings.FunscriptGenerator</code>: Point to the extracted Python Funscript Editor program.</li>
+<li><strong>NOTE:</strong> You have to use use <code>/</code> or <code>\\</code> for the <code>\</code> symbols in your path!</li>
+<li><code>Settings.FunscriptGenerator</code>: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).</li>
 <li><code>Settings.TmpFile</code>: Specifies a temporary file location where to store the result (must be a file not a directory!). The file does not have to exist at the moment. The specified file will be generated from the Python Funscript Editor and will be overwritten automatically at the next time the generator is started!</li>
 <li>Now launch OFS.</li>
 <li>Navigate to <code>View : Special functions : Custom Functions</code> and select the <code>funscript_generator.lua</code> entry. Click the Button <code>Bind Script</code> (This may trigger the funscript generator, just ignore it for now).</li>
 <li>Navigate to <code>Options : Keys : Dynamic</code> and insert a shortcut for the funscript generator.</li>
 <li>Now you can use the shortcut at any position in the video to start the funscript generator.</li>
-</ol></div>
+</ol>
+<h2 id="troubleshot">Troubleshot</h2>
+<h3 id="after-setting-the-min-and-max-value-after-tracking-no-points-are-inserted-in-ofs">After setting the min and max value after tracking no points are inserted in OFS</h3>
+<p>If the points are missing in OFS then most likely the variable <code>Settings.TmpFile</code> in the <code>funscript_generator.lua</code> script is set incorrectly.</p>
+<h3 id="noting-happens-when-i-press-the-shortcut-for-the-funscript-generator">Noting happens when i press the Shortcut for the Funscript Generator</h3>
+<p>In most cases, the variable <code>Settings.FunscriptGenerator</code> in the <code>funscript_generator.lua</code> script was not set correctly.</p>
+<p>If you are using an older version of the <code>funscript_generator.lua</code> you should download the latest version of the script from the <a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/releases">github release page</a>. With older <code>funscript_generator.lua</code> scripts there were e.g. problems with blanks in the path.</p>
+<h3 id="when-calling-the-generator-only-a-message-box-is-displayed-with-the-message-video-file-was-not-specified">When calling the generator, only a message box is displayed with the message: "Video file was not specified!"</h3>
+<p>In some cases OFS does not set the path to the video file within the lua script correctly (the variable <code>VideoFilePath</code> is empty). Mostly it helps to save the current project and/or create a new project. Then the variable should be set by OFS and the generator should work.</p>
+<h3 id="tracking-stops-automatically">Tracking stops automatically</h3>
+<p>If a tacker does not find the selected feature in the next frame, the tracing process stops. If more than 120 frames have already been tracked, a window appears to select the minimum and maximum value in which the reason for the abort is displayed with e.g. <code>Info: Tracker Woman Lost</code>.</p>
+<p>If less than 120 frames have been processed, a message box should pop up with the message <code>Tracking time insufficient</code>. In this case, no output is generated because there is not enough data for the algorithm to work with.</p></div>
             </div>
         </div>