Permalink
Browse files

doc: cleanup

  • Loading branch information...
1 parent b9bf5b1 commit f1733e2d40516558d2b6775e618ecc353ab5ffd7 @kaos kaos committed Nov 9, 2012
View
@@ -5,6 +5,7 @@ For developers
Topics:
.. toctree::
+ :maxdepth: 2
codestyle
filing_issues
View
@@ -2,6 +2,7 @@ In-depth manuals
================
.. toctree::
+ :maxdepth: 2
site-anatomy
modules/index
@@ -2,6 +2,7 @@ Maintenance
===========
.. toctree::
+ :maxdepth: 2
deployment/index
cli
@@ -3,9 +3,10 @@
Actions
=======
-.. seealso:: :ref:`manual-actions` in the :ref:`manual-templates` manual.
+.. seealso:: :ref:`manual-template-actions` in the :ref:`manual-templates` manual.
.. toctree::
+ :maxdepth: 1
:glob:
action_*
View
@@ -1,10 +0,0 @@
-
-All dispatch rules
-==================
-
-This table lists all the dispatch rules in one big table.
-
-.. csv-table:: The Big List of Dispatch rules
- :delim: tab
- :header: Name, Path, Resource, Args
- :file: meta-all-dispatch.csv
View
@@ -1,11 +1,10 @@
-.. _dispatch:
-Dispatch rules
-==============
+All dispatch rules
+==================
-.. toctree::
- :glob:
-
- all
- dispatch_*
+This table lists all the dispatch rules in one big table.
+.. csv-table:: The Big List of Dispatch rules
+ :delim: tab
+ :header: Name, Path, Resource, Args
+ :file: meta-all-dispatch.csv
@@ -4,6 +4,7 @@ Filters
=======
.. toctree::
+ :maxdepth: 1
:glob:
filter_*
View
@@ -10,7 +10,7 @@ All the nitty gritty details when the big picture has settled.
modules/index
actions/index
controllers/index
- dispatch/all
+ dispatch/index
filters/index
models/index
services/index
View
@@ -4,6 +4,7 @@ Models
======
.. toctree::
+ :maxdepth: 1
:glob:
model_*
View
@@ -6,6 +6,7 @@ Custom Tags
Custom tags are internally called `scomp`, from `Screen COMPonents`.
.. toctree::
+ :maxdepth: 1
:glob:
scomp_*
@@ -8,6 +8,7 @@ access, OAuth or session-cookies are used as authentication
mechanism. JSON is used as output mechanism.
.. toctree::
+ :maxdepth: 1
:glob:
service_*
@@ -4,6 +4,7 @@ Templates
=========
.. toctree::
+ :maxdepth: 1
:glob:
template_*
@@ -32,29 +32,35 @@ To provide by-language differentiation several variables are used in i18n-blocks
+============================+======================================================+===================+
|is_i18n | Shows whether mod_translation enabled or not. | true |
| | Used to implement basic logic for displaing current | |
-| | rsc values: | |
-| | {{ if:is_i18n|if : r.translation[lang_code].summary | |
-| | : r.title }} | |
+| | rsc values:: | |
+| | | |
+| | {{ if:is_i18n|if : r.translation[lang_code].summary| |
+| | : r.title }} | |
+| | | |
| | You should read it this way: "if mod_translation | |
| | enabled, then display localized title, else display | |
| | non-localized title. | |
+----------------------------+------------------------------------------------------+-------------------+
|lang_code | ISO-2 language code. This code is defined in | "en" |
| | "traslation" tab for each language. | |
| | This variable is used to read current value into | |
-| | field: | |
-| | m.rsc[id].r.translation[lang_code].title | |
+| | field:: | |
+| | | |
+| | m.rsc[id].r.translation[lang_code].title | |
+----------------------------+------------------------------------------------------+-------------------+
|lang_code_with_dollar | Same as lang_code, but contains dollar sign at | "$en" |
| | beginning. It is used for ids and names of localized | |
| | form elements. On submit, resource_admin_edit will | |
-| | process following localized $-names: | |
-| | <input name="myparam{{ lang_code_with_dollar }}" ... | |
+| | process following localized $-names:: | |
+| | | |
+| | <input name="myparam{{ lang_code_with_dollar }}" | |
+| | ... | |
+----------------------------+------------------------------------------------------+-------------------+
|lang_code_with_brackets | Same as lang_code, but usually used for displayed | "(en)" |
| | comments, titles, lables, etc. This variable may be | |
-| | safety replaced by code: | |
-| | ({{ lang_code }}) | |
+| | safety replaced by code:: | |
+| | | |
+| | ({{ lang_code }}) | |
+----------------------------+------------------------------------------------------+-------------------+
| is_editable | Whether or not current rsc is editable for user. | true |
+----------------------------+------------------------------------------------------+-------------------+
@@ -4,6 +4,7 @@ Validators
==========
.. toctree::
+ :maxdepth: 1
:glob:
validator_*
View
@@ -5,6 +5,7 @@ Tutorials
Topics:
.. toctree::
+ :maxdepth: 2
preinstall
install

0 comments on commit f1733e2

Please sign in to comment.