Fixed 2nd half of problem generating backslashes in path names.

dsbeach · dsbeach · commit 71ed08c74443 · 2016-01-04T16:24:08.000-05:00
Corrected text in lcd_function-overview.md (2.1 now requires lcd.clear())

Re-ran generate-api-docs.py which would have pickup up luadoc changes.
diff --git a/general/getDateTime.md b/general/getDateTime.md
@@ -29,7 +29,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getDateTime-example.lua">general\getDateTime-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getDateTime-example.lua">general/getDateTime-example</a>
 
 ```lua
 local function run(e)
diff --git a/general/getFieldInfo.md b/general/getFieldInfo.md
@@ -38,7 +38,7 @@ The list of valid sources is available:
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getFieldInfo-example.lua">general\getFieldInfo-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getFieldInfo-example.lua">general/getFieldInfo-example</a>
 
 ```lua
 local function run(e)
diff --git a/general/getGeneralSettings.md b/general/getGeneralSettings.md
@@ -30,7 +30,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getGeneralSettings-example.lua">general\getGeneralSettings-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getGeneralSettings-example.lua">general/getGeneralSettings-example</a>
 
 ```lua
 local function run(e)
diff --git a/general/getValue.md b/general/getValue.md
@@ -59,7 +59,7 @@ Getting a value by its numerical identifier is faster then by its name.
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getValue-example.lua">general\getValue-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/general/getValue-example.lua">general/getValue-example</a>
 
 ```lua
 local function run(e)
diff --git a/lcd/clear.md b/lcd/clear.md
@@ -27,7 +27,7 @@ This function only works in stand-alone and telemetry scripts.
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/clear-example.lua">lcd\clear-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/clear-example.lua">lcd/clear-example</a>
 
 ```lua
 --
diff --git a/lcd/drawChannel.md b/lcd/drawChannel.md
@@ -30,7 +30,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawChannel-example.lua">lcd\drawChannel-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawChannel-example.lua">lcd/drawChannel-example</a>
 
 ```lua
 local function run(e)
diff --git a/lcd/drawCombobox.md b/lcd/drawCombobox.md
@@ -38,7 +38,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawCombobox-example.lua">lcd\drawCombobox-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawCombobox-example.lua">lcd/drawCombobox-example</a>
 
 ```lua
 local comboOptions
diff --git a/lcd/drawFilledRectangle.md b/lcd/drawFilledRectangle.md
@@ -31,7 +31,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawFilledRectangle-example.lua">lcd\drawFilledRectangle-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawFilledRectangle-example.lua">lcd/drawFilledRectangle-example</a>
 
 ```lua
 
diff --git a/lcd/drawGauge.md b/lcd/drawGauge.md
@@ -35,7 +35,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawGauge-example.lua">lcd\drawGauge-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawGauge-example.lua">lcd/drawGauge-example</a>
 
 ```lua
 
diff --git a/lcd/drawLine.md b/lcd/drawLine.md
@@ -36,7 +36,7 @@ whole line will not be drawn (starting from OpenTX 2.1.5)
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawLine-example.lua">lcd\drawLine-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawLine-example.lua">lcd/drawLine-example</a>
 
 ```lua
 local alpha = (2 * math.pi) / 10
diff --git a/lcd/drawNumber-example.png b/lcd/drawNumber-example.png
diff --git a/lcd/drawNumber.md b/lcd/drawNumber.md
@@ -33,7 +33,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawNumber-example.lua">lcd\drawNumber-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawNumber-example.lua">lcd/drawNumber-example</a>
 
 ```lua
 function round(num, decimals)
diff --git a/lcd/drawPixmap.md b/lcd/drawPixmap.md
@@ -27,7 +27,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawPixmap-example.lua">lcd\drawPixmap-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawPixmap-example.lua">lcd/drawPixmap-example</a>
 
 ```lua
 local function run(event)
