Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

Diff of /docs/users-guide.xml [c4d27c] .. [ad6660] Maximize Restore

  Switch to side-by-side view

--- a/docs/users-guide.xml
+++ b/docs/users-guide.xml
@@ -18,7 +18,7 @@
    the license can be found in the file <filename>COPYING.DOC.txt</filename>
    included with jEdit.
   </para>
-  
+
  </legalnotice>
  </bookinfo>
 
@@ -35,16 +35,6 @@
   executable. And finally, it provides a plugin interface through which other
   jEdit plugins can easily access ctags data.
  </para>
- 
- <section id="tags-plugin">
- <title> Replacing the Tags plugin </title>
- 
- <para> With the exception of the "push/pop position" actions, all other features
- of the old Tags plugin (no longer supported) should be available from CtagsInterface.
- The push/pop position actions are available from the Navigator plugin. 
- </para>
- </section>
- 
  </chapter>
 
  <chapter id="setup">
@@ -55,64 +45,45 @@
   tree, unless you tell it otherwise.
   Under <literal>Plugin Options - CtagsInterface - General</literal> you will
   find a field for specifying
-  <emphasis role="bold">Ctags Invocation Options</emphasis>. The options required
-  for smooth running of CtagsInterface are 
-  <literallayout>--fields=+anzKiSl</literallayout>, in addition, 
-  as shown below, you can specify that only certain
+  <emphasis role="bold">Ctags Invocation Options</emphasis>. By adding extra
+  options to this field, as shown below, you can specify that only certain
   file types are scanned and indexed. Read the manual pages of exuberant ctags
   for more information about the options available.
  </para>
 
  <literallayout> --languages=c,c++,java,python </literallayout>
- 
 </chapter>
  <chapter id="tagdbs">
-   <title> Tagging Projects, Trees, Archives and Source and Tag Files</title>
+   <title> Tagging Projects and Source Trees </title>
 
    <para>
     CtagsInterface uses a Lucene index to keep track of tag data from multiple
-    origins (currently projects, trees, archives and source and tag files). 
-	<guimenuitem>Plugin Options - CtagsInterface</guimenuitem> provides three
-	panes for defining which origins should be indexed: 
-	<guimenuitem>Trees/Archives</guimenuitem>, 
-	<guimenuitem>Files</guimenuitem> and <guimenuitem>Projects</guimenuitem>.
-   </para>
-
-   <para>
-    The first step is to add the origins that you want to be tagged. Tagging is 
-	done in the background, you can continue working with jEdit meanwhile. The 
-	tagging progress is shown in the <guilabel>Progress</guilabel> dockable, in 
-	a tab of a tabbed pane. When done, you can lookup tags from the origins you 
-	have added.
+    projects and directory trees. The
+    <guimenuitem>Plugin Options - CtagsInterface</guimenuitem> provides
+    dialogs for adding projects and directory trees that should be indexed.
+   </para>
+
+   <para>
+    The first step is to add the projects and source trees that you want to be
+    tagged in the index. Tagging is done in the background, you can continue
+    working with jEdit meanwhile. The tagging progress is shown in the
+    <guilabel>Progress</guilabel> dockable, in a tab of a tabbed pane. When
+    done, you can lookup tags from the projects and source trees.
    </para>
 
    <para>
     You can add projects two ways. From the ProjectViewer, right click on the
-    project and <guimenuitem>Add Project to index</guimenuitem>, or from
+    project and <guimenuitem>Add Project to index</guimenuitem>. Or, from
     <guimenuitem>Plugin Options - CtagsInterface - Projects</guimenuitem>.
    </para>
 
    <para>
