Finished indexes topic of the documentation will full ilustrations

This commit is contained in:
Roberto Rosario
2012-02-07 01:46:20 -04:00
parent aa9d878365
commit 17fcf9877c
8 changed files with 1484 additions and 15 deletions

View File

@@ -15,7 +15,10 @@
id="svg4485"
version="1.1"
inkscape:version="0.48.2 r9819"
sodipodi:docname="ACL.svg">
sodipodi:docname="ACL.svg"
inkscape:export-filename="/home/rosarior/development/mayan/mayan/docs/topics/ACL.png"
inkscape:export-xdpi="100"
inkscape:export-ydpi="100">
<defs
id="defs4487">
<marker

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 53 KiB

View File

@@ -0,0 +1,204 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="279.54614"
height="399.96887"
id="svg4808"
version="1.1"
inkscape:version="0.48.2 r9819"
sodipodi:docname="index_template.svg"
inkscape:export-filename="/home/rosarior/development/mayan/mayan/docs/topics/index_template.png"
inkscape:export-xdpi="100"
inkscape:export-ydpi="100">
<defs
id="defs4810" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="0.98994949"
inkscape:cx="-9.6370916"
inkscape:cy="270.24135"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
fit-margin-top="5"
fit-margin-left="5"
fit-margin-right="5"
fit-margin-bottom="5"
inkscape:window-width="1920"
inkscape:window-height="1025"
inkscape:window-x="0"
inkscape:window-y="26"
inkscape:window-maximized="1" />
<metadata
id="metadata4813">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(-211.6555,-315.23489)">
<rect
style="fill:#000000;fill-opacity:0.09787233;fill-rule:nonzero;stroke:none"
id="rect3396"
width="269.54614"
height="368.70569"
x="216.6555"
y="341.49808"
rx="6.2500043"
ry="2.6675141" />
<path
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 279.8408,414.17828 0,19.15838"
id="path3933"
inkscape:connector-curvature="0" />
<image
y="384.87115"
x="263.04108"
id="image3004"
xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABHNCSVQICAgIfAhkiAAAAdpJREFU WIXt179rE2Ecx/H3c/fcXS6Xpg0aWx1a3NxFsDHi0lGjSOMiuHXwH1BwFgdHERycu4RYLIhUx7Yu xcHRTeig9Qe2NL2eprnn6xAb8qOL5EgH7wPHcdwDn9fzPDwHp0SE44x1rO0pIAWkgBQAqL5n68qD 2lW8XN3TtnOmOM6wX0qF4udexE4jOqC5N7/66NYrwBwFsC7fW7zuT5xcunvjEtNTAVu7Q3V3MpWH za2QZy/fEe38uLn2+PbyIUJ3jfPs7ERtoVLic9OnvtZAqcEl+tcIIAKlmYCFayWevlitAXkg6gf4 RtCnJ3O8fd8g79EGDCkQaV8fvoTcOT+Gq7UG/KMAGuD7PgQO2AmUdyNiga+hMFkc7+nV/YONCFmX RJa/AwCMgIhBjOl51wsQwRhDxk3+fBogNkL/meoAZsrVgrZtWmLwneRmfxgBDIY4FqbL84XN9fo3 aPe4cw/f/D5VzFO+cI5sLkP4q5XY/ncAAkFGEzYi1jc+sr27z8r9OU8DgRGhWrlIs9kijg1uzk22 vSv+iTGqlVmWXm8ABBpwbEvx5PkKJhYGdynZKBSWpbBsC8BRQAE4+/c+ymwDnxTgAgHgjBhwAIQj 7hyMSv8LUkAK+O8BfwBPb5uGE8zc7AAAAABJRU5ErkJggg== "
height="32"
width="32" />
<image
y="456.70581"
x="264.49216"
id="image3015"
xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABHNCSVQICAgIfAhkiAAAA8RJREFU WIXtl81rnFUUxn/n3HdmUhOoU7UtpeQLVASh0kTBlRRUlIjUvSiCC6Vx5T/gyk0WIlTalQtFoX5A lXZp46J+YD80atPWGDszTtLGTJLJTJJmZu57r4t3MplJJomRKdn0Wb+c5znPee659xXvPTsJ3VH2 uwIAAYJLx4+cNtgB7xzQLBOCqBISnOkbHH4JsK0SEAC7DHbg0BsfgrXgZQOZhpETr70A7AKKrRTQ 5p0DaylffRePqTLWIyTR9Qq2tMzl958siDQRuQlEDSHB2b7B4aOscS+osTmL1zhIDOoJPOBDXClH 37FP12vbkt1DEGPkxKsDNHEvWCWyoAHIqqaoAIBSyX0L0+eaEGxC7j1CSPyht4nyRdvGAigjoiDa pKqCmJWqDcyisokGHzXmF6p1138a1Iq5CqjZQMB6iEYnY2mmwOaRCDHZK4gI77z8SO+z/fs644Em +gfPfQ/4Ogcsohp1u4UAUUGNkro8xmzmJs2P7kprHuE3xCgvPpH8QaggKBePHznbPzh8tC4DYeQA CiI0NVZAEMQo6UvXoVKif/AjcHZTEY3wEIsxcvL1AWDX6gh8BcQgYhBjIluFdW6ICKmfruFtSOeh bsrXh9h4ga2Fw7R3wZ7nyRfLF4B43QhCVA1qYqQujpK7MYE0Lars6dxH12M9OOdBTTVfWwjwgLdo Ry+58QtcyS5+DYSNGQgM85M57PIij7/5HrhwjQMCKHbyFM5H00X/63XiwIPec5DC36c49sHvnwHL QU27D1ETMDc5TbL7UXxlCTt1moZQroxETDUn24Egif2E5ZDZ7Ng00T4orzqg0SLKZ6Y4cPhpWJ4A jVfP/1qq7a7DKkXbXnLjPzOanvsYKAEuqGoD8dyeXyDRESex+wB24Q/ExGnNjR3lQxMPUMyeZ+iL 8U+AZajfhBqS+ytLsvthEIe4QrSa/2e3jXBILImzFQqTN0qjmeI/RA5UBYiAQPFWjt6n+qE8E21E adV7xaGJJLPpq2SmF88QdR/WBIgIfimPLZVpu38/fmkKaVn3RHViHeQz5/nuWv5Lqt3XBCDCws1J dh/sAu/x3K7a3wp4JGgHF1KcSDH0+diPVOdfEyCqzKTS3NfzILCIBq3sHoi1M5/5k1v50jfAInWP ktoI8qkM3c8NQKkAQXvryAFiHcxn0vyaWviKqPva2hRg7y8nnxlXfIezFhc9HFoKEcGhhb63hg8D WeoyIMC9QA+QpKW+N8ADeSANzAG1LgWIAe1A/A6Rr6BMNP/KHebZHuTuz+lOC/gX/29g6TEI7HMA AAAASUVORK5CYII= "
height="32"
width="32" />
<image
y="530.59052"
x="369.8649"
id="image3048"
xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABHNCSVQICAgIfAhkiAAABLtJREFU WIXFl02MFEUYhp+vqnp2dpEfgSgYwi7qihgTRPQAeJDIAV1CIHDxojESIwEuevPiTRM5GKIGTNSD JiYkYBAhJGpEY/AggmxiZAkSh7/FZQd2dti/memu8lA9vzuzM6yb+CZ96O6q+t7v/b5+q1qcc/yf EMCc+XD9EU3Y46wF6hESRCkizLHVu09uBcKZImCAdk3Ys/L1zyAMwUkDmpre/a9sAtqBOzNJIOms hTAkf/4dHDqOWImIts6XCHMTnN23JitSh+QUEKWJMMdX7z65hRr1TCmaDXEqARJAZQAHuAibS7N6 15eTuTWN7sAE9O5/uYc66plyoBCUASlz8gsAKArpH2Hwh7uM7hAiEt1v4vuLZGMC5BFRIIrJaSoQ XVq0glkTQRwQgs0WR04abkqL2QIo3YDAZIgSRARRU411CBrsWHVZJxMACBGlgOYERAlKK1JnL3L7 8g3ANorvScgplNGc3bd2wJNWpaas6IHIK4ACEaQeCQFBEK24fOYCFHI8tedzsCFMZWhVSzkIAnoP 7OgB2sslcAUQjYhGtPaK1SmbiJD6tQ8XRixd2UX+wl4aG1gtLHpWJ8x/nsyd/GkgUVGCCKU0Sgek fvuT9N/XkbqLKuYvvZ/OJ5ZhrQOlfdvgmnaOsyH6ngcZvHSaP66Ofg1E1T1gNMP9acKJUZ7e+T7Y qEYBARRh/0GsEx9SKQTQyqHENVbCgXMa6VhC9upBPv326jFgwlCc4iKUNgz1D3Jv1+O4whjhwBGq mrJYEtFxnxRd2pIPVdMqqORiTJgnc/3izd//Gk4D+bICKgSlyQ6keeDJDTBxHVQi/v5rxS3fizgI LCu/Wk9fuiNWrYaJCDhYvkj4ac0v9KXSXwDjgDV+OQFxjA+PEgSatrmLCUcuIjoRKzBFVsqBjui7 2YHbu37KsYfPZ9hx6Bzm52tHgAmo9AEVkbk2wLyu5SAOsVlvzU09wYFScebwzYV/SjMssHn5ImTP YW6/t5ltK+bB9lfZPvTwG5ze8iKl9ERAYOhKP/OXdUP+lndEFXgSzS4dlHyg3Wg6gvgysXpGkc2F DIzk2LZiHid2PrN1zltHDwHGl0AEN5YhzBVILlyEGxtAWsjeK+diA/NoCxQqtl1bNCcRxgohYMiM F9jYvQCr9SZKRiTCyI1+5i7pBOdwjMfytwDl4rE+WFIriucFa/2zFx69j8fe/d7XJLK4D7YRv0p6 BZTiVuoyC5Z1A6Mo02L2EO/35a5PGq+GAJH458dfWztpWnwWlVIJMqkrdG3sgVwWzKzWghcJBLl4 Fy0TAK9JX3qkauMWgUcWzCp9qAYgcnJHB8Hs3o8PYG2Dna0BNI45agzMKgASWuEo61flCK5iV3Zl AvlVO797dtfmh9ZN5KO7PqPbyNpbmdEcz6lPAJKBmnpjrKmsAUaB1EdHLw3SzHXqwwFz2OB9oE3r cvfXgaphYIACMAQM/wcCBZEC4BWIbGMCOj5BVfVAfB/F13QQJcRPTWoFuslooHiSm07GddGm7+68 HmgfukW3aQqXzGVOzX37xLpCZJmiAijxwZO5zKls/f+waWE2sBRYSGtJhUAauDJTBAz+rydJaxbq 8Nvx+AzFnz7+BfrWszSatlERAAAAAElFTkSuQmCC "
height="32"
width="32" />
<image
y="598.23926"
x="264.2951"
id="image3015-0-6"
xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABHNCSVQICAgIfAhkiAAAA8RJREFU WIXtl81rnFUUxn/n3HdmUhOoU7UtpeQLVASh0kTBlRRUlIjUvSiCC6Vx5T/gyk0WIlTalQtFoX5A lXZp46J+YD80atPWGDszTtLGTJLJTJJmZu57r4t3MplJJomRKdn0Wb+c5znPee659xXvPTsJ3VH2 uwIAAYJLx4+cNtgB7xzQLBOCqBISnOkbHH4JsK0SEAC7DHbg0BsfgrXgZQOZhpETr70A7AKKrRTQ 5p0DaylffRePqTLWIyTR9Qq2tMzl958siDQRuQlEDSHB2b7B4aOscS+osTmL1zhIDOoJPOBDXClH 37FP12vbkt1DEGPkxKsDNHEvWCWyoAHIqqaoAIBSyX0L0+eaEGxC7j1CSPyht4nyRdvGAigjoiDa pKqCmJWqDcyisokGHzXmF6p1138a1Iq5CqjZQMB6iEYnY2mmwOaRCDHZK4gI77z8SO+z/fs644Em +gfPfQ/4Ogcsohp1u4UAUUGNkro8xmzmJs2P7kprHuE3xCgvPpH8QaggKBePHznbPzh8tC4DYeQA CiI0NVZAEMQo6UvXoVKif/AjcHZTEY3wEIsxcvL1AWDX6gh8BcQgYhBjIluFdW6ICKmfruFtSOeh bsrXh9h4ga2Fw7R3wZ7nyRfLF4B43QhCVA1qYqQujpK7MYE0Lars6dxH12M9OOdBTTVfWwjwgLdo Ry+58QtcyS5+DYSNGQgM85M57PIij7/5HrhwjQMCKHbyFM5H00X/63XiwIPec5DC36c49sHvnwHL QU27D1ETMDc5TbL7UXxlCTt1moZQroxETDUn24Egif2E5ZDZ7Ng00T4orzqg0SLKZ6Y4cPhpWJ4A jVfP/1qq7a7DKkXbXnLjPzOanvsYKAEuqGoD8dyeXyDRESex+wB24Q/ExGnNjR3lQxMPUMyeZ+iL 8U+AZajfhBqS+ytLsvthEIe4QrSa/2e3jXBILImzFQqTN0qjmeI/RA5UBYiAQPFWjt6n+qE8E21E adV7xaGJJLPpq2SmF88QdR/WBIgIfimPLZVpu38/fmkKaVn3RHViHeQz5/nuWv5Lqt3XBCDCws1J dh/sAu/x3K7a3wp4JGgHF1KcSDH0+diPVOdfEyCqzKTS3NfzILCIBq3sHoi1M5/5k1v50jfAInWP ktoI8qkM3c8NQKkAQXvryAFiHcxn0vyaWviKqPva2hRg7y8nnxlXfIezFhc9HFoKEcGhhb63hg8D WeoyIMC9QA+QpKW+N8ADeSANzAG1LgWIAe1A/A6Rr6BMNP/KHebZHuTuz+lOC/gX/29g6TEI7HMA AAAASUVORK5CYII= "
height="32"
width="32" />
<image
y="662.88904"
x="371.37128"
id="image3048-0"
xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABHNCSVQICAgIfAhkiAAABLtJREFU WIXFl02MFEUYhp+vqnp2dpEfgSgYwi7qihgTRPQAeJDIAV1CIHDxojESIwEuevPiTRM5GKIGTNSD JiYkYBAhJGpEY/AggmxiZAkSh7/FZQd2dti/memu8lA9vzuzM6yb+CZ96O6q+t7v/b5+q1qcc/yf EMCc+XD9EU3Y46wF6hESRCkizLHVu09uBcKZImCAdk3Ys/L1zyAMwUkDmpre/a9sAtqBOzNJIOms hTAkf/4dHDqOWImIts6XCHMTnN23JitSh+QUEKWJMMdX7z65hRr1TCmaDXEqARJAZQAHuAibS7N6 15eTuTWN7sAE9O5/uYc66plyoBCUASlz8gsAKArpH2Hwh7uM7hAiEt1v4vuLZGMC5BFRIIrJaSoQ XVq0glkTQRwQgs0WR04abkqL2QIo3YDAZIgSRARRU411CBrsWHVZJxMACBGlgOYERAlKK1JnL3L7 8g3ANorvScgplNGc3bd2wJNWpaas6IHIK4ACEaQeCQFBEK24fOYCFHI8tedzsCFMZWhVSzkIAnoP 7OgB2sslcAUQjYhGtPaK1SmbiJD6tQ8XRixd2UX+wl4aG1gtLHpWJ8x/nsyd/GkgUVGCCKU0Sgek fvuT9N/XkbqLKuYvvZ/OJ5ZhrQOlfdvgmnaOsyH6ngcZvHSaP66Ofg1E1T1gNMP9acKJUZ7e+T7Y qEYBARRh/0GsEx9SKQTQyqHENVbCgXMa6VhC9upBPv326jFgwlCc4iKUNgz1D3Jv1+O4whjhwBGq mrJYEtFxnxRd2pIPVdMqqORiTJgnc/3izd//Gk4D+bICKgSlyQ6keeDJDTBxHVQi/v5rxS3fizgI LCu/Wk9fuiNWrYaJCDhYvkj4ac0v9KXSXwDjgDV+OQFxjA+PEgSatrmLCUcuIjoRKzBFVsqBjui7 2YHbu37KsYfPZ9hx6Bzm52tHgAmo9AEVkbk2wLyu5SAOsVlvzU09wYFScebwzYV/SjMssHn5ImTP YW6/t5ltK+bB9lfZPvTwG5ze8iKl9ERAYOhKP/OXdUP+lndEFXgSzS4dlHyg3Wg6gvgysXpGkc2F DIzk2LZiHid2PrN1zltHDwHGl0AEN5YhzBVILlyEGxtAWsjeK+diA/NoCxQqtl1bNCcRxgohYMiM F9jYvQCr9SZKRiTCyI1+5i7pBOdwjMfytwDl4rE+WFIriucFa/2zFx69j8fe/d7XJLK4D7YRv0p6 BZTiVuoyC5Z1A6Mo02L2EO/35a5PGq+GAJH458dfWztpWnwWlVIJMqkrdG3sgVwWzKzWghcJBLl4 Fy0TAK9JX3qkauMWgUcWzCp9qAYgcnJHB8Hs3o8PYG2Dna0BNI45agzMKgASWuEo61flCK5iV3Zl AvlVO797dtfmh9ZN5KO7PqPbyNpbmdEcz6lPAJKBmnpjrKmsAUaB1EdHLw3SzHXqwwFz2OB9oE3r cvfXgaphYIACMAQM/wcCBZEC4BWIbGMCOj5BVfVAfB/F13QQJcRPTWoFuslooHiSm07GddGm7+68 HmgfukW3aQqXzGVOzX37xLpCZJmiAijxwZO5zKls/f+waWE2sBRYSGtJhUAauDJTBAz+rydJaxbq 8Nvx+AzFnz7+BfrWszSatlERAAAAAElFTkSuQmCC "
height="32"
width="32" />
<text
xml:space="preserve"
style="font-size:14px;font-style:normal;font-weight:bold;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans Bold"
x="232.81795"
y="379.88388"
id="text3308"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan3310"
x="232.81795"
y="379.88388"
style="font-size:13px">Sample index</tspan></text>
<text
xml:space="preserve"
style="font-size:14px;font-style:normal;font-weight:bold;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans Bold"
x="240.23936"
y="449.4061"
id="text3308-9"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan3310-9"
x="240.23936"
y="449.4061"
style="font-size:13px">'Due dates'</tspan></text>
<text
xml:space="preserve"
style="font-size:14px;font-style:normal;font-weight:bold;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans Bold"
x="316.27951"
y="517.43311"
id="text3308-9-4"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan3310-9-8"
x="316.27951"
y="517.43311"
style="font-size:13px">metadata.due_date</tspan></text>
<text
xml:space="preserve"
style="font-size:14px;font-style:normal;font-weight:bold;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans Bold"
x="241.52823"
y="592.18439"
id="text3308-9-40"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan3310-9-1"
x="241.52823"
y="592.18439"
style="font-size:13px">'Suppliers'</tspan></text>
<text
xml:space="preserve"
style="font-size:14px;font-style:normal;font-weight:bold;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans Bold"
x="319.08157"
y="651.24176"
id="text3308-9-4-3"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan3310-9-8-7"
x="319.08157"
y="651.24176"
style="font-size:13px">metadata.supplier</tspan></text>
<text
xml:space="preserve"
style="font-size:14px;font-style:normal;font-weight:bold;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans Bold"
x="289.94205"
y="330.87161"
id="text3308-5"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan3310-5"
x="289.94205"
y="330.87161">Index template</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 279.33572,488.44173 0,89.10029"
id="path3933-5"
inkscape:connector-curvature="0" />
<path
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 279.23229,542.97272 84.83096,0"
id="path3933-5-3"
inkscape:connector-curvature="0" />
<path
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 279.51264,631.87053 0,43.55572"
id="path3933-5-9"
inkscape:connector-curvature="0" />
<path
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 279.82037,674.9921 84.83098,0"
id="path3933-5-3-8"
inkscape:connector-curvature="0" />
</g>
</svg>

