Updated documentation generation.

Author: sadko4u

src/doc/config/menu.php

@@ -11,7 +11,7 @@
 	{
 		// Remove _xN, _mono, _stereo, _midi, _do, _ls, _ms postfixes from plugin name
 		$page_id = preg_replace('/(?:_x\d+)?(?:_midi)?(?:_mono|_stereo|_do|_lr|_ms)?$/', '', $plugin['id']);
-		def_menu_item('plugins', $plugin['id'], $plugin['description'] . ' - ' . $plugin['name'], $page_id);
+		def_menu_item('plugins', $plugin['id'], $plugin['description'], $page_id);
 	}
 
 	def_menu_item('', 'tutorials', 'Tutorials and Tips');

src/doc/inc/files.php

@@ -5,13 +5,13 @@ function file_emit_line(&$state, $line = '', $tag = null)
 		if (count($s) <= 0)
 			return;
 
-		if ((!isset($tag)) || ($tag == null))
-			$tag = $s;
+		if (!isset($tag))
+			$tag = end($s);
 
-		print('<' . end($tag) . '>');
+		print('<' . $tag . '>');
 		print(htmlspecialchars($state['line'] . $line));
 		$state['line'] = '';
-		print('</' . end($tag) . ">\n");
+		print('</' . $tag . ">\n");
 
 		array_pop($s);
 	}
@@ -79,13 +79,12 @@ function file_process_string(&$state, $line)
 		}
 		elseif ($last == 'pre-q')
 		{
-			if (!preg_match('/^```.*$/', $line, $match))
+			if (preg_match('/^```.*$/', $line, $match))
 			{
 				file_emit_line($state, "", "pre");
-				$state['unget'] = null;
 			}
 			else
-				file_append_line($state, $match[1] . "\n");
+				file_append_line($state, $line . "\n");
 		}
 		else
 		{
@@ -122,7 +121,7 @@ function file_content($file, $section = null)
 		else
 		{
 			$pattern = '/^\={1,}\s*' . $section . '\s*\={1,}\s*$/i';
-			$pattern2 = '/^#{1,}\s*' . $section . '\s*$/i';
+			$pattern2 = '/^\#{1,}\s*' . $section . '\s*$/i';
 			$search  = true;
 			$state   = array(
 				'line' => '',
@@ -133,19 +132,20 @@ function file_content($file, $section = null)
 			while ((isset($state['unget'])) || (!feof($fd)))
 			{
 				$line = isset($state['unget']) ? $state['unget'] : fgets($fd);
+				$state['unget'] = null;
+				
 				if ($search)
 				{
 					if (preg_match($pattern, $line))
 						$search = false;
-					elseif (preg_match($pattern, $line))
+					elseif (preg_match($pattern2, $line))
 						$search = false;
 				}
 				else
 				{
-					$state['unget'] = null;
 					if (preg_match('/^\={1,}\s*.+\s*\={1,}\s*$/', $line))
 						break;
-					if (preg_match('/^#{1,}\s*.+$/', $line))
+					if (preg_match('/^\#{1,}\s*.+$/', $line))
 						break;
 
 					file_process_string($state, $line);

src/doc/inc/plugins.php

@@ -16,15 +16,15 @@ function sort_plugins()
 
 	function plugin_header()
 	{
-		global $PLUGINS, $PAGE, $DOCROOT;
+		global $PACKAGE, $PLUGINS, $PAGE, $DOCROOT;
 
 		// Output plugin
 		foreach ($PLUGINS as $plugin)
 		{
 			if ($plugin['id'] != $PAGE)
 				continue;
 
-			echo "<h1>" . $plugin['name'] . "</h1>\n";
+			echo "<h1>" . htmlspecialchars($plugin['description']) . "</h1>\n";
 
 			$fmt = array();
 			if (isset($plugin['ladspa_label']) && ($plugin['ladspa_label'] > 0))
@@ -36,11 +36,14 @@ function plugin_header()
 			if (isset($plugin['vst2_uid']) && (strlen($plugin['vst2_uid']) > 0))
 				array_push($fmt, 'JACK');
 
+			$full_name = htmlspecialchars("{$PACKAGE['short']} {$plugin['description']} ({$plugin['acronym']})");
+			$author = htmlspecialchars($plugin['author']);
+			
 			echo "<img class=\"plugin\" src=\"${DOCROOT}img/plugins/{$plugin['id']}.png\" alt=\"{$plugin['name']}\">\n";
-			echo "<p><b>Detailed:&nbsp;</b>LSP {$plugin['description']} - {$plugin['name']} ({$plugin['acronym']})</p>\n";
+			echo "<p><b>Detailed:&nbsp;</b>{$full_name}</p>\n";
 			echo "<p><b>Formats:&nbsp;</b>" . implode(',&nbsp;', $fmt) . "</p>\n";
 			echo "<p><b>Categories:&nbsp;</b>" . implode(',&nbsp;', $plugin['groups']) . "</p>\n";
-			echo "<p><b>Developer:&nbsp;</b>{$plugin['author']}</p>\n";
+			echo "<p><b>Developer:&nbsp;</b>{$author}</p>\n";
 			echo "<p><b>Description:&nbsp;</b></p>\n";
 			break;
 		}
@@ -54,12 +57,13 @@ function out_image($id, $alt)
 
 	function plugin_ref($id)
 	{
-		global $DOCROOT;
+		global $DOCROOT, $PACKAGE;
 		$page       = find_menu_item($id);
 		if (!isset($page))
 			return;
 
-		print("<b><a href=\"${DOCROOT}html/plugins/${page['id']}.html\">LSP " . htmlspecialchars($page['text']) . "</a></b>");
+		$header = htmlspecialchars("{$PACKAGE['short']} {$page['text']}");
+		print("<b><a href=\"${DOCROOT}html/plugins/${page['id']}.html\">{$header}</a></b>");
 	}
 
 ?>