diff --git a/lcd/drawPoint.md b/lcd/drawPoint.md
@@ -33,7 +33,7 @@ bottom line is 63. Drawing on an existing black pixel produces white pixel (TODO
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawPoint-example.lua">lcd\drawPoint-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawPoint-example.lua">lcd/drawPoint-example</a>
 
 ```lua
 local function circle(xCenter, yCenter, radius)
diff --git a/lcd/drawRectangle.md b/lcd/drawRectangle.md
@@ -31,7 +31,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawRectangle-example.lua">lcd\drawRectangle-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawRectangle-example.lua">lcd/drawRectangle-example</a>
 
 ```lua
 local function run()
diff --git a/lcd/drawScreenTitle.md b/lcd/drawScreenTitle.md
@@ -30,7 +30,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawScreenTitle-example.lua">lcd\drawScreenTitle-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawScreenTitle-example.lua">lcd/drawScreenTitle-example</a>
 
 ```lua
 local function run(event)
diff --git a/lcd/drawSource.md b/lcd/drawSource.md
@@ -29,7 +29,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawSource-example.lua">lcd\drawSource-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawSource-example.lua">lcd/drawSource-example</a>
 
 ```lua
 local function run(event)
diff --git a/lcd/drawSwitch.md b/lcd/drawSwitch.md
@@ -30,7 +30,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawSwitch-example.lua">lcd\drawSwitch-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawSwitch-example.lua">lcd/drawSwitch-example</a>
 
 ```lua
 local function run(event)
diff --git a/lcd/drawText.md b/lcd/drawText.md
@@ -38,7 +38,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawText-example.lua">lcd\drawText-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawText-example.lua">lcd/drawText-example</a>
 
 ```lua
 local function run(event)
diff --git a/lcd/drawTimer.md b/lcd/drawTimer.md
@@ -32,7 +32,7 @@ none
 
 ### Examples
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawTimer-example.lua">lcd\drawTimer-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/lcd/drawTimer-example.lua">lcd/drawTimer-example</a>
 
 ```lua
 local upTime
diff --git a/lcd/lcd_functions-overview.md b/lcd/lcd_functions-overview.md
@@ -6,7 +6,7 @@ Lcd functions allow scripts to interact with the transmitter display. This acces
 
 ##### Notes:
 
-The run function is periodically called when the screen is visible. In OpenTX 2.1 each invocation starts with a blank screen, whereas 2.0 scripts screen images persisted across calls.
+The run function is periodically called when the screen is visible. In OpenTX 2.0 each invocation starts with a blank screen (unless lcd.lock() is used). Under OpenTX 2.1 screen state is always persisted across calls to the run function. **Many scripts originally written for OpenTX 2.0 require a call to lcd.clear() at the beginning of their run function in order to display properly under 2.1.**
 
 Many of the lcd functions accept parameters named *flags* and *patterns*.  The names and their meanings are described below.
 
diff --git a/model/setGlobalVariable.md b/model/setGlobalVariable.md
@@ -42,7 +42,7 @@ any floating point value is converted (todo check how) into integer value.
 this is a sample example
 
 
-<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/model/setGlobalVariable-example.lua">model\setGlobalVariable-example</a>
+<a class="dlbtn" href="https://raw.githubusercontent.com/opentx/lua-reference-guide/master/model/setGlobalVariable-example.lua">model/setGlobalVariable-example</a>
 
 ```lua
 function foo(bar)
diff --git a/tools/generate-api-docs.py b/tools/generate-api-docs.py
@@ -157,7 +157,7 @@ def addExamples(moduleName, funcName):
           doc += "\n\n"
         if example[1] == "lua":
           # add download link before content is included
-          doc += "<a class=\"dlbtn\" href=\"%s%s\">%s</a>\n\n" % (DOCBASE, fileName.replace("\\", "/"), example[0])
+          doc += "<a class=\"dlbtn\" href=\"%s%s\">%s</a>\n\n" % (DOCBASE, fileName.replace("\\", "/"), example[0].replace("\\", "/"))
           # lua files are escaped in code block
           doc += "```lua\n"
           doc += e.read()
