Merge pull request #1388 from jbampton/clean-up

Docs clean up
lucee · Jul 10, 2023 · 9db033f · 9db033f
2 parents 390afa0 + 1717e88
commit 9db033f
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -46,10 +46,10 @@ When running locally there are the following urls available (these URLs below ar
 
 * [Lucee documentation home](http://127.0.0.1:4040/)
 * [Build all documentation](http://127.0.0.1:4040/build_docs/all/)
-* [Build html documentation](http://127.0.0.1:4040/build_docs/html/)
+* [Build HTML documentation](http://127.0.0.1:4040/build_docs/html/)
 * [Build dash documentation](http://127.0.0.1:4040/build_docs/dash/)
 * [Import any new tags or functions](http://127.0.0.1:4040/build_docs/import/)
-* [View static html docs](http://127.0.0.1:4040/static/) (you need to have built the html documentation first)
+* [View static HTML docs](http://127.0.0.1:4040/static/) (you need to have built the HTML documentation first)
 
 ## Working with the bundled JS and CSS files
 

diff --git a/docs/03.reference/01.functions/dump/_arguments/format.md b/docs/03.reference/01.functions/dump/_arguments/format.md
@@ -1,6 +1,6 @@
 specify the output format of the dump, the following formats are supported:
 
-- simple: - a simple html output (no JavaScript or CSS)
-- text (default output="console"): plain text output (no html)
-- html (default output="browser"): regular output with html/CSS/JavaScript
-- classic: classic view with html/CSS/JavaScript
+- simple: - a simple HTML output (no JavaScript or CSS)
+- text (default output="console"): plain text output (no HTML)
+- html (default output="browser"): regular output with HTML/CSS/JavaScript
+- classic: classic view with HTML/CSS/JavaScript
diff --git a/docs/03.reference/01.functions/esapidecode/_arguments/decodeFrom.md b/docs/03.reference/01.functions/esapidecode/_arguments/decodeFrom.md
@@ -1,4 +1,4 @@
 given value is encoded as:
 
-- url: also decodes html-encoded content in lucee 4
-- html (not in lucee 4)
+- url: also decodes html-encoded content in Lucee 4
+- html (not in Lucee 4)
diff --git a/docs/03.reference/01.functions/htmlparse/function.md b/docs/03.reference/01.functions/htmlparse/function.md
@@ -8,4 +8,4 @@ categories:
 - HTML
 ---
 
-parse the given html (not only XHTML) as XML Object, work similar to [[function-xmlParse]], but this function is very forgiving with the syntax.
+parse the given HTML (not only XHTML) as XML Object, work similar to [[function-xmlParse]], but this function is very forgiving with the syntax.
diff --git a/docs/03.reference/01.functions/writedump/_arguments/format.md b/docs/03.reference/01.functions/writedump/_arguments/format.md
@@ -1,6 +1,6 @@
 specify the output format of the dump, the following formats are supported:
 
-- simple: - a simple html output (no JavaScript or CSS)
-- text (default output="console"): plain text output (no html)
-- html (default output="browser"): regular output with html/CSS/JavaScript
-- classic: classic view with html/CSS/JavaScript
+- simple: - a simple HTML output (no JavaScript or CSS)
+- text (default output="console"): plain text output (no HTML)
+- html (default output="browser"): regular output with HTML/CSS/JavaScript
+- classic: classic view with HTML/CSS/JavaScript
diff --git a/docs/03.reference/02.tags/htmlbody/_attributes/action.md b/docs/03.reference/02.tags/htmlbody/_attributes/action.md
@@ -1,7 +1,7 @@
 possible actions are:
 
-- append (default): append text to the html head
-- read: return the text already set to html head
-- reset: reset/remove text already set to hrml head
-- write: write text to html head, overwrite already existing text in html head
-- flush: writes the buffer in the html head to the response stream
+- append (default): append text to the HTML head
+- read: return the text already set to HTML head
+- reset: reset/remove text already set to HTML head
+- write: write text to HTML head, overwrite already existing text in HTML head
+- flush: writes the buffer in the HTML head to the response stream
diff --git a/docs/03.reference/02.tags/htmlhead/_attributes/action.md b/docs/03.reference/02.tags/htmlhead/_attributes/action.md
@@ -1,7 +1,7 @@
 possible actions are:
 
-- append (default): append text to the html head
-- read: return the text already set to html head
-- reset: reset/remove text already set to html head
-- write: write text to html head, overwrite already existing text in html head
-- flush: writes the buffer in the html head to the response stream
+- append (default): append text to the HTML head
+- read: return the text already set to HTML head
+- reset: reset/remove text already set to HTML head
+- write: write text to HTML head, overwrite already existing text in HTML head
+- flush: writes the buffer in the HTML head to the response stream
diff --git a/docs/03.reference/02.tags/savecontent/_examples.md b/docs/03.reference/02.tags/savecontent/_examples.md
@@ -1,7 +1,7 @@
 ```lucee+trycf
 <cfoutput>
  <cfsavecontent variable="test">
- Here you can add any cf, html elements etc.,
+ Here you can add any cf, HTML elements etc.,
  Where you need it just place the variable of cfsavecontent, automatically shows the content stored here.
  </cfsavecontent>
  <cfsavecontent variable="example">
@@ -15,7 +15,7 @@
 
 ```luceescript+trycf
  cfsavecontent( variable="test" ){
- echo("Here you can add any cf, html elements etc.,");
+ echo("Here you can add any cf, HTML elements etc.,");
  }
  echo(test);
 ```
diff --git a/docs/03.reference/02.tags/videoplayer/tag.md b/docs/03.reference/02.tags/videoplayer/tag.md
@@ -10,4 +10,4 @@ The tag CFVIDEOPLAYER allows you to display a video in flash (flv) format.
 
 **requires flash, so no longer useful**
 
-It includes the complete functionality to display the player with the necessary html code. Read more on the multimedia functionality.
+It includes the complete functionality to display the player with the necessary HTML code. Read more on the multimedia functionality.
diff --git a/docs/04.guides/04.cookbooks/01.application-context-basic/page.md b/docs/04.guides/04.cookbooks/01.application-context-basic/page.md
@@ -99,7 +99,7 @@ This function is triggered before every request, so you can prepare the environm
 ```cfs
 component {
  boolean function onRequestStart(string targetPage) {
- echo('<html><head><body>'); // outputs the response html header
+ echo('<html><head><body>'); // outputs the response HTML header
  request.whatever=new Whatever(); // prepare an object to use within the request
  return true;
  }
@@ -115,7 +115,7 @@ This function is triggered after every request, so you can cleanup the environme
 ```cfs
 component {
  void function onRequestEnd(string targetPage) {
- echo('</body></html>'); // outputs the response html footer
+ echo('</body></html>'); // outputs the response HTML footer
  request.whatever.finalize();
  }
 }

diff --git a/docs/04.guides/04.cookbooks/32.Startup_Listeners/page.md b/docs/04.guides/04.cookbooks/32.Startup_Listeners/page.md
@@ -47,7 +47,7 @@ component{
 
 - Here, Server.cfc has one function ``onServerStart()``
 - Start Lucee Server. 
-- The server console or `out.log` should should the above systemOutput's which means it has run the `Server.cfc`
+- The server console or `out.log` should show the above systemOutput's which means it has run the `Server.cfc`
 
 ### Web.cfc ###