Skip to content

Commit

Permalink
Solving untranslatable string problem
Browse files Browse the repository at this point in the history
  • Loading branch information
woodbri committed Sep 24, 2013
1 parent b19690f commit ca4fc5c
Show file tree
Hide file tree
Showing 12 changed files with 311 additions and 51 deletions.
104 changes: 82 additions & 22 deletions .tx/config
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/index.po
source_file = doc/i18n/pot/doc/index.pot
source_lang = en

[pgrouting.src--index]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/index.po
source_file = doc/i18n/pot/src/index.pot
source_lang = en

[pgrouting.doc--index_man]
file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/index_man.po
source_file = doc/i18n/pot/doc/index_man.pot
Expand All @@ -17,6 +22,12 @@ file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/tutorial/index.po
source_file = doc/i18n/pot/doc/src/tutorial/index.pot
source_lang = en

[pgrouting.doc--src--tutorial--tutorial]
file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/tutorial/tutorial.po
source_file = doc/i18n/pot/doc/src/tutorial/tutorial.pot
source_lang = en


[pgrouting.doc--src--tutorial--custom_wrapper]
file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/tutorial/custom_wrapper.po
source_file = doc/i18n/pot/doc/src/tutorial/custom_wrapper.pot
Expand Down Expand Up @@ -67,11 +78,21 @@ file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/introduction/index.po
source_file = doc/i18n/pot/doc/src/introduction/index.pot
source_lang = en

[pgrouting.doc--src--introduction--introduction]
file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/introduction/introduction.po
source_file = doc/i18n/pot/doc/src/introduction/introduction.pot
source_lang = en

[pgrouting.doc--src--introduction--support]
file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/introduction/support.po
source_file = doc/i18n/pot/doc/src/introduction/support.pot
source_lang = en

[pgrouting.doc--src--changelog--index]
file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/changelog/index.po
source_file = doc/i18n/pot/doc/src/changelog/index.pot
source_lang = en

[pgrouting.doc--src--changelog--1_x]
file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/changelog/1_x.po
source_file = doc/i18n/pot/doc/src/changelog/1_x.pot
Expand All @@ -92,9 +113,9 @@ file_filter = doc/i18n/<lang>/LC_MESSAGES/doc/src/installation/build.po
source_file = doc/i18n/pot/doc/src/installation/build.pot
source_lang = en

[pgrouting.src--common--doc--types]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/types.po
source_file = doc/i18n/pot/src/common/doc/types.pot
[pgrouting.src--common--doc--types--index]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/types/index.po
source_file = doc/i18n/pot/src/common/doc/types/index.pot
source_lang = en

[pgrouting.src--common--doc--index]
Expand All @@ -117,56 +138,96 @@ file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/types/cost_result.po
source_file = doc/i18n/pot/src/common/doc/types/cost_result.pot
source_lang = en

[pgrouting.src--common--doc--functions--versionless]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/versionless.po
source_file = doc/i18n/pot/src/common/doc/functions/versionless.pot
[pgrouting.src--common--doc--utilities--index]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/index.po
source_file = doc/i18n/pot/src/common/doc/utilities/index.pot
source_lang = en

[pgrouting.src--common--doc--functions--index]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/index.po
source_file = doc/i18n/pot/src/common/doc/functions/index.pot
source_lang = en

[pgrouting.src--common--doc--utilities--versionless]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/versionless.po
source_file = doc/i18n/pot/src/common/doc/utilities/versionless.pot
source_lang = en

[pgrouting.src--common--doc--functions--analyze_graph]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/analyze_graph.po
source_file = doc/i18n/pot/src/common/doc/functions/analyze_graph.pot
source_lang = en

[pgrouting.src--common--doc--functions--create_vert_table]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/create_vert_table.po
source_file = doc/i18n/pot/src/common/doc/functions/create_vert_table.pot
source_lang = en

[pgrouting.src--common--doc--functions--create_topology]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/create_topology.po
source_file = doc/i18n/pot/src/common/doc/functions/create_topology.pot
source_lang = en

[pgrouting.src--common--doc--functions--is_column_in_table]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/is_column_in_table.po
source_file = doc/i18n/pot/src/common/doc/functions/is_column_in_table.pot
[pgrouting.src--common--doc--utilities--is_column_in_table]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/is_column_in_table.po
source_file = doc/i18n/pot/src/common/doc/utilities/is_column_in_table.pot
source_lang = en

[pgrouting.src--common--doc--utilities--version]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/version.po
source_file = doc/i18n/pot/src/common/doc/utilities/version.pot
source_lang = en

[pgrouting.src--common--doc--functions--version]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/version.po
source_file = doc/i18n/pot/src/common/doc/functions/version.pot
[pgrouting.src--common--doc--utilities--get_table_name]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/get_table_name.po
source_file = doc/i18n/pot/src/common/doc/utilities/get_table_name.pot
source_lang = en

[pgrouting.src--common--doc--functions--quote_ident]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/quote_ident.po
source_file = doc/i18n/pot/src/common/doc/functions/quote_ident.pot
[pgrouting.src--common--doc--utilities--start_point]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/start_point.po
source_file = doc/i18n/pot/src/common/doc/utilities/start_point.pot
source_lang = en

