Skip to content

Commit

Permalink
[FEATURE] documentation improvements
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jef committed Mar 6, 2011
1 parent 1054cfa commit 0cd4317
Show file tree
Hide file tree
Showing 12 changed files with 1,747 additions and 228 deletions.
43 changes: 0 additions & 43 deletions AUTHORS

This file was deleted.

25 changes: 12 additions & 13 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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(
Expand Down
53 changes: 0 additions & 53 deletions CONTRIBUTORS

This file was deleted.

14 changes: 0 additions & 14 deletions DONORS

This file was deleted.

20 changes: 0 additions & 20 deletions SPONSORS

This file was deleted.

46 changes: 0 additions & 46 deletions TRANSLATORS

This file was deleted.

53 changes: 53 additions & 0 deletions cmake/Txt2Tags.cmake
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 0cd4317

Please sign in to comment.