After

Width:  |  Height:  |  Size: 14 KiB

513
docs/figure_src/indexes.svg Normal file

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

BIN
docs/topics/indexes.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

View File

@@ -2,23 +2,48 @@
Indexes
=======
Administrators first define the template of the index and an instance
of the index is then auto-populated with links to the documents depending
on the rules of each branch of the index evaluated againts the metadata
of the documents. Indexes can be mirrored to the operating system filesystem
using the configuration option
:setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`. This creates an actual
directory tree and links to the actual stored files but using
the filename of the documents as stored in the database. This
filesystem mirror of the index can them be served with Samba_ across the
network. This access would be read-only, and new versions of the files
would have to be uploaded from the web GUI using the new document
versioning support.
Indexes are an automatic method to hierarchically organize documents in relation to their metadata and to each other.
Since multiple indexes can be defined, the first step is to create an empty index.
Administrators then define the tree template showing how the index will be structured.
Each branch can be a pseudo folder, which can hold other child 'folders' or
a document container which will have all the links to the documents that
matched the path to reach the document container.
The index cannot be edited manually, only changing
.. image:: index_template.png
:alt: index template
This template is the skeleton from which an instance of the index is then
auto-populated with links to the documents depending on the rules of each
branch of the index evaluated against the metadata and properties of the documents.
.. image:: index_instance.png
:alt: index instance
Indexes can be mirrored to the operating system filesystem
using the configuration option
:setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`.
``settings_local.py``::
# Supposing the 'Sample index' internal name is 'sample_index'
DOCUMENT_INDEXING_FILESYSTEM_SERVING = {
'sample_index': '/var/local/document/sharing/invoices/',
}
This creates an actual directory tree and links to the actual stored files but using
the filename of the documents as stored in the database.
.. image:: indexes.png
:alt: indexes diagram
This filesystem mirror of the index can them be served with Samba_ across the
network. This access would be read-only, with new versions of the files
being uploaded from the web GUI using the document versioning support.
The index cannot be edited manually to protect it's integrity, only changing
the rules or the metadata of the documents would cause the index to be
regenerated. For manual organization of documents there are the folders,
their structure is however flat, and they have to be manually updated and
curated.
curated.
.. _Samba: http://www.samba.org/