This notebook contains material from nbpages by Jeffrey Kantor (jeff at nd.edu). The text is released under the CC-BY-NC-ND-4.0 license. The code is released under the MIT license.

< 1.1 Notebook naming and ancillary/generated files | Contents | Tag Index | 1.3 External Files >

1.2 Notebook Style¶

1.2.1 Headings and subheadings¶

1.2.1.1 Title¶

Each notebook begins with a markdown level header containing the title of the corresponding chapter or section. This should be capitalized following the Chicago Manual of Style. The hashtag # appears as the first line in the cell, and there is exactly one level 1 header per notebook. The title cell may include a brief summary of the notebook contents.

1.2.1.2 Subheadings¶

A notebook will typically consist of multiple sections. The sections are organized heirarchically as markdown headings. Following the document title, the highest level heading begins as markdown level 2 (i.e., ##). The heirarchy is strict meaning that the next level in the heirarchy, ###, and must appear before the first heading of the next higher level. This, for example, is an allowable heirarchy:

# Notebook Title
## First section
### First subsection
#### First sub-subsection
#### Second sub-subsection
### Second subsection
## Second section
### Another subsection

The following example is not compliant because it skips from ## to #### without an intervening ###:

# Notebook Title
## First section
#### First sub-subsection
#### Second sub-subsection
### Second subsection
## Second section
### Another subsection

The following guidelines apply to headings and subheadings:

Following the Chicago Manual of Style, only the first word in headings and subheadings are capitalized.
Each heading or subheading appears as the first line in a markdown cell.
Titles, headings, and subheadings should be unnumbered.

1.2.1.3 Orphan headings¶

Orphan headings are any heading not adhering to this style guide. Headings that are not the first line in a cell, or inconsistent with a string heirarchy are reported as 'lint'.

1.2.1.4 Keywords¶

Keywords can be included in the level 1 headers designating a title. The keywords are specified in a new line beginning with Keywords: (case in-sensitive) followed by a comma separated list of keyword phrases. Keywords are used to construct an index for the notebook collection.

1.2.2 Markdown¶

Plain github-flavored markdown should be used whereever possible. Avoid use of non-markdown constructs, such as html tags.

Any references should be collected under a separate heading entitled References, and formatted using the Chicago Manual of Style.
Additional sections entitled Exercises, Additional resources, Further reading may be included in the notebooks. Each exercise should be given a separate subsection to be included in the table of contents.

1.2.3 Mathematics¶

Mathematics should be typeset using the LaTeX conventions.

\begin{align*} \frac{\partial T}{\partial t} & = \nabla^2T \end{align*}

< 1.1 Notebook naming and ancillary/generated files | Contents | Tag Index | 1.3 External Files >