labs / tiddlers / content / labs / lab01 / _labs_lab01_Document Conventions.tid
created: 20200703064817063
modified: 20200703083635773
section: 1.4
tags: lab01
title: /labs/lab01/Document Conventions
type: text/x-markdown

The lab documents will use the following conventions:

* Inline code (code that appears in the middle of a sentence) `looks like this`.

* When we want you to perform an action in a user interface, such as selecting a menu it will look like:  <<menu "File > New File > Java > Java Class">>, or if it is a single action: <<menu "Click Me">>

* If we want you to enter a keyboard shortcut command:  <<keys "Ctrl > Space">>.

* When we are referring to paths or folders/files on disk it will look like: <<path "Home/Documents/info202">>.

* Blocks of code look like:

  public static void main(String[] args) {
     System.out.println("Hello World");

* Many operations in NetBeans are performed by right clicking the root folder of the project in the project pane.  This will be abbreviated to <<menu "RCTP">> which is short for 'right click the project'.

* We will often describe a task that needs to be completed and then provide additional details on how you should go about completing that task.  Students sometimes get confused because they stop at the "what" part of the task, before getting to the "how" part.  If something is confusing then keep reading &mdash; you might not have got to the "how" part yet.

* The INFO202 lab documents can be quite long.

  When introducing new concepts we try to provide all of the information that you will need to both understand and complete a task.  There is a lot of material in these documents that explains the "what" and "why" part of a task rather than just the "how".

  The instructions will become less detailed as the course progresses.  Basically, once you have learned a concept then there is no need for us to explain it again.  We will just give you the "what" and leave the "how" and "why" up to you (we will refer you back to the documents that provide the "how" and "why" where needed).