https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?action=history&feed=atom&title=STx_Documentation_Style_Guide
STx Documentation Style Guide - Revision history
2026-05-06T06:56:40Z
Revision history for this page on the wiki
MediaWiki 1.43.6
https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=STx_Documentation_Style_Guide&diff=10163&oldid=prev
Jw at 08:32, 2 August 2018
2018-08-02T08:32:33Z
<p></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 10:32, 2 August 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l9">Line 9:</td>
<td colspan="2" class="diff-lineno">Line 9:</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;"><br></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;"><br></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>You can surround STx output with the <code>samp</code> HTML tag.</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>You can surround STx output with the <code>samp</code> HTML tag.</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;"></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;">Surround keyboard shortcuts with the HTML tag <code>kbd</code>. E.g. the hotkey <kbd>S</kbd> can be used to update the spectrogram.</ins></div></td></tr>
</table>
Jw
https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=STx_Documentation_Style_Guide&diff=9726&oldid=prev
Jw at 09:49, 18 January 2018
2018-01-18T09:49:57Z
<p></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 11:49, 18 January 2018</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l5">Line 5:</td>
<td colspan="2" class="diff-lineno">Line 5:</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>You can use the class <code>sourcelabel</code> to format such elements as 'Usage', 'Parameters', 'Results', etc. in the documentation. This is prefered to using headers. Here's an examples:</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>You can use the class <code>sourcelabel</code> to format such elements as 'Usage', 'Parameters', 'Results', etc. in the documentation. This is prefered to using headers. Here's an examples:</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><div class="sourcelabel">Usage:</div></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><div class="sourcelabel">Usage:</div></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;"></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;">=HTML Tags=</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;"></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;">You can surround STx output with the <code>samp</code> HTML tag.</ins></div></td></tr>
</table>
Jw
https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=STx_Documentation_Style_Guide&diff=7138&oldid=prev
Jw at 09:26, 21 May 2014
2014-05-21T09:26:19Z
<p></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 11:26, 21 May 2014</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l3">Line 3:</td>
<td colspan="2" class="diff-lineno">Line 3:</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>=Classes=</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>=Classes=</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;"><br></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;"><br></td></tr>
<tr><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: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>You can use the class <code>sourcelabel</code> to format such elements as <del style="font-weight: bold; text-decoration: none;"><div class="sourcelabel"></del>Usage<del style="font-weight: bold; text-decoration: none;"></div></del>, <del style="font-weight: bold; text-decoration: none;"><div class="sourcelabel"></del>Parameters<del style="font-weight: bold; text-decoration: none;"></div></del>, <del style="font-weight: bold; text-decoration: none;"><div class="sourcelabel"></del>Results<del style="font-weight: bold; text-decoration: none;"></div></del>, etc. in the documentation. This is prefered to using headers.</div></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>You can use the class <code>sourcelabel</code> to format such elements as <ins style="font-weight: bold; text-decoration: none;">'</ins>Usage<ins style="font-weight: bold; text-decoration: none;">'</ins>, <ins style="font-weight: bold; text-decoration: none;">'</ins>Parameters<ins style="font-weight: bold; text-decoration: none;">'</ins>, <ins style="font-weight: bold; text-decoration: none;">'</ins>Results<ins style="font-weight: bold; text-decoration: none;">'</ins>, etc. in the documentation. This is prefered to using headers. <ins style="font-weight: bold; text-decoration: none;">Here's an examples:</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;"><div class="sourcelabel">Usage:</div></ins></div></td></tr>
</table>
Jw
https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=STx_Documentation_Style_Guide&diff=7137&oldid=prev
Jw at 09:24, 21 May 2014
2014-05-21T09:24:55Z
<p></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 11:24, 21 May 2014</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l3">Line 3:</td>
<td colspan="2" class="diff-lineno">Line 3:</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>=Classes=</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>=Classes=</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;"><br></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;"><br></td></tr>
<tr><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: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>You can use the class <code>sourcelabel</code> to format such elements as Usage, Parameters, Results, etc. in the documentation. This is prefered to using headers.</div></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>You can use the class <code>sourcelabel</code> to format such elements as <ins style="font-weight: bold; text-decoration: none;"><div class="sourcelabel"></ins>Usage<ins style="font-weight: bold; text-decoration: none;"></div></ins>, <ins style="font-weight: bold; text-decoration: none;"><div class="sourcelabel"></ins>Parameters<ins style="font-weight: bold; text-decoration: none;"></div></ins>, <ins style="font-weight: bold; text-decoration: none;"><div class="sourcelabel"></ins>Results<ins style="font-weight: bold; text-decoration: none;"></div></ins>, etc. in the documentation. This is prefered to using headers.</div></td></tr>
</table>
Jw
https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=STx_Documentation_Style_Guide&diff=7134&oldid=prev
Jw: Jw moved page STx wiki formatting and structure to STx Documentation Style Guide
2014-05-21T09:23:09Z
<p>Jw moved page <a href="/stx/docs/wiki/index.php/STx_wiki_formatting_and_structure" class="mw-redirect" title="STx wiki formatting and structure">STx wiki formatting and structure</a> to <a href="/stx/docs/wiki/index.php/STx_Documentation_Style_Guide" title="STx Documentation Style Guide">STx Documentation Style Guide</a></p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<tr class="diff-title" lang="en">
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 11:23, 21 May 2014</td>
</tr><tr><td colspan="2" class="diff-notice" lang="en"><div class="mw-diff-empty">(No difference)</div>
</td></tr></table>
Jw
https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=STx_Documentation_Style_Guide&diff=7133&oldid=prev
Jw: Created page with "This page aims to help the STx documentation team apply consistent formatting and structure to the STx documentation. =Classes= You can use the class <code>sourcelabel</code..."
2014-05-21T09:20:26Z
<p>Created page with "This page aims to help the STx documentation team apply consistent formatting and structure to the STx documentation. =Classes= You can use the class <code>sourcelabel</code..."</p>
<p><b>New page</b></p><div>This page aims to help the STx documentation team apply consistent formatting and structure to the STx documentation.<br />
<br />
=Classes=<br />
<br />
You can use the class <code>sourcelabel</code> to format such elements as Usage, Parameters, Results, etc. in the documentation. This is prefered to using headers.</div>
Jw