DocOnce Description
1.0
Site
DocOnce Description
What Is DocOnce?
Demos and Documentation
Markup Based on Special Lines
Heading with title and author(s)
Copyright
Table of contents
Section headings
Abstract
Appendix
Figures
Basic syntax
Figure Placement
Figure References
Inline Figures
Choosing the Figure Format
Handling Variable Figure Paths
Figures with Subfigures
Sidecaption in LaTeX and HTML
TikZ Figures
Plot Files in LaTeX
Interactive Bokeh Plots for HTML
Converting Matplotlib Plots to Bokeh
Movies
The Basic Command
MP4, WebM, and Ogg Movies in HTML
Movie Handling in Various Formats
YouTube and Vimeo Movies
Animation Based on Filename Generators
Copying Computer Code from Source Files
Inserting the Output from Operating System Commands
Comments
Tables
Basic Syntax
Quick way of creating tables
Tables from DocOnce to CSV Data Files
Lists
Inline Tagging
Emphasized Words
Inline Verbatim Text
Links to Web Addresses
Links to Mail Addresses
Links to Local Files
Quotes
Non-Breaking Space
Horizontal rule
Em-dash
En-dash
Ampersand
Footnotes
Inline Comments
Inline Comments for Editing
Forced Line Breaks
Inline Mathematics
Cross-Referencing
Generalized Cross-Referencing
Generalized References
Generalized References to Chapters
Generalized References to LaTeX Documents
Tool for Generating Generalized References
A Worked Example
Index
Emojis
Exercises, Problems, Projects, and Examples
Examples on Exercise Syntax
Elements in an Exercise
Solutions
Example
Exercise versus Problem and Project
Modified Heading
Data Structure for all Exercises
Typesetting of Exercises
Remark on Typesettng of Examples
List of Exercises, Problems, and Projects
Numbering of Extra Equations in Solutions
Book
Use the tag command
Typesetting of solutions to exercises
Extracting Selected Exercises in a Separate Document
Extracting Exercises as Stand-Alone Documents
Example on an Exercise
Exercise 1: Compute integrals
Remarks
Other Environments
Blocks of Verbatim Computer Code
Typesetting Styles
Executable and Non-Executable Code
Hiding code blocks in HTML
Customizing Code Environments Types for Sphinx
Examples
Copying Code from Source Files
The
fromto
and
from-to
directives
Removing indentation in copied code
LaTeX Blocks of Mathematical Text
Support of LaTeX Math in Various Output Formats
ePub and Mobi
Apple iBook Format
Dealing with Mathematics in Formats without LaTeX Math Support
Mathematics for PowerPoint/OpenOffice
Macros (Newcommands)
Writing Guidelines (Especially for LaTeX Users!)
Typesetting of Algorithms
Admonitions
Examples on Admonition Types
Layout of Admonitions in HTML
Layout of Admonitions in LaTeX
LaTeX code Environments Inside Admonitions
The Box Environment
User-Defined Environments
Example 1: Addition
Bibliography (References)
Importing your data to the Publish database
Requirements to input data
Adding new references to the database
Exporting the database
Referring to publications
Specifying the Publish database
LaTeX Bibliography Style
Preprocessing and Postprocessing
The Preprocess and Mako Preprocessors
Splitting Documents into Smaller Pieces
Writing Slides
Overview
Slide Types
Syntax
Slide Elements
Title page
Parts Page
Standard bullet list page
Equations, movies, figures
HTML5 Slides
Potential Problems
LaTeX Beamer Slides
Themes
Pop of list items and blocks
Compilation
Support for non-English
Misc
Missing Features
Git
.gitignore
File
Emacs DocOnce Formatter
Atom Syntax Highlighting for DocOnce
Mako Programming
The Basics of Mako
Debugging Python code in Mako
Example: Nomenclature functionality
Example: Executing Python and using SymPy Objects in LaTeX
Example: Extending Tables to Handle Figures
Solution for LaTeX and HTML
Generating the Entire Table
Generating the Entire Table in a Native Format via Mako
Generating the Entire Table in a Native Format as a Post Process
Example: Defining a Theorem Environment
Tools for Writing DocOnce Documents
Debugging
From DocOnce to Other Formats
Writing a Makefile
Generating a Makefile
Spell checking
Preprocessing
Variable Substition with Preprocessors
Removal of Inline Comments
Notes
Demo of Different Formats
Tweaking the DocOnce Output
Useful Options for
doconce
format
HTML
Basic HTML Output
Typesetting of Code
Handling of Movies
HTML Styles
HTML templates
Splitting HTML documents
The HTML File Collection
Filenames
URL to files hosted on GitHub
Other HTML options
Blog Posts
Pandoc and Markdown
Markdown to HTML conversion
Strict Markdown
GitHub-flavored Markdown
MultiMarkdown
Strapdown rendering of Markdown text
Using Pandoc to go from LaTeX to MS Word or HTML
LaTeX
Overview
The old
ptex2tex
step
LaTeX-PDF: Generate LaTeX (Step 1)
The translation command
Newcommands
Output for paper vs screen
Command-line options
Syntax highlighting
Drafts
Potential problems with ampersand
Part 2 of Step 1 (outdated)
LaTeX-PDF: Edit the LaTeX File (Step 2, Optional)
LaTeX-PDF: Generate PDF (Step 3)
XeLaTeX
From PDF to e-book formats
Microsoft Word or LibreOffice
Jupyter (IPython) Notebooks
Hidden code blocks
Displaying code as plain text instead of executable cells
Figures
Movies
Admonitions
References to an External Textbook
Conversion from Notebook Back to DocOnce
Matlab Notebooks
Plain ASCII Text
reStructuredText
Sphinx
The Basic Steps
Links
Themes
Using a Your Own Configuration File
Compiling Multiple Themes
Example
RunestoneInteractive books
The manual Sphinx procedure
Wiki Formats
Google Docs
Options for the
doconce
commands
doconce
format
command-line options
Installation of DocOnce and its Dependencies
DocOnce
Dependencies
Python v2.7
Preprocessors
Bibliography
Image file handling
Spellcheck
Ptex2tex for LaTeX Output
Pygments and the Minted Code Style
LaTeX packages
Sphinx or reStructuredText Output
Markdown and Pandoc Output
Epydoc Output
Analyzing file differences
Basic Parsing Ideas
Typesetting of Function Arguments, Return Values, and Variables
References
Page
DocOnce Description
Index
DocOnce Description »
DocOnce Description
¶
Contents:
DocOnce Description
What Is DocOnce?
Markup Based on Special Lines
Inline Tagging
Exercises, Problems, Projects, and Examples
Other Environments
Bibliography (References)
Preprocessing and Postprocessing
Writing Slides
Support for non-English
Misc
Mako Programming
From DocOnce to Other Formats
HTML
Pandoc and Markdown
LaTeX
Jupyter (IPython) Notebooks
Matlab Notebooks
Plain ASCII Text
reStructuredText
Sphinx
Wiki Formats
Google Docs
Options for the
doconce
commands
Installation of DocOnce and its Dependencies
Basic Parsing Ideas
References
Index
¶
Index