[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    kdevelop/doc/kdevelop
From:       Bernd Pol <bernd.pol () online ! de>
Date:       2004-03-29 10:13:39
Message-ID: 20040329101339.725E5999B () office ! kde ! org
[Download RAW message or body]

CVS commit by brpol: 

"Displaying Selected Documentation in a Project" section added


  A            configure-project-doc.png   1.1
  A            doctree-reduced.png   1.1
  M +1 -1      index.docbook   1.57
  M +35 -2     setup.docbook   1.10


--- kdevelop/doc/kdevelop/index.docbook  #1.56:1.57
@@ -45,5 +45,5 @@
   <title>&kdevelop; User Manual</title>
 
-  <date>2004-03-28</date>
+  <date>2004-03-29</date>
   <releaseinfo>&kdevrelease;</releaseinfo>
 

--- kdevelop/doc/kdevelop/setup.docbook  #1.9:1.10
@@ -1078,5 +1078,5 @@
 </simplelist>
 <para>
-Additionally you have the option to select what the documentatione tree should \
display as +Additionally you have the option to select what the documentation tree \
should display as  </para>
 <simplelist>
@@ -1642,6 +1642,39 @@
 
 <para>
-(... to be written ...)
+When working on a project one usually does not need all of the documentation \
&kdevelop; provides. Thus for any project you may configure the documentation tree to \
display only those documents you really want to work with. +</para>
+<para>
+You need to have your project loaded already. Then select <menuchoice> \
<guimenu>Project</guimenu> <guimenuitem>Project \
Options...</guimenuitem></menuchoice>. This will display the <guilabel>Project \
Options</guilabel> dialog, structured similar to the standard &kdevelop; \
configuration dialog. Select <guilabel>Project Documentation</guilabel> from the tree \
at the left hand side to display this <guilabel>Project Documentation</guilabel> \
configuration dialog page:  </para>
+
+<screenshot>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="configure-project-doc.png" format="PNG"/>
+    </imageobject>
+    <caption><para>
+    Configuring the project documentation
+    </para></caption>
+  </mediaobject>
+</screenshot>
+
+<para>
+In the <guilabel>Displayed documents in the documentation browser</guilabel> list \
mark those documents you want to refer to when working on your project. Remove the \
tick marks from all other check boxes. +</para>
+<para>
+&kdevelop; will save these settings together with the other project options when you \
pressed the <guibutton>OK</guibutton> button. From then on the documentation tree \
will present your reduced list only any time this project was loaded as the following \
example shows. +</para>
+
+<screenshot>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="doctree-reduced.png" format="PNG"/>
+    </imageobject>
+    <caption><para>
+    Displaying selected documentation only in a given project
+    </para></caption>
+  </mediaobject>
+</screenshot>
+
 </sect2> <!-- setup-docu-project -->
 


[prev in list] [next in list] [prev in thread] [next in thread]