Welcome to the ERGuidance web
This documentation is presented to provide Innovation Program Authors and Editors with the resources and guidance needed to develop quality Engineering Reports and related documentation for public release through the OGC process.
To ensure that ERs are consistent in content and style and informative to members who were not Testbed participants.
General items for an intitial review.
- Identify all empty sections. If the section is not needed (it was a placeholder, never completed), then delete. If the content is required, but missing, contact the editors.
- Spelling. Use an editor that highlights spelling errors (such as ATOM). Fix them all. Sorry folks, but we write in American English so mind your Ss and Zs.
- Acronyms. All acronyms must be defined the first time they are used. No exceptions. Ever.
- Domain specific "buzzwords." Like acronyms, some users will not understand some domain-specific language (particularly true for the Aviation and Defense domains). Please explain all non-obvious content.
- Voice. All reports should be written in 3rd person. Nothing should say "we."
- Grammar. No incomplete sentences (like this one). Use direct language, not a super big bunch of adjectives (like in this sentence).
- Lists. When using bullet lists, only use a colon (:) at the end of the sentence leading into the bullets if each bullet is a short concept and not a complete sentence. Bullets that are stand-alone sentences are introduced by a stand-alone sentence.
- The problem with "it." "The map relies upon a single Web Map Service. It is part of the NSDI." Does "it" refer to the map or the WMS? Be clear in referencing previous sentences.
- Tense. The engineering reports are published after the end of a testbed or other IP initiative. Therefore, the engineering reports should be writted in the past tense.
Recommended Asciidoc Environment
We recommend to use http://asciidoctor.org[asciidoctor]
in combination with the https://atom.io[Atom]
In Atom, you should install the following packages (under Atom/Preferences/Packages):
* markdown-writer: requires changing of key-map to allow for keyboard shortcuts such as e.g. bold*
This environment allows you to use keyboard shortcuts, autocomplete, syntax highlighting and a rendered preview for asciidoc; and provides you an terminal window within the editor to convert your asciidoc to html and pdf.
Installation on MacOS and Linux
* Please follow the steps on https://asciidoctor.org/#installation
* Install the bibtex extension: gem install asciidoctor-bibtex
Installation on Windows
We have made best experiences with the following steps:
- Install ruby for windows: https://rubyinstaller.org/downloads/. If you experience any issues, the following link may help: https://stackoverflow.com/questions/18908708/installing-ruby-gem-in-windows[stackoverflow]
- Open command prompt and install two gems:
- Execute: "gem install asciidoctor"
- Execute: "gem install asciidoctor-bibtex"
- Text your installation
- Open a folder that contains your Engineering Report asciidoc source files, including the er.adoc file.
- Execute the following command: _asciidoctor -r asciidoctor-bibtex er.adoc_
- Q: Any way to automatically insert correctly numbered Figure captions?
Figures can use the following mechanism to add proper numbers and to allow referencing in text such as "...as illustrated in Figure 3."
.Image caption goes here
Key here is that this mechanism is required by all figures in a document, otherwise the counter does not work properly.
- Q: My table does look right in PDF, what can I do?
Simplify your tables as much as possible. Remember that the tables fit in portrait layout of A4 paper with normal margins, so the fewer the columns the better (3 or 4 columns with minimal text work fine).
By default, the columns may not auto fit, so please specify column width by percentages, such as: [cols="25e,25,50"]
NOTE: percentages must equal exactly 100%.