Minor fixes (browser)

- Code formatting
- Example errors
- Typos

Author: FileEX

functions/Browser/canBrowserNavigateBack.yaml

@@ -12,7 +12,7 @@ client:
     values:
       - type: bool
         name: result
-    description: Returns true if the browser can navigate back, false otherwise.
+    description: Returns **true** if the browser can navigate back, **false** otherwise.
   examples:
     - path: examples/canBrowserNavigateBack-1.lua
       description: This example creates a browser that can return to the last and previous pages and can also be refreshed.

functions/Browser/canBrowserNavigateForward.yaml

@@ -12,7 +12,7 @@ client:
     values:
       - type: bool
         name: result
-    description: Returns true if the browser can go to the next page, false otherwise.
+    description: Returns **true** if the browser can go to the next page, **false** otherwise.
   examples:
     - path: examples/canBrowserNavigateForward-1.lua
       description: This example creates a browser that can return to the last and previous pages and can also be refreshed.

functions/Browser/createBrowser.yaml

@@ -27,7 +27,7 @@ client:
     values:
       - type: element|false
         name: new browser
-    description: Returns a [[texture]] of the [[browser]] if it was created successfully, false otherwise. Returns also false, if the user disabled remote pages and isLocal was set to false.
+    description: Returns a [[texture]] of the [[browser]] if it was created successfully, **false** otherwise. Returns also **false**, if the user disabled remote pages and isLocal was set to false.
   examples:
     - path: examples/createBrowser-1.lua
       description: This example shows you how to create a fullscreen web browser (showing a local html file) without input-handling.

functions/Browser/examples/canBrowserNavigateBack-1.lua

@@ -3,33 +3,31 @@ guiWindowSetSizable(window, false)
 
 local navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
 local navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
-local addressBar =  guiCreateEdit(137, 19, 701, 36, "", false, window)
-guiSetEnabled( addressBar, false )
+local addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
+guiSetEnabled(addressBar, false)
 local reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
 local browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)
 
 -- Load our page on browser creation.
-local theBrowser = guiGetBrowser(browser) 
-addEventHandler("onClientBrowserCreated", theBrowser, 
-    function()
-        loadBrowserURL(source, "https://forum.mtasa.com/")
-    end
-)
+local theBrowser = guiGetBrowser(browser)
+addEventHandler("onClientBrowserCreated", theBrowser, function()
+    loadBrowserURL(source, "https://forum.mtasa.com/")
+end)
 
 -- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
-addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
+addEventHandler("onClientBrowserDocumentReady", theBrowser, function()
     guiSetEnabled(navigateForwardBtn, canBrowserNavigateForward(theBrowser))
     guiSetEnabled(navigateBackBtn, canBrowserNavigateBack(theBrowser))
-    guiSetText( addressBar, getBrowserURL( theBrowser ) )
-end )
+    guiSetText(addressBar, getBrowserURL(theBrowser))
+end)
 
 -- This part handles the GUI navigation buttons for the browser.
-addEventHandler( "onClientGUIClick", resourceRoot, function ( )
+addEventHandler("onClientGUIClick", resourceRoot, function()
     if source == navigateBackBtn then
         navigateBrowserBack(theBrowser)
     elseif source == navigateForwardBtn then
         navigateBrowserForward(theBrowser)
     elseif source == reloadBtn then
         reloadBrowserPage(theBrowser)
     end
-end )
+end)

functions/Browser/examples/canBrowserNavigateForward-1.lua

@@ -3,32 +3,30 @@ guiWindowSetSizable(window, false)
 local navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
 local navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
 local reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
-local addressBar =  guiCreateEdit(137, 19, 701, 36, "", false, window)
-guiSetEnabled(addressBar,false)
+local addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
+guiSetEnabled(addressBar, false)
 local webBrowser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)
-local theBrowser = guiGetBrowser(webBrowser) 
+local theBrowser = guiGetBrowser(webBrowser)
 
 -- Load our page on browser creation.
-addEventHandler("onClientBrowserCreated", theBrowser, 
-    function()
-	showCursor(true)
-        loadBrowserURL(source, "https://forum.mtasa.com/")
-    end
-)
+addEventHandler("onClientBrowserCreated", theBrowser, function()
+    showCursor(true)
+    loadBrowserURL(source, "https://forum.mtasa.com/")
+end)
 
-addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( url )
-    guiSetText( addressBar, getBrowserURL( theBrowser ) )
-end )
+addEventHandler("onClientBrowserDocumentReady", theBrowser, function(url)
+    guiSetText(addressBar, getBrowserURL(theBrowser))
+end)
 
 -- This part handles the GUI navigation buttons for the browser.
-addEventHandler( "onClientGUIClick", resourceRoot, function ( )
+addEventHandler("onClientGUIClick", resourceRoot, function()
     if source == navigateBackBtn then
-	    if (not canBrowserNavigateBack(theBrowser)) then return end -- This checks to see if the browser can navigate to the back
+        if (not canBrowserNavigateBack(theBrowser)) then return end -- This checks to see if the browser can navigate to the back
         navigateBrowserBack(theBrowser)
     elseif source == navigateForwardBtn then -- This checks to see if the browser can navigate to the forward
-	    if (not canBrowserNavigateForward(theBrowser)) then return end
+        if (not canBrowserNavigateForward(theBrowser)) then return end
         navigateBrowserForward(theBrowser)
     elseif source == reloadBtn then
         reloadBrowserPage(theBrowser)
     end
-end )
+end)

functions/Browser/examples/createBrowser-1.lua

@@ -1,22 +1,20 @@
---In order to render the browser on the full screen, we need to know the dimensions.
+-- In order to render the browser on the full screen, we need to know the dimensions.
 local screenWidth, screenHeight = guiGetScreenSize()
 
---Let's create a new browser in local mode. We will not be able to load an external URL.
+-- Let's create a new browser in local mode. We will not be able to load an external URL.
 local webBrowser = createBrowser(screenWidth, screenHeight, true, false)
-	
---This is the function to render the browser.
+
+-- This is the function to render the browser.
 function webBrowserRender()
-	--Render the browser on the full size of the screen.
-	dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
+    -- Render the browser on the full size of the screen.
+    dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255, 255, 255, 255), true)
 end
 
---The event onClientBrowserCreated will be triggered, after the browser has been initialized.
---After this event has been triggered, we will be able to load our URL and start drawing.
-addEventHandler("onClientBrowserCreated", webBrowser, 
-	function()
-		--After the browser has been initialized, we can load our file.
-		loadBrowserURL(webBrowser, "http://mta/local/html/site.html")
-		--Now we can start to render the browser.
-		addEventHandler("onClientRender", root, webBrowserRender)
-	end
-)
+-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
+-- After this event has been triggered, we will be able to load our URL and start drawing.
+addEventHandler("onClientBrowserCreated", webBrowser, function()
+    -- After the browser has been initialized, we can load our file.
+    loadBrowserURL(webBrowser, "http://mta/local/html/site.html")
+    -- Now we can start to render the browser.
+    addEventHandler("onClientRender", root, webBrowserRender)
+end)

functions/Browser/examples/createBrowser-2.lua

@@ -1,22 +1,20 @@
---In order to render the browser on the full screen, we need to know the dimensions.
+-- In order to render the browser on the full screen, we need to know the dimensions.
 local screenWidth, screenHeight = guiGetScreenSize()
 
---Let's create a new browser in remote mode.
+-- Let's create a new browser in remote mode.
 local webBrowser = createBrowser(screenWidth, screenHeight, false, false)
-	
---Function to render the browser.
+
+-- Function to render the browser.
 function webBrowserRender()
-	--Render the browser on the full size of the screen.
-	dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
+    -- Render the browser on the full size of the screen.
+    dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255, 255, 255, 255), true)
 end
 
---The event onClientBrowserCreated will be triggered, after the browser has been initialized.
---After this event has been triggered, we will be able to load our URL and start drawing.
-addEventHandler("onClientBrowserCreated", webBrowser, 
-	function()
-		--After the browser has been initialized, we can load www.youtube.com
-		loadBrowserURL(webBrowser, "http://www.youtube.com")
-		--Now we can start to render the browser.
-		addEventHandler("onClientRender", root, webBrowserRender)
-	end
-)
+-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
+-- After this event has been triggered, we will be able to load our URL and start drawing.
+addEventHandler("onClientBrowserCreated", webBrowser, function()
+    -- After the browser has been initialized, we can load www.youtube.com
+    loadBrowserURL(webBrowser, "http://www.youtube.com")
+    -- Now we can start to render the browser.
+    addEventHandler("onClientRender", root, webBrowserRender)
+end)

