[anjuta] manual: Add some initial content to the code editing/navigation topics.



commit c295c5f35b8ec26510d1f5d97cec212ac93366e3
Author: Johannes Schmid <jhs gnome org>
Date:   Mon Oct 24 12:34:43 2011 +0200

    manual: Add some initial content to the code editing/navigation topics.

 manuals/anjuta-manual/C/anjuta-code-assist.page    |   28 +++++++++++++-
 manuals/anjuta-manual/C/anjuta-code-help.page      |   17 ++++++++
 .../anjuta-manual/C/anjuta-code-indentation.page   |   40 +++++++++++++++++++-
 3 files changed, 81 insertions(+), 4 deletions(-)
---
diff --git a/manuals/anjuta-manual/C/anjuta-code-assist.page b/manuals/anjuta-manual/C/anjuta-code-assist.page
index 7d3c92f..07aa0c7 100644
--- a/manuals/anjuta-manual/C/anjuta-code-assist.page
+++ b/manuals/anjuta-manual/C/anjuta-code-assist.page
@@ -5,7 +5,7 @@
   <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
     <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
     <link type="guide" xref="index#anjuta-code" group="first"/>
-    <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+    <revision pkgversion="3.0" version="0.1" date="2011-10-24" status="draft"/>
     <credit type="author">
       <name>Johannes Schmid</name>
       <email>jhs gnome org</email>
@@ -15,11 +15,35 @@
   <title>Autocompletion and calltips</title>
 
 <section>
-<title>Autocompletion is not working</title>
+<title>Autocompletion</title>
+<p>Autocompletion automatically suggests functions and other code symbols after
+you start typing by trying to match existing symbols with the first characters typed.
+It will popup a drop-down menu where you can select a match by using the
+<key>Enter</key> key. Normally this happens automaticly after you typed the third
+(non-whitespace) character but you can also
+force it by using the <guiseq><gui>Edit</gui><gui>Auto-Complete</gui></guiseq>
+menu item.
+</p>
+<note>
+<p>Anjuta supports autocompletion for code written in C/C++, Vala, Javascript
+and Python. Note that autocompletion can only work if anjuta knows about the
+symbols used. If you are using libraries C/C++ libraries that are
+not configured using <cmd>pkg-config</cmd> and/or not added to the project
+configuration, anjuta won't be able to find those
+symbols and autocompletion might not work.
+</p>
+<p>In addition some syntax might be too complex for the integrated parser and
+it might not be able to detect which completion is required</p>
+</note>
 </section>
 
 <section>
 <title>Effective coding using calltips</title>
+
+<p>As it is usually quite hard to remember the signature of every method or function
+used in a project, the editor will automatically display a small tooltip whenever
+you type '(' after a function name and show you the signature.</p>
+
 </section>
 
 </page>
\ No newline at end of file
diff --git a/manuals/anjuta-manual/C/anjuta-code-help.page b/manuals/anjuta-manual/C/anjuta-code-help.page
index a9cb64c..3c4de03 100644
--- a/manuals/anjuta-manual/C/anjuta-code-help.page
+++ b/manuals/anjuta-manual/C/anjuta-code-help.page
@@ -16,10 +16,27 @@
 
 <section>
 <title>Browsing the API reference</title>
+
+<p>For a quick access to the API reference of libraries, anjuta features an
+integrated API browser. If not already done it can be activated in the preferences
+(<guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq>) in 
+<guiseq><gui>General</gui><gui>Plugins</gui></guiseq> by choosing the 
+<app>DevHelp</app> plugin.</p>
+
+<p>The API reference has two windows, one for searching for a specific symbol
+and the browser for viewing the help documents.</p>
+
 </section>
 
 <section>
 <title>Jump to the API reference using shortcuts in the editor</title>
+
+<p>In case you are unsure how a specific function used in existing code works, 
+simply place the cursor on the function name and use 
+<keyseq><key>Ctrl</key><key>F1</key></keyseq> (or 
+<guiseq><gui>Help</gui><gui>Context-Help</gui></guiseq>) to jump to the documentation.
+</p>
+
 </section>
 
 </page>
\ No newline at end of file
diff --git a/manuals/anjuta-manual/C/anjuta-code-indentation.page b/manuals/anjuta-manual/C/anjuta-code-indentation.page
index d2f4a65..b0c3629 100644
--- a/manuals/anjuta-manual/C/anjuta-code-indentation.page
+++ b/manuals/anjuta-manual/C/anjuta-code-indentation.page
@@ -5,7 +5,7 @@
   <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
     <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
     <link type="guide" xref="index#anjuta-code" group="first"/>
-    <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+    <revision pkgversion="3.0" version="0.1" date="2011-10-24" status="draft"/>
     <credit type="author">
       <name>Johannes Schmid</name>
       <email>jhs gnome org</email>
@@ -15,20 +15,56 @@
   <title>Auto-indentation</title>
 
 <section>
-<title>Configuring auto-indentation</title>
+<title>Configuring and using auto-indentation</title>
 
 <section>
 <title>Manual configuration</title>
+
+<p>Automatic indentation is configured in the preferences 
+(<guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq>) in the tab corresponding
+to the used programming language. The indentation width for several types
+of statements can be set there.</p>
+
+<p>The big disadvantage of manually configuring indentation is that all 
+developers working on a project must use the same settings or it will result
+if different styles used in the same files. For a better solution, see
+the next section.</p>
+
+<note>
+<p>Unless explicitely changed in the preferences the indentation settings found
+in the Modeline of a file will be used instead of the 
+configured settings to keep the file consistent.</p>
+</note>
 </section>
 
 <section>
 <title>Modelines</title>
+
+<p>Modelines are used to help editors to automatically detect the indentation
+mode which should be used for a particular file. They are especially useful if
+many developers work on the same project and use different environments.</p>
+
+<p>A typical modeline looks like this:</p>
+
+<code>
+/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
+</code>
+
+<p>Anjuta supports modelines in the two formats used by <app>vim</app> and 
+<app>emacs</app> as far as appropriate. For detailed information on the
+formats please consult the documentation of those two editors.</p>
+
 </section>
 
 </section>
 
 <section>
 <title>Indenting blocks of code</title>
+
+<p>Normally new lines are approprietely indented automatically but you can
+indent existing lines or all selected code with the 
+<guiseq><gui>Edit</gui><gui>Auto-Indent</gui></guiseq> menu item.</p>
+
 </section>
 
 </page>
\ No newline at end of file



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]