LISF Documentation

User Guides

Other Documentation

Important

The guides linked above are generated from the master branch. To view documentation for releases, visit the LIS website or the Releases page on GitHub (see the How to Read LISF Documentation section for additional information).

More Information

Documentation Format

The LISF documentation is written using AsciiDoc. Like LaTeX, AsciiDoc is text-based markup, thus it plays nicely with version control systems. Like LaTeX, AsciiDoc may be processed into other formats like HTML or PDF. Unlike LaTeX, the AsciiDoc syntax is simple, making the source files both easier to write and easier to read.

How to Read LISF Documentation

Web Browser

`master` branch

Use the links above to view documentation for the master branch directly in your browser.

Releases

While we recommend using the PDFs generated with each release (see links above), it is also possible to view documentation for the release branches (e.g., support/*) in browser.

First, install either the Firefox or Chrome browser and then install the ‘Asciidoctor.js Live Preview’ extension. (Please consult your sysadmin for help.) With the browser extension installed and enabled, navigate to the NASA-LIS/LISF repository on GitHub. Use the branch selection dropdown menu to select the support branch for the release you are using (e.g., support/lisf-public-7.3). Navigate to the directory of the desired documentation and open the *.adoc file with the same name as the enclosing directory (e.g., docs/LIS_users_guide/LIS_users_guide.adoc). Click the "Raw" button at the top-right of the document pane. After several seconds the ‘Asciidoctor.js Live Preview’ extension will render the document; et voilà, pretty documentation!

If you have the LISF source code on your personal computer you can also view the rendered documentation by dragging the desired document (e.g., LISF/docs/LIS_users_guide/LIS_users_guide.adoc) to an open browser window.

Pager/Editor

Since AsciiDoc is plain text, you may read the LISF documentation using a pager like more or less or using an editor like vim or emacs. Since the signal to noise ratio is high for AsciiDoc, this method of reading works very well, especially when working on an HPC system where you may not have many fancy tools installed.

asciidoctor toolset

You can process the AsciiDoc source yourself, using the asciidoctor toolset. With this toolset, you can generate an HTML or PDF version of the documentation. If you are masochistic, then you can even generate a DocBook version. And, then using various DocBook tools, you can render whatever you want. It is beyond the scope of this README to describe how to install asciidoctor and its dependencies. Please see the asciidoctor website and consult your sysadmin. This method is not recommended for the general LISF user. The Pager/Editor and Web Browser methods are better choices. Also note that a PDF version of the documentation will be available on the LIS website. This method is recommended only for documentation writers (LISF developers).

How to Write

The LISF documentation uses the Asciidoctor implementation of the AsciiDoc lightweight markup language. Please consult the AsciiDoc online documentation for more information.

Adding a new Guide to the LISF Documentation

Follow these instructions to add a new guide to the documentation to ensure it is automatically built and deployed to GitHub Pages and, if applicable, converted to PDFs when new releases are published.

Create a directory under LISF/docs/ with the name of your new guide, such as howto_write_docs/. If the guide will contain images, create a sub-directory named images/ (e.g, howto_write_docs/images).
Create an Asciidoc file in the new directory with the same name as the enclosing directory (e.g., howto_write_docs/howto_write_docs.adoc).
Write the content.
If appropriate, add a simple Makefile for rendering the guide to HTML and PDF. See LIS_users_guide/Makefile for an example.
Add a link to the new guide in LISF/docs/README.adoc.
This repository has a GitHub Actions workflow that automatically converts the User Guides to PDF when new releases are issued. If the new guide should be converted to PDF and attached to the release, add the name of the enclosing directory to the initialization of the environment variable GUIDES in the file LISF/.github/workflows/build-release-docs.yaml.

Note
Not all guides should be attached to new releases.

Tips

Here are some tips for reading the LISF documentation using vim or emacs. It is beyond the scope of this README to teach how to use either vim or emacs. Please consult your local guru for additional help.

vim

Tip 1

Open the documentation in read-only mode, unless of course you actually need to edit it.

% vim -R README

Tip 2

vim understands the AsciiDoc syntax. After opening the documentation, execute these vim command-line mode commands:

:set syntax on
:autocmd BufRead,BufNewFile *.adoc setfiletype asciidoc

Tip 3

Each paragraph is written as a single line. This may look bad in vim. Execute these vim command-line mode commands:

:set textwidth=0
:set wrap
:set linebreak

The vim normal mode commands j and k move down one line and up one line, respectively. For this document that is the same as down one paragraph and up one paragraph. The vim normal mode commands gj and gk respectively move up and down one virtual line. You should need these movement commands only when editing this document. When simply reading it, use the vim normal mode commands <C-f> and <C-b> (vim-speak for control-f and control-b) to move forward and backwards, respectively, one page at a time.

Tip 4

Let vim help you navigate the documentation. Whenever you encounter a line like

include::filename[]

place the cursor on ‘filename’ and execute the vim normal mode command gf. vim will ‘goto file’ under the cursor. Executing <C-t> (vim-speak for control-t) will take you back.

emacs

You guys don’t need my help. :-)

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!