-    Similarly, you can add trees and archives from
-    <guimenuitem>Plugin options - CtagsInterface - Trees/Archives</guimenuitem>. 
-    You can also add source files and trees from the file system browser
-    context menu:
-    <guimenuitem>Plugins - Add source files/trees to tag index</guimenuitem>. </para>
-
-    <para>
-	Lastly source and tag files can be added from
-    <guimenuitem>Plugin options - CtagsInterface - Files</guimenuitem>
-    and the source file currently in your buffer can be added through 
-    the <guimenuitem>Add current file</guimenuitem> action.
-    Tags files can be added with the action <guimenuitem> Add Tag File...</guimenuitem>. 
-   </para>
-
-   <para>
-	Tags can be removed from the index using the options pane, actions in 
-	<guimenuitem>Plugins - CtagsInterface</guimenuitem> or the ProjectViewer 
-	context menu
-   </para>
-   
+    Similarly, you can add source trees from the
+    <guimenuitem>Plugin options - CtagsInterface - Source Trees</guimenuitem>,
+    or from the file system browser context menu:
+    <guimenuitem>Plugins - Add source tree to tag index</guimenuitem>.
+   </para>
+
  </chapter>
 
  <chapter id="lookup">
@@ -120,98 +91,57 @@
 
    <para>
     By default, tag lookup will search the entire tag index for matching tags,
-    including all added origins.
+    including all added projects and source trees.
    </para>
 
    <para>
     When using jEdit with ProjectViewer, you might be working with a set of
     files, and have to frequently check another set of files that you are
     reusing. This means that you will probably want to restrict your search
-    to only the origins that are related to your project.
-   </para>
-
-   <para> By editing the properties of the current project, you can see a
-   <guilabel>Dependencies</guilabel> pane, which allows you to set the related
-   projects, trees/archives or files on an individual project basis. While
-   running the Tag Preview, or performing a Jump to Tag while working in a
-   project that has dependencies set, CtagsInterface should restrict its
-   searches to tag data from only those dependencies. </para>
-
-   <para> This is especially useful in the case where there are many origins
-   indexed in the tags index that are not related to each other. </para>
-   
-	<para> In addition, when the option to 'Match tags with language of current
-	buffer' is selected searches will be restricted to tags whose language
-	matches that of the file in the current buffer. File extension is used to do
-	this matching and the mapping can be seen by calling ctags with the
-	<literal>--list-maps</literal> option. If the source file's language hasn't
-	been tagged and this option is selected searches will return nothing, to fix
-	this retag your source files including the 'l' flag in the ctags
-	<literal>--fields</literal> option. </para>
+    to only the projects and source trees that are related to your project.
+   </para>
+
+   <para>
+    By editing the properties of the current project, you can see a
+    <guilabel>Dependencies</guilabel> pane, which allows you to set the
+    related projects or source trees on an individual project basis. While
+    running the Tag Preview, or performing a Jump to Tag while working in a
+    project that has dependencies set, CtagsInterface should restrict its
+    searches to tag data from only those projects and directory trees.
+   </para>
+
+   <para>
+    This is especially useful in the case where there are many projects /
+    source trees indexed in the tags database that are not related to each
+    other.
+   </para>
 
  </chapter>
 
  <chapter id="actions">
    <title> Actions </title>
 
-   <formalpara><title> Add Current File </title>
-   <para>
-    Tags the file in the current buffer and adds it to the index.
-   </para>
-   </formalpara>
-   
-  <formalpara><title> Update Current File </title> <para> Updates the file in
-  the current buffer in the index, doesn't add the file as an origin if it's
-  already in the index. </para> </formalpara>
-   
-   <formalpara><title> Remove Current File </title> <para> Removes the tags from
-   the file in the current buffer and their origin from the index. </para>
-   </formalpara>
-
-   <formalpara><title> Remove All Tags </title>
-   <para>
-    Removes all tags and their origins from the index.
-   </para>
-   </formalpara>
-
-   <formalpara><title> Jump to tag </title> <para> Opens the file that the tag
-   currently under the caret originates from and moves the caret to the tag
-   definition within that file. </para> </formalpara>
-   
-   <formalpara><title> Tag Preview Current </title> <para> Previews the tag
-   currently under the caret in the Tag Preview dockable. Useful when the "Follow
-   caret" Tag Preview option is deselected </para> </formalpara>
-
-   <formalpara><title> Search tag by substring </title> <para> Provides a dialog
-   to conduct a substring search of the tag index, results returned in a pop-up.
-   </para> </formalpara>
-
-   <formalpara><title> Search tag by prefix </title> <para> Provides a dialog to
-   conduct a prefix search of the tag index, results returned in a pop-up.
-   </para> </formalpara>
-   
-  <formalpara><title> Tag all projects </title>
+   <formalpara><title> Add tag File </title>
+   <para>
+    Adds an already generated ctags file to the database.
+   </para>
+   </formalpara>
+
+   <formalpara><title> Tag all projects </title>
    <para>
     This does exactly what it says: it goes through
     <emphasis role="bold">every</emphasis> project that ProjectViewer knows
