Sunday, February 9, 2014

Reading (and understanding) my posts

While writing these blog posts (published and unpublished), I wanted to create a specific notation to simplify my posts.  The purpose of this specific blog post is to outline the notation so it may make sense to you. This is what I have used thus far, and if more is utilized in future posts this list will be updated with new information.

1. Text inside a code block (box with gray background) - Text inside of these are to be used literally, or interpreted literally. For example: commands, chunks of code, output from a program (will be italicized, see below) etc (see next point for an example).

2. Text in bold - I have restricted text in bold to be interpreted and changed, for example if I type

user@xynteq~$ ssh your.user@yourserver

both "your.user" and "yourserver" are in bold, meaning these are your credentials and not exactly what needs to be typed.

3. Text in italics - Text in italics will always be outputs from the computer, for example a response from a command, for example:

Cloning into 'git-test-repo'...
Enter passphrase for key '/home/user/.ssh/id_rsa': 

4. The warning symbol - This is used to warn you about things that could be easily mistaken, side effects, irreversible actions or a variety of things that need blatant attention, they will always be lead with the symbol shown at the right.

5. Text in courier - This font will be used for labeling either packages or commands when I am explaining them, for example if I am discussing how to generate a ssh key, I would be talking about the ssh-keygen command, or if I am talking about installing ssh, I would talk about installing the openssh-client

No comments:

Post a Comment