Added copyright footer to docs page within UI, added back button to docs page within UI, added link to Github page within docs page, fixed page title issue that printed the entire docs as the title tag

Author: Jared Hendrickson

pfSense-pkg-API/files/usr/local/www/api/documentation/index.php

@@ -1699,16 +1699,31 @@
 function IsJsonString(str){try{JSON.parse(str);}catch(e){return false;}
 return true;}
 String.prototype.replaceAll=function(replaceThis,withThis){var re=new RegExp(RegExp.quote(replaceThis),"g");return this.replace(re,withThis);};RegExp.quote=function(str){return str.replace(/([.?*+^$[\]\\(){}-])/g,"\\$1");};function syntaxHighlight(json){json=json.replace(/&/g,'&amp;').replace(/</g,'&lt;').replace(/>/g,'&gt;');return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g,function(match){var cls='number';if(/^"/.test(match)){if(/:$/.test(match)){cls='key';}else{cls='string';}}else if(/true|false/.test(match)){cls='boolean';}else if(/null/.test(match)){cls='null';}
-return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2020-11-30 09:29:07 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
+return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2020-11-30 12:17:30 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
+<script type="text/javascript">
+    $(document).ready(function() {
+        document.title = 'pfSense REST API Documentation';
+        var curr_year = new Date().getFullYear();
+        document.querySelector('footer').innerHTML = "<p>Copyright &copy; " + curr_year + " - Jared Hendrickson</p><a href='/api/'>Back to pfSense</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api'>View on Github</a>";
+    });
+
+</script>
+
 <style>
+    title {
+        content:"pfSense API Documentation";
+    }
     body {
         display: block;
         width: 90%;
         max-width: 1500px;
         margin: 0 auto;
     }
     footer {
-        display:none;
+        text-align: center;
+    }
+    footer p {
+        margin: 2px;
     }
     div.col-md-12 {
         margin-top: 20px;

tools/make_documentation.py

@@ -33,14 +33,20 @@
 """
 css = """
 <style>
+    title {
+        content:"pfSense API Documentation";
+    }
     body {
         display: block;
         width: 90%;
         max-width: 1500px;
         margin: 0 auto;
     }
     footer {
-        display:none;
+        text-align: center;
+    }
+    footer p {
+        margin: 2px;
     }
     div.col-md-12 {
         margin-top: 20px;
@@ -116,6 +122,16 @@
     }
     </style>
 """
+js = """
+<script type="text/javascript">
+    $(document).ready(function() {
+        document.title = 'pfSense REST API Documentation';
+        var curr_year = new Date().getFullYear();
+        document.querySelector('footer').innerHTML = "<p>Copyright &copy; " + curr_year + " - Jared Hendrickson</p><a href='/api/'>Back to pfSense</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api'>View on Github</a>";
+    });
+
+</script>
+"""
 
 # Parses command line arguments and generates help pages
 def start_argparse():
@@ -153,7 +169,7 @@ def format_docs():
     # Write a new PHP script containing the HTML created by docgen, then override custom attributes and CSS
     with open("documentation.php", "w") as dw:
         html_doc = php + html_doc
-        html_doc = html_doc + css
+        html_doc = html_doc + js + css
         html_doc = html_doc.replace("{{$hostname}}", "<?echo $_SERVER['HTTP_HOST'];?>")
         dw.write(html_doc)