HeadOut User Guide

Table of Contents

Introduction

HeadOut performs various Markdown/HTML transformations with headings and outlines.

Getting Started

System Requirements

HeadOut is written in Java and can run on any reasonably modern operating system, including Mac OS X, Windows and Linux. HeadOut requires a Java Runtime Environment (JRE), also known as a Java Virtual Machine (JVM). The version of this JRE/JVM must be at least 6. Visit www.java.com to download a recent version for most operating systems. Installation happens a bit differently under Mac OS X, but generally will occur fairly automatically when you try to launch a Java app for the first time.

Because HeadOut may be run on multiple platforms, it may look slightly different on different operating systems, and will obey slightly different conventions (using the CMD key on a Mac, vs. an ALT key on a PC, for example).

Rights

HeadOut Copyright 2013 - 2014 by Herb Bowie

HeadOut is open source software. Source code is available at GitHub.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Installation

Download the latest version from PowerSurgePub.com. Decompress the downloaded file. Drag the resulting file or folder into the location where you normally store your applications. Double-click on the jar file (or the application, if you’ve downloaded the Mac app) to launch.

Data Fields

HeadOut works with headings and outlines in Markdown and HTML.

User Interface

HeadOut has a straightforward user interface consisting of the following elements.

Specify Source for Input Text
You may select one of the following values from the drop down menu.
System Clipboard
The current contents of the system clipboard (typically populated via a cut or copy command from some other app) will be used as input.
Local File
You can specify a local text file as input.
Type of Transformation
Select one from the big drop down menu in the middle of the screen.
Create Markdown ToC from Markdown
This will interpret the input text as Markdown, and create a table of contents in Markdown as output, using the headings found in the input as entries in the table of contents.
Create HTML ToC from Markdown
This will interpret the input text as Markdown, and create a table of contents in HTML as output, using the headings found in the input as entries in the table of contents.
Add ToC to Markdown
This will interpret the input text as Markdown, add a table of contents in HTML to the source, and also convert Markdown headings to HTML. This ensures that the links in the table of contents use the same IDs as the ones used for the headings. The input file must have a heading with the text ‘Table of Contents’. The generated table of contents will be inserted following this heading.
Create Markdown from OPML
This will interpret the input text as an Outline in OPML format, and create a Markdown document as output, with the outline entries converted to headings.
Specify Target for Output Text
You may select one of the following values from the drop down menu.
System Clipboard
The output of the transformation will be placed on the system clipboard (to be picked up later via a paste in another app).
Local File
You can specify a local text file as output.
Lowest Heading Level
Specify the lowest heading level to be considered, when generating a table of contents.
Highest Heading Level
Specify the highest heading level to be considered, when generating a table of contents.
Transform Now
Once your other parameters are set, press this button to perform the desired transformation.

HeadOut logo