From 7b41839ea8f2aad020444c42f2cba89040ca28b8 Mon Sep 17 00:00:00 2001
From: Klaus Weidenbach <Klaus.Weidenbach@gmx.net>
Date: Sun, 2 Oct 2016 00:41:25 +0200
Subject: [TASK] Update Doxyfile and fix Doxygen errors.

Updated Doxyfile to include new folders.
Add a list for @hooks tags.
Fixed some parsing problems for Doxygen.
---
 Zotlabs/Module/Help.php | 38 ++++++++++++++------------------------
 1 file changed, 14 insertions(+), 24 deletions(-)

(limited to 'Zotlabs/Module/Help.php')

diff --git a/Zotlabs/Module/Help.php b/Zotlabs/Module/Help.php
index 54d4aecfb..570e8e0cf 100644
--- a/Zotlabs/Module/Help.php
+++ b/Zotlabs/Module/Help.php
@@ -1,66 +1,56 @@
 <?php
 namespace Zotlabs\Module;
 
-
 require_once('include/help.php');
 
 /**
  * You can create local site resources in doc/Site.md and either link to doc/Home.md for the standard resources
  * or use our include mechanism to include it on your local page.
- *
+ *@code
  * #include doc/Home.md;
+ *@endcode
  *
- * The syntax is somewhat strict. 
- *
+ * The syntax is somewhat strict.
  */
