summaryrefslogtreecommitdiffstats
path: root/tcllib/modules/doctools2idx/include/dependencies.inc
diff options
context:
space:
mode:
Diffstat (limited to 'tcllib/modules/doctools2idx/include/dependencies.inc')
-rw-r--r--tcllib/modules/doctools2idx/include/dependencies.inc44
1 files changed, 44 insertions, 0 deletions
diff --git a/tcllib/modules/doctools2idx/include/dependencies.inc b/tcllib/modules/doctools2idx/include/dependencies.inc
new file mode 100644
index 0000000..92c683d
--- /dev/null
+++ b/tcllib/modules/doctools2idx/include/dependencies.inc
@@ -0,0 +1,44 @@
+[comment {
+ ASCII diagram of the dependencies between the doctools v2 idx packages
+ ======================================================================
+}][example {
+ ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~
+ ~~ | ~~
+ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import
+ | | |
+ +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+
+ | | | | | | | | |
+doctools::config = | | | = doctools::include doctools::config doctools::paths
+ | | | | |
+ doctools::idx::export::<*> | | | doctools::idx::import::<*>
+ docidx | | | docidx, json
+ json | | | | \\
+ html | | | doctools::idx::parse \\
+ nroff | | | | \\
+ wiki | | | +---------------+ json
+ text | | | | |
+ doctools::idx::structure |
+ |
+ +-------+---------------+
+ | |
+ doctools::html doctools::html::cssdefaults doctools::tcl::parse doctools::msgcat
+ | |
+ doctools::text doctools::nroff::man_macros =
+ |
+ doctools::msgcat::idx::<*>
+ c, en, de, fr
+ (fr == en for now)
+ ~~ Interoperable objects, without actual package dependencies
+ -- Package dependency, higher requires lower package
+ = Dynamic dependency through plugin system
+ <*> Multiple packages following the given form of naming.
+
+}][comment {
+ yaml export, import
+ tmml export, import
+ reStructured Text export
+ latex export
+
+ list, desc - old, not needed under new system, replaced by the nested-list serialization
+ null - old, not needed, deserialize docidx alone provides validation of input.
+}]