https://htyp.org/mw/index.php?action=history&feed=atom&title=VbzCart%2FmetaVbzCart/meta - Revision history2026-07-27T00:50:05ZRevision history for this page on the wikiMediaWiki 1.45.3https://htyp.org/mw/index.php?title=VbzCart/meta&diff=21766&oldid=prevWoozle: /* Tools */ l/vc2016-03-03T23:00:52Z<p><span class="autocomment">Tools: </span> l/vc</p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 23:00, 3 March 2016</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l21">Line 21:</td>
<td colspan="2" class="diff-lineno">Line 21:</td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* [[Template:l/vc/table]]: links to a table definition</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* [[Template:l/vc/table]]: links to a table definition</div></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* [[Template:l/vc/query]]: links to a query (view) definition</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* [[Template:l/vc/query]]: links to a query (view) definition</div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">* [[Template:l/vc]]: links to anything under VbzCart</ins></div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">** Currently used for the {{l/vc|archive}}s; if that's the only place without its own template, then maybe it should have one.</ins></div></td></tr>
</table>Woozlehttps://htyp.org/mw/index.php?title=VbzCart/meta&diff=21742&oldid=prevWoozle: Created page with "==Organization== There are two main types of documentation: '''technical''' and '''user'''. They can cross-link to each other where appropriate. * '''Technical''' documentatio..."2016-03-02T22:21:34Z<p>Created page with "==Organization== There are two main types of documentation: '''technical''' and '''user'''. They can cross-link to each other where appropriate. * '''Technical''' documentatio..."</p>
<p><b>New page</b></p><div>==Organization==<br />
There are two main types of documentation: '''technical''' and '''user'''. They can cross-link to each other where appropriate.<br />
* '''Technical''' documentation consists of:<br />
** {{l/same|pieces}}: concepts and how-to<br />
** {{l/same|coding}}: actual code (data structures and source code repos)<br />
* '''User''' documentation is designed to be invoked from within the software's web interface, and hence is rooted at {{l/same|ui}}:<br />
* {{l/same|ui}}: root page<br />
** {{l/same|ui/terms}}: terminology<br />
** {{l/same|ui/pages}}: help for specific pages/areas within the software<br />
<br />
I'm considering renaming "ui" to "help" and "pages" to "ui". We would then have:<br />
* {{l/same|help}}: root index for help area<br />
** {{l/same|help/terms}}: terminology<br />
** {{l/same|help/ui}}: help for specific software pages/areas<br />
==Tools==<br />
Templates for linking to documentation pages:<br />
* [[Template:l/vc/help]]: links to help pages, wherever they are or will be<br />
* [[Template:l/vc/term]]: links to a terminology help page<br />
* [[Template:l/vc/piece]]: links to concepts/how-to pages<br />
* [[Template:l/vc/code]]: links to the source code repository for a specific file<br />
* [[Template:l/vc/table]]: links to a table definition<br />
* [[Template:l/vc/query]]: links to a query (view) definition</div>Woozle