1,716
edits
Changes
Jump to navigation
Jump to search
mLine 15:
Line 15: + + + + + + Line 115:
Line 121: − + + Line 131:
Line 138: − − ==Downloads== − Download links are presented as list items and are '''descriptive'''. This means you don't waste space by pasting the entire url or writing something like "Click [[Meta:Guidelines|here]] to download the documentation". Examples: − *[[:File:Obs_tut_videoSet.png|Uploaded file with version control]] − *[[Media:BITSI_tempalte2015_duemilanove.zip|Directly downloadable file]] (zip)
no edit summary
You can add many levels of subheaders as you like, but after level 3 they become quite hard to distinguish and will clutter the TOC. If a subject requires many sub-subcategories, consider giving the subcategory its own page. Alternatively, if the sub-subcategories are only small in content, you could make non-TOC headers with simple '''bold text'''.
You can add many levels of subheaders as you like, but after level 3 they become quite hard to distinguish and will clutter the TOC. If a subject requires many sub-subcategories, consider giving the subcategory its own page. Alternatively, if the sub-subcategories are only small in content, you could make non-TOC headers with simple '''bold text'''.
==Download/External Links==
Links should be '''descriptive'''. Don't waste space by pasting the entire url or writing something like "Click [[Meta:Guidelines|here]] to download the documentation". Examples:
*[[:File:Obs_tut_videoSet.png|Uploaded file with version control]]
*[[Media:BITSI_tempalte2015_duemilanove.zip|Directly downloadable file]] (zip)
==Images==
==Images==
==Shields and Badges==
==Shields and Badges==
Github-style shields or badges are useful for providing software details like programming language and licensing at a glance. There's a case to be made for our Wiki and Gitlab READMEs to use similar layouts and features for more uniformity in our documentation, and so badges could help with that too. Unfortunately, it is currently a bit of a faff to implement badges on our wiki, as hotlinking dynamic content from external sources is disabled for security reasons.
Github-style shields or badges are useful for providing software details like programming language and licensing at a glance. There's a case to be made for our Wiki and Gitlab READMEs to use similar layouts and features for more uniformity in our documentation, and so badges could help with that too. Unfortunately, it is currently a bit of a faff to implement badges on our wiki, as hotlinking or injecting dynamic content from external sources is disabled for security reasons.
The workaround:
The workaround:
# Generate a badge at https://shields.io
# Generate a badge at https://shields.io
<pre>{{Outdated}}</pre>
<pre>{{Outdated}}</pre>
{{Outdated}}
{{Outdated}}
==References==
==References==
<references />
<references />