Style Guide MNJK: Difference between revisions
Jump to navigation
Jump to search
MikeTieden (talk | contribs) |
MikeTieden (talk | contribs) |
||
| Line 16: | Line 16: | ||
'''''[https://www.youtube.com/watch?v=dQw4w9WgXcQ Watch the video of this lab]''''' | '''''[https://www.youtube.com/watch?v=dQw4w9WgXcQ Watch the video of this lab]''''' | ||
<ol> | <ol> | ||
<li> Steps should be numbered using li tags. </li> | <li> Steps should be numbered using '''li''' tags. </li> | ||
* Sub-steps should be bulleted using asterisks | * Sub-steps should be bulleted using asterisks. | ||
* Another sub-step | * Another sub-step. | ||
* Yet another sub-step | * Yet another sub-step. | ||
<li> Step 2. </li> | <li> Step 2. </li> | ||
* Sub-step about Step 2 | * Sub-step about Step 2 | ||
: ''NOTE: Notes should be indented with a colon, and wrapped in double apostrophes. Also, they should start with the word NOTE capitalized, and end with a period.'' | : ''NOTE: Notes should be indented with a colon, and wrapped in double apostrophes. Also, they should start with the word NOTE capitalized, and end with a period.'' | ||
<li> This is a step to show how the code tag should be used. To place it on its own line and not within the paragraph, | <li> This is a step to show how the '''code''' tag should be used. To place it on its own line and not within the paragraph, move it to the next line and place a colon before it.</li> | ||
: <code> mkdir <my_directory> </code> | : <code> mkdir <my_directory> </code> | ||
: ''NOTE: When using a variable name, such as '''<my_directory>''', it should be wrapped in '''< >''' to make it stand out. Also, include a br tag after using a code tag to move to the next line. | : ''NOTE: When using a variable name, such as '''<my_directory>''', it should be wrapped in '''< >''' to make it stand out. Also, include a '''br''' tag after using a '''code''' tag to move to the next line. | ||
This is how a transition sentence should appear between steps. | This is how a transition sentence should appear between steps. | ||
<li> This is a step to show how to highlight a command, such as '''apt install''', within the step.</li> | <li> This is a step to show how to highlight a command, such as '''apt install''', within the step.</li> | ||
: ''NOTE: If the command is in a note, it will be bold and italicized such as '''apt install'''.'' | : ''NOTE: If the command is in a note, it will be bold and italicized such as '''apt install'''.'' | ||
<li> Example of a multi-line pre tag. Best for keeping all lines within the same box or for showing indentation. </li> | <li> Example of a multi-line '''pre''' tag. Best for keeping all lines within the same box or for showing indentation. </li> | ||
<pre> | <pre> | ||
If you have multi-line code / printout | If you have multi-line code / printout | ||
| Line 37: | Line 37: | ||
This is an example of a pre tag. | This is an example of a pre tag. | ||
</pre> | </pre> | ||
<li> This is an example of the same printout, but with code tags.</li> | <li> This is an example of the same printout, but with '''code''' tags.</li> | ||
: ''NOTE: Each line is a separate box and there is no indentation.'' | : ''NOTE: Each line is a separate box and there is no indentation.'' | ||
<code>If you have multi-line code / printout</code><br> | <code>If you have multi-line code / printout</code><br> | ||
Revision as of 02:41, 7 February 2021
Introduction
This lab assumes that you know the IP address of your Linux system and are connected to the ITCnet VPN network. If you need help with these steps please see the VPN instructions and the previous lab.
In this lab you will perform the following tasks:
- Installing the links web browser
- Installing the Apache webserver
- Installing Python and its dependencies
You will use the following commands:
Lab Section Title
- Steps should be numbered using li tags.
- Sub-steps should be bulleted using asterisks.
- Another sub-step.
- Yet another sub-step.
- Step 2.
- Sub-step about Step 2
- NOTE: Notes should be indented with a colon, and wrapped in double apostrophes. Also, they should start with the word NOTE capitalized, and end with a period.
- This is a step to show how the code tag should be used. To place it on its own line and not within the paragraph, move it to the next line and place a colon before it.
mkdir <my_directory>- NOTE: When using a variable name, such as <my_directory>, it should be wrapped in < > to make it stand out. Also, include a br tag after using a code tag to move to the next line.
- This is a step to show how to highlight a command, such as apt install, within the step.
- NOTE: If the command is in a note, it will be bold and italicized such as apt install.
- Example of a multi-line pre tag. Best for keeping all lines within the same box or for showing indentation.
- This is an example of the same printout, but with code tags.
- NOTE: Each line is a separate box and there is no indentation.
If you have multi-line code / printout
that needs to show indentation for whatever reason
using pre tags
work better than code tags.
This is an example of a pre tag.
If you have multi-line code / printout that needs to show indentation for whatever reason, using pre tags work better than code tags.This is an example of a code tag.