[pgrouting.src--common--doc--utilities--end_point]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/end_point.po
source_file = doc/i18n/pot/src/common/doc/utilities/end_point.pot
source_lang = en

[pgrouting.src--common--doc--utilities--get_column_name]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/get_column_name.po
source_file = doc/i18n/pot/src/common/doc/utilities/get_column_name.pot
source_lang = en

[pgrouting.src--common--doc--utilities--quote_ident]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/quote_ident.po
source_file = doc/i18n/pot/src/common/doc/utilities/quote_ident.pot
source_lang = en

[pgrouting.src--common--doc--functions--node_network]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/node_network.po
source_file = doc/i18n/pot/src/common/doc/functions/node_network.pot
source_lang = en

[pgrouting.src--common--doc--functions--point_to_id]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/point_to_id.po
source_file = doc/i18n/pot/src/common/doc/functions/point_to_id.pot
[pgrouting.src--common--doc--utilities--point_to_id]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/point_to_id.po
source_file = doc/i18n/pot/src/common/doc/utilities/point_to_id.pot
source_lang = en

[pgrouting.src--common--doc--functions--is_column_indexed]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/is_column_indexed.po
source_file = doc/i18n/pot/src/common/doc/functions/is_column_indexed.pot
[pgrouting.src--common--doc--utilities--is_column_indexed]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/utilities/is_column_indexed.po
source_file = doc/i18n/pot/src/common/doc/utilities/is_column_indexed.pot
source_lang = en

[pgrouting.src--common--doc--functions--analyze_oneway]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/common/doc/functions/analyze_oneway.po
source_file = doc/i18n/pot/src/common/doc/functions/analyze_oneway.pot
source_lang = en

[pgrouting.src--driving_distance--doc--dd_driving_distance]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/driving_distance/doc/dd_driving_distance.po
source_file = doc/i18n/pot/src/driving_distance/doc/dd_driving_distance.pot
source_lang = en

[pgrouting.src--driving_distance--doc--dd_points_as_polygon]
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/driving_distance/doc/dd_points_as_polygon.po
source_file = doc/i18n/pot/src/driving_distance/doc/dd_points_as_polygon.pot
Expand Down Expand Up @@ -231,4 +292,3 @@ source_lang = en
file_filter = doc/i18n/<lang>/LC_MESSAGES/src/ksp/doc/index.po
source_file = doc/i18n/pot/src/ksp/doc/index.pot
source_lang = en

77 changes: 72 additions & 5 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,29 +39,87 @@ General
Tutorial
*******************************************************************************

:ref:`Tutorial <tutorial1>`

- :ref:`Getting started <tutorial>`
- :ref:`topology` for an overview of a topology for routing algorithms.
- :ref:`analytics` for an overview of the analysis of a graph.
- :ref:`custom_query` that is used in the routing algorithms.
- :ref:`performance` to improve your performance.
- :ref:`custom_wrapper` to colaborate with a wrapper.
- :ref:`recipes` to colaborate with a recipe.
- :ref:`sampledata` that is used in the examples of this manual.



.. toctree::
:maxdepth: 2
:hidden:

src/tutorial/index
src/developer/sampledata
src/tutorial/index
src/developer/sampledata

For a more complete introduction how to build a routing application read the `pgRouting Workshop <http://workshop.pgrouting.org>`_.

*******************************************************************************
Data Types
*******************************************************************************

:ref:`data_types`

- :ref:`type_cost_result` - A set of records to describe a path result with cost attribute.
- :ref:`pgr_costResult3[]<type_cost_result3>` - A set of records to describe a path result with cost attribute.
- :ref:`pgr_geomResult<type_geom_result>` - A set of records to describe a path result with geometry attribute.

.. toctree::
:maxdepth: 2
:hidden:

../src/common/doc/types/index

*******************************************************************************
Functions reference
*******************************************************************************

:ref:`topology_functions`

- :ref:`pgr_create_topology` - to create a topology based on the geometry.
- :ref:`pgr_create_vert_table` - to reconstruct the vertices table based on the source and target information.
- :ref:`pgr_analyze_graph` - to analyze the edges and vertices of the edge table.
- :ref:`pgr_analyze_oneway` - to analyze directionality of the edges.
- :ref:`pgr_node_network` -to create nodes to a not noded edge table.

:ref:`routing_functions`

- :ref:`pgr_apspJohnson <pgr_apsp_johnson>`- All Pairs Shortest Path, Johnson’s Algorithm
- :ref:`pgr_apspWarshall<pgr_apsp_warshall>` - All Pairs Shortest Path, Floyd-Warshall Algorithm
- :ref:`pgr_astar<pgr_astar>` - Shortest Path A*
- :ref:`pgr_bdAstar<bd_astar>` - Bi-directional A* Shortest Path
- :ref:`pgr_bdDijkstra<bd_dijkstra>` - Bi-directional Dijkstra Shortest Path
- :ref:`pgr_dijkstra<pgr_dijkstra>` - Shortest Path Dijkstra
- :ref:`pgr_kDijkstra<pgr_kdijkstra>` - Mutliple destination Shortest Path Dijkstra
- :ref:`pgr_ksp<ksp>` - K-Shortest Path
- :ref:`pgr_tsp<pgr_tsp>` - Traveling Sales Person
- :ref:`pgr_trsp<trsp>` - Turn Restriction Shortest Path (TRSP)

