ECON 490: Formatting Guidelines (00)
Prerequisites
- Numbered list of modules and skills needed before completing for this module.
Learning Outcomes
- Numbered list of expected outcomes after completing the module writen used the guidelines provided in the workshop.
00.1 Introduction to Formatting Guidelines
Start with a brief introduction that is included under a heading - do not simply continuing on from above. Note that the heads at this level use title case.
00.2 Formatting guidelines for text
00.2.1 How to indicate code and options
Code should be indicated using this method summarize
. Options can be indcated the same way [fweight=weight]
.
If there are blocks of code, then approach is:
/* Here is the code */
00.2.2 How to indicate variable names
Variable name can be indicated by italics. Like this fake_variable.
00.2.3 How to indicate file and folder name
File and folder names can be indicate by encasing them in ““. Like this file name”1.data_build.do:”
Note that the headings at this level use sentence case.
00.2.4 Do-files and log-files
Not do file and log file, or dofile and logfile. But do-file and log-file.
00.3 Creating Notes and Warnings
Note: Notes appear in blue boxes
Warning: Warnings appear in red (orange? Brown?) boxes.
00.4 Wrap Up
A brief summary of what has been accomplished and what is coming next.