How-To's
========

Below are some instructions for specific formatting techniques. 
You will need to look in the .rst files to see exactly how it was done, but you can
use the web version of this page to see it in html format.
Many additional techniques can be found `on this page`_, or by searching ``restructured text`` and the feature you want.

.. _`on this page`: https://docutils.sourceforge.io/docs/user/rst/quickref.html


Page Heading
------------

Add double dashes (or equals) under the word or phrase, followed by a blank line (see How-To's above)
Make sure to insert the dashes the exact length of the word or phrase you want used for the heading.


Section Heading
---------------

Add single dashes under the word or phrase, followed by a blank line (as is done here for Section Heading).
Make sure to insert the dashes the exact length of the word or phrase you want used for the heading.

Inserting an Image
------------------

.. figure:: running_wrf/images/image001.png

Use the following syntax to adjust size, etc. 
".. image:: stars.jpg
:width: 200px
:align: center
:height: 100px
:alt: alternate text"

Adding Links
------------

1) Single-word link
In the text, add an underscore after the word:

See the WRF & MPAS Users Forum_.

Then below section of text add:

.. _Forum: https://forum.mmm.ucar.edu/phpBB3

2) Phrase link
To add links to a phrase, do the same, but add back quotes around the phrase:

See the `WRF & MPAS Users Forum`_. 

Then below section of text add:

.. _`WRF & MPAS Users Forum`: https://forum.mmm.ucar.edu/phpBB3


Bold Text
---------

Add two astericks before and after the bold word or phrase.
(e.g.), **Rainbows are pretty**

Italicized Text
---------------

Add astericks around the word or phrase
(e.g.), *Rainbows are pretty*


Highlighted  Text
-----------------

Add two back quotes around word or phrase
(e.g.), ``Rainbows are pretty``

Bulleted Lists
--------------

For a numbered list, use numbers, or #'s, 
(e.g.), 

1. apple
2. orange
#. pineapple
#. grapes

For an unordered list, use astericks, dashes, or +
(e.g.), 

* apple
* orange
* pineapple
* grapes 

Create a Table or Columns
-------------------------

Take a look at the hard code in how-to.rst to see how the below columns
were made. (`Other table options`_)

.. csv-table:: 
   :header: "Research Applications", "Functional Applications"
   :widths: 30, 30

   "Parameterization", "Idealized simulations"
   "Data assimilation", "Real-time numerical weather prediction"
   "Forecasting",       "Model coupling"
   "Tropical cyclones", "Teaching"
   "Regional climate" 
   "Fire"

.. _`Other table options`: https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html




insert a line space (empty line)
--------------------------------

Use a vertical pipe "|" to indicate a blank line


I'm inserting a blank line between this line

|

and this line.