dburr/opml2html
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README and include latest ver of compiled binary

Browse source
This commit is contained in:
Donald Burr 2015-08-13 19:54:16 -07:00
parent e95bc01469
commit af688d1e28
2 changed files with 43 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -3,15 +3,31 @@ opml2html
### What is this? (aka the Problem to be Solved) ### What is this? (aka the Problem to be Solved)
O HAI I frequently contribute product reviews to the [NosillaCast][NC], a "technology geek
Need stuff here podcast with an EVER so slight Macintosh bias" put out by my friend [Allison Sheridan][ALLISON].
She insists that reviews must be submitted in both audio as well as text form, so that people who
use screen readers (those with limited or no vision) can still read the show notes. Being a
low vision user myself, I applaud this decision.
[NosillaCast][NC] When working on a writing project of any length, I always use the [Omni Group][OMNI] excellent
[Omni Group][OMNI] [OmniOutliner][OO] to organize my thoughts, so I figured that once I've organized my outline to
[OmniOutliner][OO] my satisfaction and fleshed it out, it would serve as a good set of show notes to send along with
my audio review. Unfortunately, OmniOutliner's export formats leave much to be desired; none of
them produce output that Allison can use without heavy editing.
I was hemming and hawing about how to solve this particular problem when I realized that, hey,
I'm a developer; surely I could put together some sort of tool to turn OmniOutliner's output
into a usable, simple HTML document. (I'm not sure why I didn't realize this until sooner!)
It also gave me an excuse to "get my hands dirty" with Apple's new programming language,
[Swift][SWIFT]. About half an hour later, I put together a (IMHO) rather nice tool that produces
simple, indented HTML using the OPML format which OmniOutliner can export to.
### Usage ### Usage
Export your outline from OmniOutliner (`File -> Export...`) and be sure and choose the
"OPML (Outline Processor Markup Language)" format. Now run `opml2html` in a Terminal
window. The usage is as follows:
``` ```
Usage: opml2html [options] Usage: opml2html [options]
-f, --input-file: -f, --input-file:
@ -24,6 +40,26 @@ Usage: opml2html [options]
Prints a help message. Prints a help message.
``` ```
The only mandatory command line argument is `-f` (or `--input-file`), which tells the
tool what file to read from. By default, the output gets stored into a file named
the same as the original filename, but with `.html` instead of `.opml` as its extension.
(So running the tool on a file `foo.opml` would place the results in a `foo.html` file
in the same directory as the original file.) This can be changed using the `-o` or
`--output-file` argument. Finally, the `-f` or `--full-mode` creates a fully-formed
HTML file (including `<HEAD>`, `<BODY>`, etc. tags.) By default the tool only outputs
the HTML necessary for rendering the outline.
### Building
This project includes Ben Gollmer's Swift [CommandLine][CL] library as a dependency
(using git submodules.) You must install it before you can build this project. This
is pretty easy to do however; just run the following commands.
```
git submodule init
git submodule update
```
### License ### License
This software is licensed under the terms of the [MIT License][MIT]. This software is licensed under the terms of the [MIT License][MIT].
@ -52,9 +88,11 @@ THE SOFTWARE.
Uses Ben Gollmer's Swift [CommandLine][CL] library. Uses Ben Gollmer's Swift [CommandLine][CL] library.
[ALLISON]: https://twitter.com/podfeet "Allison Sheridan"
[NC]: http://podfeet.com/ "NosillaCast" [NC]: http://podfeet.com/ "NosillaCast"
[OMNI]: https://www.omnigroup.com "The Omni Group" [OMNI]: https://www.omnigroup.com "The Omni Group"
[OO]: https://www.omnigroup.com/omnioutliner "OmniOutliner" [OO]: https://www.omnigroup.com/omnioutliner "OmniOutliner"
[SWIFT]: https://developer.apple.com/swift/ "Swift"
[EMAIL]: mailto:dburr@DonaldBurr.com?subject=opml2html "Email" [EMAIL]: mailto:dburr@DonaldBurr.com?subject=opml2html "Email"
[MIT]: http://opensource.org/licenses/MIT "MIT License" [MIT]: http://opensource.org/licenses/MIT "MIT License"
[CL]: https://github.com/jatoben/CommandLine "CommandLine" [CL]: https://github.com/jatoben/CommandLine "CommandLine"

BIN
bin/opml2html
View file

Binary file not shown.