:ref:`dd_index`

- :ref:`pgr_driving_distance` - Driving Distance
- :ref:`pgr_alphaShape` - Alpha shape computation
- :ref:`pgr_points_as_polygon` - Polygon around set of points

:ref:`developer_functions`
- :ref:`pgr_get_column_name` - to get the name of the column as is stored in the postgres administration tables.
- :ref:`pgr_get_table_name` - to retrieve the name of the table as is stored in the postgres administration tables.
- :ref:`pgr_is_column_indexed` - to check if the column is indexed.
- :ref:`pgr_is_column_in_table` - to check only for the existance of the column.
- :ref:`pgr_point_to_id` -to insert/get the id of the inserted point in a vertices table.
- :ref:`pgr_quote_ident` - to quotes the input text to be used as an identifier in an SQL statement string.
- :ref:`pgr_version` - to get pgRouting's version information.
- :ref:`pgr_versionless` - to compare two version numbers.
- :ref:`pgr_start_point` - to get the start point of a (multi)linestring.
- :ref:`pgr_end_point` - to get the end point of a (multi)linestring.

.. toctree::
:maxdepth: 2
:hidden:

../src/common/doc/functions/index
../src/index
Expand All @@ -83,6 +141,15 @@ Developer
:maxdepth: 2

src/developer/index

:ref:`change_log`

- :ref:`changelog_2_0`
- :ref:`changelog_1_x`

.. toctree::
:hidden:

src/changelog/index


Expand Down
5 changes: 4 additions & 1 deletion doc/src/changelog/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@
Release Notes
===============================================================================

- :ref:`changelog_2_0`
- :ref:`changelog_1_x`

.. toctree::
:maxdepth: 1
:hidden:

pgRouting 2.0 Release Notes <2_0>
pgRouting 1.x Release Notes <1_x>
Expand Down
16 changes: 8 additions & 8 deletions doc/src/developer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,46 +22,46 @@ Source Tree Layout
cmake/
cmake scripts used as part of our build system.

core/
src/
This is the algorithm source tree. Each algorithm should be contained
in its on sub-tree with doc, sql, src, and test sub-directories.
This might get renamed to "algorithms" at some point.

core/astar/
src/astar/
This is an implementation of A* Search based on using Boost Graph
libraries for its implementation. This is a Dijkstra shortest path
implementation with a Euclidean Heuristic.

core/common/
src/common/
At the moment this does not have an core in "src", but does have a lot
of SQL wrapper code and topology code in the "sql" directory. *Algorithm
specific wrappers should get move to the algorithm tree and appropriate
tests should get added to validate the wrappers.*

core/dijkstra/
src/dijkstra/
This is an implementation of Dikjstra's shortest path solution using
Boost Graph libraries for the implementation.

core/driving_distance/
src/driving_distance/
This optional package creates driving distance polygons based on
solving a Dijkstra shortest path solution, then creating polygons
based on equal cost distances from the start point.
This optional package requires CGAL libraries to be installed.

core/shooting_star/
src/shooting_star/
*DEPRECATED and DOES NOT WORK and IS BEING REMOVED*
This is an edge based shortest path algorithm that supports turn
restrictions. It is based on Boost Graph.
Do *NOT* use this algorithm as it is broken, instead use *trsp*
which has the same functionality and is faster and give correct results.

core/trsp/
src/trsp/
This is a turn restricted shortest path algorithm. It has some nice
features like you can specify the start and end points as a percentage
along an edge. Restrictions are stored in a separate table from the
graph edges and this make it easier to manage the data.

core/tsp/
src/tsp/
This optional package provides the ability to compute traveling
salesman problem solutions and compute the resulting route.
This optional package requires GAUL libaries to be installed.
Expand Down
24 changes: 22 additions & 2 deletions doc/src/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,33 @@
Tutorial
===============================================================================


:ref:`Getting started <tutorial>`

- How to create a database to use for our project
- How to load some data
- How to build a topology
- How to check your graph for errors
- How to compute a route
- How to use other tools to view your graph and route
- How to create a web app

Advanced Topics

- :ref:`topology` for an overview of a topology for routing algorithms.
- :ref:`analytics` for an overview of the analysis of a graph.
- :ref:`custom_query` that is used in the routing algorithms.
- :ref:`performance` to improve your performance.
- :ref:`custom_wrapper` to colaborate with a wrapper.
- :ref:`recipes` to colaborate with a recipe.

.. toctree::
:maxdepth: 2
:hidden:

Getting started <tutorial>

.. toctree::
:maxdepth: 1
:hidden:

An overview of a topology for routing algorithms. <topology>
An overview of the analysis of a graph. <analytics>
Expand Down
Loading

0 comments on commit ca4fc5c

Please sign in to comment.