mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-14 00:07:35 -04:00
[FEATURE] documentation improvements
replace AUTHORS, CONTRIBUTORS, DONORS, SPONSORS and TRANSLATOR with t2t version in doc, run txt2tags within the build and install documentation. Optionally build and install api documentation git-svn-id: http://svn.osgeo.org/qgis/trunk@15348 c8812cc2-4d05-0410-92ff-de0c093fc19c
This commit is contained in:
jef
parent
1054cfaa54
commit
0cd4317bc0
43
AUTHORS
43
AUTHORS
@ -1,43 +0,0 @@
|
||||
# The following have contributed to QGis:
|
||||
# --------------------------------------------------------
|
||||
# Please note that this file is parsed by the about box
|
||||
# for the contributors list, so names should be strictly
|
||||
# in the format:
|
||||
# name [tab] <email>
|
||||
#
|
||||
# ---------------------------------------------------------
|
||||
#
|
||||
# ALWAYS USE UTF-8 WHEN WRITING THIS FILE!
|
||||
#
|
||||
Gary E.Sherman <sherman at mrcc dot com>
|
||||
Steve Halasz <stevehalasz at users.sourceforge.net>
|
||||
Marco Hugentobler <mhugent at users.sourceforge.net>
|
||||
Tim Sutton <tim at linfiniti.com>
|
||||
Denis Antipov <rawbytes at users.sourceforge.net>
|
||||
Mark Coletti <mcoletti at users.sourceforge.net>
|
||||
Lars Luthman <larsl at users.sourceforge.net>
|
||||
Jens Oberender <j.obi at troja.net>
|
||||
Christoph Spoerri <spoerri at users.sourceforge.net>
|
||||
Carl Anderson <>
|
||||
Gavin Macaulay <gavin at macaulay dot co dot nz>
|
||||
Masaru Hoshi <hoshi at users.sourceforge.net>
|
||||
Peter Brewer <p.w.brewer at rdg dot ac dot uk>
|
||||
Radim Blazek <blazek at itc.it>
|
||||
Tom Elwertowski <telwertowski at users.sourceforge.net>
|
||||
Godofredo Contreras <frdcn at hotmail.com>
|
||||
Martin Dobias <wonder.sk at gmail.com>
|
||||
Brendan Morley <morb at beagle.com.au>
|
||||
Magnus Homann <magnus at homann.se>
|
||||
Jürgen E. Fischer <jef at norbit.de>
|
||||
Tisham Dhar <tisham at apogee.com.au>
|
||||
Leonardo Lami <lami at faunalia.it>
|
||||
Marco Pasetti <marco.pasetti at alice.it>
|
||||
Mateusz Loskot <mateusz at loskot dot net>
|
||||
Peter Ersts <ersts at amnh.org>
|
||||
Borys Jurgiel <borysiasty at aster.pl>
|
||||
Paolo Cavallini <cavallini at faunalia.it>
|
||||
Carson J. Q. Farmer <carson dot farmer at gmail dot com>
|
||||
Lorenzo Masini <lorenxo86 at gmail.com>
|
||||
Werner Macho <werner.macho at gmail.com>
|
||||
Giuseppe Sucameli <brush.tyler at gmail.com>
|
||||
Alessandro Furieri <a.furieri at lqt.it>
|
||||
@ -57,6 +57,9 @@ ENDIF (WITH_GRASS)
|
||||
# mapserver by us disabled default because it needs FastCGI (which is optional dependency)
|
||||
SET (WITH_MAPSERVER FALSE CACHE BOOL "Determines whether QGIS mapserver should be built")
|
||||
|
||||
# include doxygen documentation
|
||||
SET (WITH_APIDOC FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be built")
|
||||
|
||||
# try to configure and build POSTGRESQL support
|
||||
SET (WITH_POSTGRESQL TRUE CACHE BOOL "Determines whether POSTGRESQL support should be built")
|
||||
IF (WITH_POSTGRESQL)
|
||||
@ -320,13 +323,13 @@ ELSE (WIN32)
|
||||
|
||||
ELSE (APPLE)
|
||||
# UNIX
|
||||
SET (DEFAULT_BIN_SUBDIR bin)
|
||||
SET (DEFAULT_CGIBIN_SUBDIR bin)
|
||||
SET (DEFAULT_LIB_SUBDIR lib${LIB_SUFFIX})
|
||||
SET (DEFAULT_DATA_SUBDIR share/qgis)
|
||||
SET (DEFAULT_LIBEXEC_SUBDIR lib${LIB_SUFFIX}/qgis)
|
||||
SET (DEFAULT_PLUGIN_SUBDIR lib${LIB_SUFFIX}/qgis/plugins)
|
||||
SET (DEFAULT_INCLUDE_SUBDIR include/qgis)
|
||||
SET (DEFAULT_BIN_SUBDIR bin)
|
||||
SET (DEFAULT_CGIBIN_SUBDIR bin)
|
||||
SET (DEFAULT_LIB_SUBDIR lib${LIB_SUFFIX})
|
||||
SET (DEFAULT_DATA_SUBDIR share/qgis)
|
||||
SET (DEFAULT_LIBEXEC_SUBDIR lib${LIB_SUFFIX}/qgis)
|
||||
SET (DEFAULT_PLUGIN_SUBDIR lib${LIB_SUFFIX}/qgis/plugins)
|
||||
SET (DEFAULT_INCLUDE_SUBDIR include/qgis)
|
||||
ENDIF (APPLE)
|
||||
|
||||
ENDIF (WIN32)
|
||||
@ -508,17 +511,13 @@ IF (APPLE)
|
||||
SUBDIRS (mac)
|
||||
ENDIF (APPLE)
|
||||
|
||||
#############################################################
|
||||
# install stuff
|
||||
|
||||
INSTALL (FILES AUTHORS CONTRIBUTORS SPONSORS DONORS TRANSLATORS INSTALL CODING
|
||||
DESTINATION ${QGIS_DATA_DIR}/doc)
|
||||
|
||||
# manual page - makes sense only on unix systems
|
||||
IF (UNIX AND NOT APPLE)
|
||||
INSTALL (FILES qgis.1 DESTINATION ${QGIS_MANUAL_DIR}/man1)
|
||||
ENDIF (UNIX AND NOT APPLE)
|
||||
|
||||
INSTALL(FILES cmake/FindQGIS.cmake DESTINATION ${QGIS_DATA_DIR})
|
||||
|
||||
#############################################################
|
||||
# Uninstall stuff see: http://www.vtk.org/Wiki/CMake_FAQ
|
||||
CONFIGURE_FILE(
|
||||
|
||||
53
CONTRIBUTORS
53
CONTRIBUTORS
@ -1,53 +0,0 @@
|
||||
# This file will be used to populate the contributors tab in the about dialog
|
||||
# Lines prefixed with # will be ignored
|
||||
# The following people have submitted code, patches, graphics, comments,
|
||||
# feedback, reviews and/or many other things that have aided the development of
|
||||
# QGIS:
|
||||
#
|
||||
Alexander Bruy
|
||||
Andres Manz
|
||||
Anita Graser
|
||||
Arthur Nanni
|
||||
Baba Yoshihiko
|
||||
Brent Wood
|
||||
Brook Milligan
|
||||
Carl Anderson
|
||||
Carlos Dávila
|
||||
Cédric Möri
|
||||
Christian Ferreira
|
||||
Diego Moreira
|
||||
Duarte Carreira
|
||||
Faunalia (http://www.faunalia.it)
|
||||
Fernando Pacheco
|
||||
Florian El Ahdab
|
||||
Florian Hof
|
||||
Frank Warmerdam
|
||||
Germán Carrillo
|
||||
Giuseppe Sucameli
|
||||
Horst Duester
|
||||
Hyao (IRC nickname)
|
||||
Ivan Lucena
|
||||
Jean-Denis Giguere
|
||||
Jeremy Palmer
|
||||
Jerrit Collord
|
||||
Luiz Motta
|
||||
Magnus Homann
|
||||
Marco Pasetti
|
||||
Mark Baas
|
||||
Markus Neteler
|
||||
Mathias Walker
|
||||
Matt Amos
|
||||
Maurizio Napolitano
|
||||
Milena Nowotarska
|
||||
Nathan Woodrow
|
||||
Nikos Alexandris
|
||||
Paul Ramsey
|
||||
Richard Duivenvoorde
|
||||
Richard Kostecky
|
||||
Robert Szczepanek
|
||||
Stefanie Tellex
|
||||
Tom Russo
|
||||
Tyler Mitchell
|
||||
Vita Cizek
|
||||
Yann Chemin
|
||||
Includes Map icons CC-0 from SJJB Management
|
||||
14
DONORS
14
DONORS
@ -1,14 +0,0 @@
|
||||
# The following have sponsored QGIS by contributing
|
||||
# money to fund development and other project
|
||||
# costs.
|
||||
# --------------------------------------------------------
|
||||
# Please note that this file is parsed by the about box
|
||||
# for the sponsors list, so names should be strictly
|
||||
# in the format:
|
||||
# name|<website>
|
||||
# This list should be sorted by first name. The
|
||||
# website entry is optional.
|
||||
# -------------------------------------------------------
|
||||
#
|
||||
# ALWAYS USE UTF-8 WHEN WRITING THIS FILE!
|
||||
See:|http://qgis.org/en/sponsorship/donors.html
|
||||
20
SPONSORS
20
SPONSORS
@ -1,20 +0,0 @@
|
||||
# The following have sponsored QGIS by contributing
|
||||
# money to fund development and other project
|
||||
# costs.
|
||||
# --------------------------------------------------------
|
||||
# Please note that this file is parsed by the about box
|
||||
# for the sponsors list, so names should be strictly
|
||||
# in the format:
|
||||
# name|<website>
|
||||
# This list should be sorted by first name. The
|
||||
# website entry is optional.
|
||||
# -------------------------------------------------------
|
||||
#
|
||||
# ALWAYS USE UTF-8 WHEN WRITING THIS FILE!
|
||||
#
|
||||
Please consider sponsoring the development of QuantumGIS.
|
||||
See: http://qgis.org/en/sponsorship.html
|
||||
|
||||
BRONZE
|
||||
Studio Associato Gfosservices|http://www.gfosservices.com
|
||||
NEXTGIS|http://nextgis.org
|
||||
46
TRANSLATORS
46
TRANSLATORS
@ -1,46 +0,0 @@
|
||||
# The following are people who have contributed to QGIS
|
||||
# by doing translation work.
|
||||
# --------------------------------------------------------
|
||||
# Please note that this file is parsed by the about box
|
||||
# for the sponsors list, so names should be strictly
|
||||
# in the format:
|
||||
# language|name
|
||||
# This list should be sorted by first language.
|
||||
# -------------------------------------------------------
|
||||
#
|
||||
# ALWAYS USE UTF-8 WHEN WRITING THIS FILE!
|
||||
#
|
||||
Arabic|Assem Kamal, Latif Jalil
|
||||
Bulgarian|Захари Савов
|
||||
Chinese Simplified|Zhang Jun
|
||||
Chinese Traditional|Nungyao Lin
|
||||
Croatian|Zoran Jankovic
|
||||
Czech|Martin Landa, Peter Antolik, Martin Dzurov, Jan Helebrant
|
||||
Danish|Henriette Roued
|
||||
Dutch|Richard Duivenvoorde, Raymond Nijssen
|
||||
French|Eve Rousseau, Marc Monnerat, Lionel Roubeyrie, Jean Roc Morreale, Benjamin Bohard, Jeremy Garniaux, Yves Jacolin, Benjamin Lerre, Stéphane Morel, Marie Silvestre, Tahir Tamba, Xavier M
|
||||
Georgian|Shota Murtskhvaladze, George Machitidze
|
||||
German|Jürgen E. Fischer, Stephan Holl, Otto Dassau, Werner Macho
|
||||
Greek|Evripidis Argyropoulos, Mike Pegnigiannis, Nikos Ves
|
||||
Hungarian|Siki Zoltan
|
||||
Icelandic|Thordur Ivarsson
|
||||
Indonesian|Januar V. Simarmata
|
||||
Italian|Paolo Cavallini, Flavio Rigolon, Maurizio Napolitano
|
||||
Japanese|BABA Yoshihiko, Yoichi Kayama
|
||||
Lao|Anousak Souphavanh
|
||||
Latvian|Maris Nartiss, Pēteris Brūns
|
||||
Lithuanian|Kestas M
|
||||
Persian|Mola Pahnadayan
|
||||
Polish|Robert Szczepanek, Milena Nowotarska, Borys Jurgiel, Mateusz Loskot, Tomasz Paul
|
||||
Portuguese (Brazil)|Arthur Nanni, Christian Ferreira, Leandro Kaut
|
||||
Portuguese (Portugal)|Giovanni Manghi, Alexandre Neto, Pedro Pereira
|
||||
Romanian|Lonut Losifescu-Enescu
|
||||
Russian|Artem Popov
|
||||
Slovak|Lubos Balazovic
|
||||
Slovenian|Jože Detečnik, Dejan Gregor
|
||||
Spanish|Carlos Dávila, Javier César Aldariz, Gabriela Awad, Edwin Amado
|
||||
Swedish|Lars Luthman, Magnus Homann
|
||||
Thai|Man Chao
|
||||
Turkish|Osman Yilmaz
|
||||
Ukrainian|Сергей Якунин
|
||||
Vietnamese|Bùi Hữu Mạnh
|
||||
53
cmake/Txt2Tags.cmake
Normal file
53
cmake/Txt2Tags.cmake
Normal file
@ -0,0 +1,53 @@
|
||||
# Macros for txt2tags
|
||||
# ~~~~~~~~~~~~~~~~~~~
|
||||
# Copyright (c) 2011, Juergen E. Fischer <jef at norbit dot de>
|
||||
# Redistribution and use is allowed according to the terms of the BSD license.
|
||||
# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
|
||||
|
||||
# use txt2tags for .t2t files
|
||||
|
||||
# search for bison
|
||||
MACRO(FIND_TXT2TAGS)
|
||||
IF(NOT TXT2TAGS_EXECUTABLE)
|
||||
IF (MSVC)
|
||||
FIND_PROGRAM(TXT2TAGS_EXECUTABLE PATHS
|
||||
NAMES txt2tags.exe
|
||||
PATHS $ENV{LIB_DIR}/bin $ENV{PROGRAMFILES}/GnuWin32/bin
|
||||
)
|
||||
ELSE (MSVC)
|
||||
FIND_PROGRAM(TXT2TAGS_EXECUTABLE txt2tags)
|
||||
ENDIF (MSVC)
|
||||
IF (NOT TXT2TAGS_EXECUTABLE)
|
||||
MESSAGE(STATUS "txt2tags not found - disabled")
|
||||
ENDIF (NOT TXT2TAGS_EXECUTABLE)
|
||||
ENDIF(NOT TXT2TAGS_EXECUTABLE)
|
||||
ENDMACRO(FIND_TXT2TAGS)
|
||||
|
||||
MACRO(ADD_TXT2TAGS_FILES _sources)
|
||||
FIND_TXT2TAGS()
|
||||
|
||||
FOREACH (_current_FILE ${ARGN})
|
||||
GET_FILENAME_COMPONENT(_in ${_current_FILE} ABSOLUTE)
|
||||
GET_FILENAME_COMPONENT(_basename ${_current_FILE} NAME_WE)
|
||||
|
||||
SET(_out ${CMAKE_CURRENT_BINARY_DIR}/${_basename})
|
||||
|
||||
ADD_CUSTOM_COMMAND(
|
||||
OUTPUT ${_out}
|
||||
COMMAND ${TXT2TAGS_EXECUTABLE}
|
||||
ARGS -o${_out} -t txt ${_in}
|
||||
DEPENDS ${_in}
|
||||
COMMENT "Building ${_out} from ${_in}"
|
||||
)
|
||||
|
||||
ADD_CUSTOM_COMMAND(
|
||||
OUTPUT ${_out}.html
|
||||
COMMAND ${TXT2TAGS_EXECUTABLE}
|
||||
ARGS -o${_out}.html -t html ${_in}
|
||||
DEPENDS ${_in}
|
||||
COMMENT "Building ${_out}.html from ${_in}"
|
||||
)
|
||||
|
||||
SET(${_sources} ${${_sources}} ${_out} ${_out}.html)
|
||||
ENDFOREACH (_current_FILE)
|
||||
ENDMACRO(ADD_TXT2TAGS_FILES)
|
||||
1658
cmake_templates/Doxyfile.in
Normal file
1658
cmake_templates/Doxyfile.in
Normal file
File diff suppressed because it is too large
Load Diff
@ -32,5 +32,7 @@
|
||||
|
||||
#cmakedefine HAVE_PYTHON
|
||||
|
||||
#cmakedefine WITH_APIDOC
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
@ -1,14 +1,25 @@
|
||||
INCLUDE(Txt2Tags)
|
||||
ADD_TXT2TAGS_FILES(QGIS_DOC_FILES INSTALL.t2t CODING.t2t AUTHORS.t2t CONTRIBUTORS.t2t SPONSORS.t2t DONORS.t2t TRANSLATORS.t2t)
|
||||
SET(QGIS_DOC_FILES ${QGIS_DOC_FILES} index.html favicon.ico qgisdoc.css)
|
||||
|
||||
SET (DOC_FILES
|
||||
favicon.ico
|
||||
index.html
|
||||
qgisdoc.css
|
||||
)
|
||||
ADD_CUSTOM_TARGET (t2tdoc ALL DEPENDS ${QGIS_DOC_FILES})
|
||||
|
||||
INSTALL(FILES ${QGIS_DOC_FILES} DESTINATION ${QGIS_DATA_DIR}/doc)
|
||||
INSTALL(FILES images/qgis_new_80pct.png DESTINATION ${QGIS_DATA_DIR}/doc/images)
|
||||
|
||||
IF(WITH_APIDOC)
|
||||
FIND_PACKAGE(Doxygen)
|
||||
IF(DOXYGEN_FOUND)
|
||||
CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/cmake_templates/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
||||
ADD_CUSTOM_TARGET(apidoc ALL
|
||||
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
||||
DEPENDS qgis_core qgis_gui qgis_analysis
|
||||
COMMENT "Generating API documentation" VERBATIM)
|
||||
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${QGIS_DATA_DIR}/doc/api)
|
||||
ELSE(DOXYGEN_FOUND)
|
||||
MESSAGE(STATUS "QGIS api documentation not built - Doxygen not found")
|
||||
ENDIF(DOXYGEN_FOUND)
|
||||
ENDIF(WITH_APIDOC)
|
||||
|
||||
#SUBDIRS (images plugins install_guide)
|
||||
|
||||
INSTALL(FILES ${DOC_FILES}
|
||||
DESTINATION ${QGIS_DATA_DIR}/doc)
|
||||
|
||||
INSTALL(FILES images/qgis_new_80pct.png
|
||||
DESTINATION ${QGIS_DATA_DIR}/doc/images)
|
||||
|
||||
@ -86,4 +86,4 @@ source directory.
|
||||
|
||||
%!include: osx.t2t
|
||||
|
||||
%!include: authors.t2t
|
||||
%!include: iauthors.t2t
|
||||
|
||||
@ -1,28 +0,0 @@
|
||||
|
||||
= Authors and Acknowledgments =
|
||||
|
||||
The following people have contributed to this document:
|
||||
|
||||
- Windows MINGW Section
|
||||
- Tim Sutton, Godofredo Contreras 2006
|
||||
- CMake additions Magnus Homann 2007
|
||||
- Python additions Martin Dobias 2007
|
||||
- With thanks to Tisham Dhar for preparing the initial msys environment
|
||||
|
||||
- Windows MSVC Section (Detailed install)
|
||||
- David Willis 2007
|
||||
- MSVC install additions Tim Sutton 2007
|
||||
- PostgreSQL, Qt compile, SIP, Python, AutoExp additions Juergen Fischer 2007
|
||||
|
||||
- Windows MSVC Section (Simplified install)
|
||||
- Tim Sutton 2007
|
||||
- Juergen Fischer 2007
|
||||
- Florian Hillen 2010
|
||||
|
||||
- OSX Section
|
||||
- Tim Sutton 2007
|
||||
- With special thanks to Tom Elwertowski and William Kyngesburye
|
||||
|
||||
- GNU/Linux Section
|
||||
- Tim Sutton 2006
|
||||
- Debian package section: Juergen Fischer 2008
|
||||
Loading…
x
Reference in New Issue
Block a user