-    about, and tags their files, adding the tag data to the embedded index.
-   </para>
-   </formalpara>
-   
+    about, and tags their files, adding the tag data to the embedded database.
+   </para>
+   </formalpara>
+
    <formalpara><title> Suggest completion options </title>
    <para>
-    Suggests code-completion options from the tag index. This includes
+    Suggests code-completion options from the tag database. This includes
     completion of function calls, using SuperAbbrevs for conveniently
     filling-in the parameter values.
    </para>
    </formalpara>
-   
-  <formalpara><title> Run Query </title> <para> Provides a dialog for running
-  queries on the tag index using the Lucene query syntax. </para> </formalpara>
-
-  <formalpara><title> Show Query Dialog </title> <para> Provides a dialog and
-  results pane for running queries on the tag index using the Lucene query
-  syntax. </para> </formalpara>
 
    <section id="dynamic-actions">
    <title> Dynamic Actions </title>
@@ -220,21 +150,21 @@
     In addition to these built-in actions, CtagsInterface allows you to create
     dynamic Actions, which are custom Lucene queries, which can be bound to
     keyboard shortcuts. Each such Lucene query should retrieve a list of tags
-    from the index. There are 3 types of dynamic actions:
+    from the database. There are 3 types of dynamic actions:
     <orderedlist>
-    <listitem><para>
+    <listitem>
      Jump to tag - execute the query and show the list of tags it retrieved
      in the <guilabel>Tag List</guilabel> dockable, allowing you to jump to any
      of them. In case the query returns a single tag, the dynamic action jumps
-     to it directly, without showing it in the dockable.</para>
-    </listitem>
-    <listitem><para>
+     to it directly, without showing it in the dockable.
+    </listitem>
+    <listitem>
      Search prefix - execute the query and show the "Prefix search" popup so
-     you can choose a tag from the query results using its prefix. </para>
-    </listitem>
-    <listitem> <para>
+     you can choose a tag from the query results using its prefix.
+    </listitem>
+    <listitem>
      Search string - execute the query and show the "Prefix search" popup so
-     you can choose a tag from the query results using a substring. </para>
+     you can choose a tag from the query results using a substring.
     </listitem>
     </orderedlist>
    </para>
@@ -287,22 +217,9 @@
    </formalpara>
    <formalpara> <title> Tag Preview </title>
    <para>
-    This dockable is used to preview tags currently being edited, and has an 
-	option to update automatically (after a configurable delay) whenever the
-	caret is moved over a location that is a known symbol in the tag index. 
-	The dockable has an optional gutter with numbers and folding that matches 
-	the mode used in the previewed buffer. In addition CtagsSideKick can be 
-	forced as the fold handler if it's been installed. Using this and the 
-	option to collapse all folds allows for a more compact preview that's 
-	restricted to lines that have been parsed by CtagsSideKick. This can be 
-	modified by specifying which kinds of tags CtagsSideKick includes in 
-	<guimenuitem>Plugin Options - CtagsSideKick - Tree Style - Ctags 
-	invocation options</guimenuitem>. For instance adding 
-	<literallayout>--java-kinds=cmp</literallayout> to the invocation option
-	will lead to folds being added around the classes, methods and packages 
-	of java files when they are previewed. See 
-	<literallayout>--list-kinds</literallayout> in the ctags documentation 
-	for more information.
+    This dockable is updated automatically (after a configurable delay)
+    whenever the caret is moved over a location that is a known symbol in the
+    tag index.
    </para>
 
    </formalpara>