-
 class Help extends \Zotlabs\Web\Controller {
 
 	function get() {
-
 		nav_set_selected('help');
-	
+
 		if($_REQUEST['search']) {
-		
 			$o .= '<div id="help-content" class="generic-content-wrapper">';
 			$o .= '<div class="section-title-wrapper">';
 			$o .= '<h2>' . t('Documentation Search') . ' - ' . htmlspecialchars($_REQUEST['search']) . '</h2>';
 			$o .= '</div>';
 			$o .= '<div class="section-content-wrapper">';
-	
+
 			$r = search_doc_files($_REQUEST['search']);
 			if($r) {
 				$o .= '<ul class="help-searchlist">';
 				foreach($r as $rr) {
 					$dirname = dirname($rr['v']);
 					$fname = basename($rr['v']);
-					$fname = substr($fname,0,strrpos($fname,'.'));
-					$path = trim(substr($dirname,4),'/');
-	
-					$o .= '<li><a href="help/' . (($path) ? $path . '/' : '') . $fname . '" >' . ucwords(str_replace('_',' ',notags($fname))) . '</a><br />'
-						. '<b><i>' . 'help/' . (($path) ? $path . '/' : '') . $fname . '</i></b><br />' .
-					'...' . str_replace('$Projectname',\Zotlabs\Lib\System::get_platform_name(),$rr['text']) . '...<br /><br /></li>';
-	
+					$fname = substr($fname, 0, strrpos($fname, '.'));
+					$path = trim(substr($dirname, 4), '/');
+
+					$o .= '<li><a href="help/' . (($path) ? $path . '/' : '') . $fname . '" >' . ucwords(str_replace('_',' ',notags($fname))) . '</a><br>'
+						. '<b><i>' . 'help/' . (($path) ? $path . '/' : '') . $fname . '</i></b><br>'
+						. '...' . str_replace('$Projectname', \Zotlabs\Lib\System::get_platform_name(), $rr['text']) . '...<br><br></li>';
 				}
 				$o .= '</ul>';
 				$o .= '</div>';
 				$o .= '</div>';
 			}
+
 			return $o;
 		}
-	
 
 		$content =  get_help_content();
 
-
-		return replace_macros(get_markup_template("help.tpl"), array(
+		return replace_macros(get_markup_template('help.tpl'), array(
 			'$title' => t('$Projectname Documentation'),
 			'$content' => $content
 		));
-	
 	}
-	
-	
-	
-	
+
 }
-- 
cgit v1.2.3


From 7470b1180e884104b690b39dce90143c72c096a3 Mon Sep 17 00:00:00 2001
From: Andrew Manning <andrew@reticu.li>
Date: Sun, 27 Nov 2016 13:43:07 -0700
Subject: Add ability to include page assets in documentation pages such as
 images. Updated Personal Channel tutorial to use local images using this new
 capability.

---
 Zotlabs/Module/Help.php | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

(limited to 'Zotlabs/Module/Help.php')

diff --git a/Zotlabs/Module/Help.php b/Zotlabs/Module/Help.php
index 570e8e0cf..27d94e405 100644
--- a/Zotlabs/Module/Help.php
+++ b/Zotlabs/Module/Help.php
@@ -44,8 +44,39 @@ class Help extends \Zotlabs\Web\Controller {
 
 			return $o;
 		}
+                
+                
+                if(argc() > 2 && argv(argc()-2) === 'assets') {
+                        $path = '';
+                        for($x = 1; $x < argc(); $x ++) {
+                                if(strlen($path))
+                                        $path .= '/';
+                                $path .= argv($x);
+                        }
+                        $realpath = 'doc/' . $path;
+                         //Set the content-type header as appropriate
+                        $imageInfo = getimagesize($realpath);
+                        switch ($imageInfo[2]) {
+                            case IMAGETYPE_JPEG:
+                                header("Content-Type: image/jpeg");
+                                break;
+                            case IMAGETYPE_GIF:
+                                header("Content-Type: image/gif");
+                                break;
+                            case IMAGETYPE_PNG:
+                                header("Content-Type: image/png");
+                                break;
+                           default:
+                                break;
+                        }
+                        header("Content-Length: " . filesize($realpath));
 
-		$content =  get_help_content();
+                        // dump the picture and stop the script
+                        readfile($realpath);
+                        killme();
+                }
+
+                $content =  get_help_content();
 
 		return replace_macros(get_markup_template('help.tpl'), array(
 			'$title' => t('$Projectname Documentation'),
-- 
cgit v1.2.3


From 6668fe02aaa00e7b89af6d22bc9ae2781c756f39 Mon Sep 17 00:00:00 2001
From: Andrew Manning <tamanning@zoho.com>
Date: Fri, 9 Dec 2016 22:18:23 -0500
Subject: Only display h1 headings in sticky side nav. Toggle display of
 detailed TOC at top of page. Introduce return to top button for small
 screens.

---
 Zotlabs/Module/Help.php | 1 +
 1 file changed, 1 insertion(+)

(limited to 'Zotlabs/Module/Help.php')

diff --git a/Zotlabs/Module/Help.php b/Zotlabs/Module/Help.php
index 27d94e405..9d6e421e5 100644
--- a/Zotlabs/Module/Help.php
+++ b/Zotlabs/Module/Help.php
@@ -80,6 +80,7 @@ class Help extends \Zotlabs\Web\Controller {
 
 		return replace_macros(get_markup_template('help.tpl'), array(
 			'$title' => t('$Projectname Documentation'),
+			'$tocHeading' => t('Contents'),
 			'$content' => $content
 		));
 	}
-- 
cgit v1.2.3


From 0a21ffbfecf30f619bdfc8de15c88911a6d7d3db Mon Sep 17 00:00:00 2001
From: Mario Vavti <mario@mariovavti.com>
Date: Sun, 11 Dec 2016 21:43:27 +0100
Subject: show doc section heading in titlebar

---
 Zotlabs/Module/Help.php | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'Zotlabs/Module/Help.php')

diff --git a/Zotlabs/Module/Help.php b/Zotlabs/Module/Help.php
index 9d6e421e5..e247416d9 100644
--- a/Zotlabs/Module/Help.php
+++ b/Zotlabs/Module/Help.php
@@ -76,12 +76,24 @@ class Help extends \Zotlabs\Web\Controller {
                         killme();
                 }
 
+		$headings = [
+			'about' => t('About'),
+			'member' => t('Members'),
+			'admin' => t('Administrators'),
+			'developer' => t('Developers'),
+			'tutorials' => t('Tutorials')
+		];
+
+		if(array_key_exists(argv(1), $headings))
+			$heading = $headings[argv(1)];
+
                 $content =  get_help_content();
 
 		return replace_macros(get_markup_template('help.tpl'), array(
 			'$title' => t('$Projectname Documentation'),
 			'$tocHeading' => t('Contents'),
-			'$content' => $content
+			'$content' => $content,
+			'$heading' => $heading
 		));
 	}
 
-- 
cgit v1.2.3