functions/Browser/examples/createBrowser_OOP-1.lua

@@ -1,22 +1,20 @@
---In order to render the browser on the full screen, we need to know the dimensions.
+-- In order to render the browser on the full screen, we need to know the dimensions.
 local screenWidth, screenHeight = GuiElement.getScreenSize()
 
---Let's create a new browser in local mode. We will not be able to load an external URL.
+-- Let's create a new browser in local mode. We will not be able to load an external URL.
 local webBrowser = Browser(screenWidth, screenHeight, true, false)
-	
---This is the function to render the browser.
+
+-- This is the function to render the browser.
 function webBrowserRender()
-	--Render the browser on the full size of the screen.
-	dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
+    -- Render the browser on the full size of the screen.
+    dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255, 255, 255, 255), true)
 end
 
---The event onClientBrowserCreated will be triggered, after the browser has been initialized.
---After this event has been triggered, we will be able to load our URL and start drawing.
-addEventHandler("onClientBrowserCreated", webBrowser, 
-	function()
-		--After the browser has been initialized, we can load our file.
-		webBrowser.url = "http://mta/local/html/site.html"
-		--Now we can start to render the browser.
-		addEventHandler("onClientRender", root, webBrowserRender)
-	end
-)
+-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
+-- After this event has been triggered, we will be able to load our URL and start drawing.
+addEventHandler("onClientBrowserCreated", webBrowser, function()
+    -- After the browser has been initialized, we can load our file.
+    webBrowser.url = "http://mta/local/html/site.html"
+    -- Now we can start to render the browser.
+    addEventHandler("onClientRender", root, webBrowserRender)
+end)

functions/Browser/examples/executeBrowserJavascript-1.lua

@@ -1,12 +1,10 @@
 local browser = guiGetBrowser(guiCreateBrowser(200, 200, 400, 200, true, false, false))
 
-addEventHandler("onClientBrowserCreated", browser,
-    function ()
-        loadBrowserURL(source, "http://mta/local/example.html") --Containing <span id="nick"></span> somewhere in the file
-    end)
+addEventHandler("onClientBrowserCreated", browser, function()
+    loadBrowserURL(source, "http://mta/local/example.html") -- Containing <span id="nick"></span> somewhere in the file
+end)
 
---The page has to load first
-addEventHandler("onClientBrowserDocumentReady", browser,
-    function ()
-        executeBrowserJavascript(source, string.format("document.getElementById('nick').innerText = %q;", getPlayerName(localPlayer)))
-    end)
+-- The page has to load first
+addEventHandler("onClientBrowserDocumentReady", browser, function()
+    executeBrowserJavascript(source, string.format("document.getElementById('nick').innerText = %q;", getPlayerName(localPlayer)))
+end)

functions/Browser/examples/executeBrowserJavascript_OOP-1.lua

@@ -1,12 +1,10 @@
 local browser = GuiBrowser(200, 200, 400, 200, true, false, false).browser
 
-addEventHandler("onClientBrowserCreated", browser,
-    function ()
-        source.url = "http://mta/local/example.html" --Containing <span id="nick"></span> somewhere in the file
-    end)
+addEventHandler("onClientBrowserCreated", browser, function()
+    source.url = "http://mta/local/example.html" -- Containing <span id="nick"></span> somewhere in the file
+end)
 
---The page has to load first
-addEventHandler("onClientBrowserDocumentReady", browser,
-    function ()
-        source:executeJavascript(string.format("document.getElementById('nick').innerText = %q;", localPlayer.name))
-    end)
+-- The page has to load first
+addEventHandler("onClientBrowserDocumentReady", browser, function()
+    source:executeJavascript(string.format("document.getElementById('nick').innerText = %q;", localPlayer.name))
+end)