Guidelines for Editing/Creating: Difference between revisions
Content added Content deleted
(Started the page) |
No edit summary |
||
Line 19: | Line 19: | ||
<li> |
<li> |
||
Please do not screenshot code or command line interfaces onto the wiki, as they are harder to follow and are at more risk of leaking data. Please use: <pre>CODE/COMMAND</pre> This is done by inserting "<pre>" and "</pre>" around your code. For example, a piece of code to print text in Perl would be typed like: |
Please do not screenshot code or command line interfaces onto the wiki, as they are harder to follow and are at more risk of leaking data. Please use: <pre>CODE/COMMAND</pre> This is done by inserting "<pre>" and "</pre>" around your code. For example, a piece of code to print text in Perl would be typed like: |
||
<div class="boxed"> |
|||
<pre> |
|||
<pre> |
<pre><br/> |
||
print "Hello, world.\n"; |
print "Hello, world.\n";<br/> |
||
</pre> |
</pre> |
||
</ |
</div> |
||
Once saved, this would look like: |
Once saved, this would look like: |
||
<pre> |
<pre> |
Revision as of 15:20, 24 September 2018
Welcome to the the wiki! Please read through these guidelines for creating content.
General Formatting Rules
Whilst creating content, please adhere to the following guidelines:
-
Ensure no private company or client data is leaked onto the wiki. Take special care on:
- Screenshots - ensure that all screenshots only contain data that is relevant (remove web addresses, block out user names and server names and check all text/imagery for private data).
- Commands and Code - please do not screenshot code or commands, as it is more likely to reveal sensitive data and is not as easy for someone to be able to follow.
-
Please do not screenshot code or command line interfaces onto the wiki, as they are harder to follow and are at more risk of leaking data. Please use:
CODE/COMMAND
This is done by inserting "<pre>" and "</pre>" around your code. For example, a piece of code to print text in Perl would be typed like:<pre>
print "Hello, world.\n";
</pre>Once saved, this would look like:
print "Hello, world.\n";
If you have any queries about code formatting, speak to a fellow developer - a fresh pair of eyes can make things a lot easier.