Documentation updated, closes #7

de-jcup · de-jcup · commit e52b7c7cf931 · 2017-11-12T16:08:53.000+01:00
diff --git a/basheditor-plugin/html/code-assistence.html b/basheditor-plugin/html/code-assistence.html
@@ -0,0 +1,30 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Outline</title>
+</head>
+
+<body>
+	<img src="images/bash-editor-logo.png" />
+	<a href="toc.html">Table of content</a>
+	<h3>Code assistence</h3>
+	<p>
+	Like any other code completion in eclipse you start with <code>CTRL + SPACE</code> and you
+	get the proposals. 
+	</p>
+	<h4>Supported proposals</h4>
+	<h5>Simple word proposals</h5>
+	<p>
+		The document is scanned for already existing words. Those words are available as proposals.
+	</p>
+	<h5>Keyword proposals</h5>
+	<p>
+		All keywords known by bash editor will be added as proposals (bash, GNU, ...)
+	</p>
+	<h4>How to disable code completion or parts?</h4>
+	<p>The different kind of proposals can be turned on/off inside 
+	<code>Preferences->Bash Editor</code>.</p>
+</body>
+</html>
diff --git a/basheditor-plugin/html/toc.html b/basheditor-plugin/html/toc.html
@@ -15,6 +15,7 @@ <h4>Features</h4>
 		<li><a href="outline.html">Outline</a> view</li>
 		<li><a href="quick-outline.html">Quick-Outline</a> dialog</li>
 		<li><a href="validation.html">Validation</a></li>
+		<li><a href="code-assistence.html">Code assistence</a></li>
 		<li><a href="open-function-reference.html">Open referenced functions</a></li>
 		<li><a href="syntax_coloring.html#syntax_coloring">Syntax
 				highlighting</a></li>
@@ -25,7 +26,7 @@ <h4>Features</h4>
 		<li><a href="bracket_switching.html">Bracket switching</a> +
 			highlighting</li>
 		<li><a href="block_commenting.html">Block commenting</a> (CTRL+7)</li>
-		<li>Auto bracket closing for []</li>
+		<li>Auto bracket closing for [] and {}</li>
 		<li>Small footprint</li>
 	</ul>
 	<p>There are also some videos about bash editor features available at <a href="https://www.youtube.com/playlist?list=PLaBYAz_I_8tF7sZVIcUv8zOVe2RMiWn-L">YouTube</a></p>
diff --git a/basheditor-plugin/toc.xml b/basheditor-plugin/toc.xml
@@ -8,7 +8,18 @@
   <topic href="html/syntax_coloring.html" label="Syntax coloring">
 		</topic>
   <topic href="html/outline.html" label="Outline">
+  </topic>
+   <topic href="html/quick-outline.html" label="Quick Outline">
   </topic>
   <topic href="html/validation.html" label="Validation">
   </topic>
+  <topic href="html/open-function-reference.html" label="Open referenced function">
+  </topic>
+  <topic href="html/code-assistence.html" label="Code assistence">
+  </topic>
+  <topic href="html/block_commenting.html" label="Block commenting">
+  </topic>
+  <topic href="html/bracket_switching.html" label="Bracket switching">
+  </topic>
+
 </toc>
