sync doc with version 1.0

git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@9882 c8812cc2-4d05-0410-92ff-de0c093fc19c
qgis · Dec 20, 2008 · 57f29d2 · 57f29d2
1 parent 235851c
commit 57f29d2
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 16 deletions.
diff --git a/doc/CODING.t2t b/doc/CODING.t2t
@@ -17,15 +17,17 @@ Developers guide for QGIS
 %txt2tags home page for more details.  Please insert manual line breaks in this
 %document as it makes diffing for changes much easier. To do this in vim 
 %automatically, select a section then issue (gq) command. Please dont
-%apply vim formatting to the whol document as it screws up some formatting
+%apply vim formatting to the whole document as it screws up some formatting
 %rather apply it selectively to paragraphs where needed.
 
 % To generate the text version of this document:
 % txt2tags -t txt -o CODING CODING.t2t
-% To generate the moinmoin version of this document
-% txt2tags -t moin CODING.moin  CODING.t2t
-% To generate the html version of this document
-% txt2tags -t html CODING.html  CODING.t2t
+% To generate the moinmoin version of this document:
+% txt2tags -t moin -o CODING.moin CODING.t2t
+% To generate the html version of this document:
+% txt2tags -t html -o CODING.html CODING.t2t
+% To generate the LaTeX version of this document:
+% txt2tags -t tex -o CODING.tex CODING.t2t
 %
 % End of comments
 % -------------------

diff --git a/doc/INSTALL.t2t b/doc/INSTALL.t2t
@@ -17,15 +17,17 @@ Building QGIS from source - step by step
 %txt2tags home page for more details.  Please insert manual line breaks in this
 %document as it makes diffing for changes much easier. To do this in vim 
 %automatically, select a section then issue (gq) command. Please dont
-%apply vim formatting to the whol document as it screws up some formatting
+%apply vim formatting to the whole document as it screws up some formatting
 %rather apply it selectively to paragraphs where needed.
 
 % To generate the text version of this document:
 % txt2tags -t txt -o INSTALL INSTALL.t2t
-% To generate the moinmoin version of this document
-% txt2tags -t moin INSTALL.moin  INSTALL.t2t
-% To generate the html version of this document
-% txt2tags -t html INSTALL.html  INSTALL.t2t
+% To generate the moinmoin version of this document:
+% txt2tags -t moin -o INSTALL.moin INSTALL.t2t
+% To generate the html version of this document:
+% txt2tags -t html -o INSTALL.html INSTALL.t2t
+% To generate the LaTeX version of this document:
+% txt2tags -t tex -o INSTALL.tex INSTALL.t2t
 
 % End of comments
 % -------------------
@@ -75,8 +77,8 @@ somecommand to be pasted
 
 = General Build Notes = 
 
-At version 0.8.1 QGIS no longer uses the autotools for building. QGIS, like a
-number of major projects (eg. KDE 4.0), now uses cmake (http://www.cmake.org)
+Since version 0.8.1 QGIS no longer uses the autotools for building. QGIS, like a
+number of major projects (eg. KDE 4.0), now uses CMake (http://www.cmake.org)
 for building from source. The configure script in this directory simply checks
 for the existence of cmake and provides some clues to build QGIS.
 

diff --git a/doc/index.dox b/doc/index.dox
@@ -5,15 +5,40 @@
 /*! \mainpage Quantum GIS
 
 \section index_intro Introduction
-\htmlonly<img src="http://download.qgis.org/qgis-icon-60x60.png" alt="QGIS" align="left"><a href="http://qgis.org">Quantum GIS</a>\endhtmlonly\latexonly Quantum GIS \endlatexonly  (QGIS) is a user friendly Open Source Geographic Information System (GIS) that runs on Linux, Unix, Mac OSX, and Windows. QGIS supports vector, raster, and database formats. QGIS is licensed under the GNU General Public License. QGIS lets you browse and create map data on your computer. It supports many common spatial data formats (e.g. ESRI ShapeFile, geotiff). QGIS supports plugins to do things like display tracks from your GPS. QGIS is Open Source software and its free of cost (download here). We welcome contributions from our user community in the form of code contributions, bug fixes, bug reports, contributed documentation, advocacy and supporting other users on our mailing lists and forums. Financial contributions are also welcome.
+\htmlonly<img src="http://download.qgis.org/qgis-icon-60x60.png" alt="QGIS"
+align="left"><a href="http://qgis.org">Quantum GIS</a>\endhtmlonly\latexonly
+Quantum GIS \endlatexonly  (QGIS) is a user friendly Open Source Geographic
+Information System (GIS) that runs on Linux, Unix, Mac OSX, and Windows. QGIS
+supports vector, raster, and database formats. QGIS is licensed under the GNU
+General Public License. QGIS lets you browse and create map data on your
+computer. It supports many common spatial data formats (e.g. ESRI ShapeFile,
+geotiff). QGIS supports plugins to do things like display tracks from your GPS.
+QGIS is Open Source software and its free of cost (download here). We welcome
+contributions from our user community in the form of code contributions, bug
+fixes, bug reports, contributed documentation, advocacy and supporting other
+users on our mailing lists and forums. Financial contributions are also
+welcome.
+
+\section index_APIStability API Stability
+
+Versions of QGIS prior to 1.0 did not guarantee API stability since the
+application was undergoing rapid development of new features and we did not
+want to commit ourselves to a fixed API. With the release of QGIS 1.0 we 
+guarantee a backwards compatible API  for the 1.x and 1.0.x release series. 1.x
+releases will be our 'unstable' development builds and 1.0.x releases our
+'stable' (bugfixes and very minor tweaks only).
 
 \section index_maillist Mailing Lists
 <ul>
-<li>For support we encourage you to join our <a href="http://qgis.org/content/view/115/96/">mailing lists</a> for developers.</li>
-</ul>
+<li>For support we encourage you to join our <a
+href="http://qgis.osgeo.org/community/mailing-lists.html">mailing lists</a> for
+developers.</li> </ul>
 
 \section index_bugs Bug Reporting
-If you think you have found a bug, please report it using our <a href="https://trac.osgeo.org/qgis/">bug tracker</a>. When reporting bugs, please include some contact information in case we need help with replicating your issue.
+If you think you have found a bug, please report it using our <a
+href="https://trac.osgeo.org/qgis/">bug tracker</a>. When reporting bugs,
+please include some contact information in case we need help with replicating
+your issue.
 
 \section index_maillist Mailing Lists
 Some QGIS users and developers can also often be found in the