3 ms·

I wrote my own web-based editor to write Closure: The Definitive Guide (O'Reilly): http://docbookeditor.appspot.com/ http://docbookeditor.appspot.com/ Unfortuna

I wrote my own web-based editor to write Closure: The Definitive Guide (O'Reilly): http://docbookeditor.appspot.com/ http://docbookeditor.appspot.com/ Unfortunately, it's in a bit of a state of disarray because in Google's process of migrating from Docs 1.0 to Docs 2.0, they basically screwed over all the GData users in the process, which broke my tool. But as explained on the site, I made it possible to write in a Wiki-like language that looked something like the final product (using HTML/CSS rather than plaintext, saving a lot of TeX compilation and context switching to look at the generated DVI). My editor can export to either DocBook XML or HTML, so I used the former to publish my book and the latter to publish essays on my web site. I also added support for slurping in source code from my repository so that I could be sure that the code samples in my writing actually worked. This was a bit of a pain, but definitely paid off, as readers are often infuriated by code samples that don't work. So far, no errata for code samples have been reported: http://oreilly.com/catalog/errata.csp?isbn=0636920001416 http://oreilly.com/catalog/errata.csp?isbn=0636920001416

euroclydon 15y ago
Wow! Writing an editor to write a book. You're in good company. Someone else commented to just keep it simple and focus on the writing which is the traditional advice. Did you find that by creating an editor while writing your book, you were able to stay more engaged that if you had simply used a text editor and pushed off formatting until the content was done?
- bolinfest 15y ago
  Absolutely: it's easier for me to think about my own work when I see it in context (i.e., with the formatting). If I had to mouse around and select "Courier New" and the color green every time I wanted to format a code sample to get an idea of whether it looked right, I would have never finished. I had just enough formatting to tell whether things "felt right," but not so much that configuring it became a distraction. Though what _was_ a distraction was having to stop writing to switch contents and fix bugs or add features to my editor. This was still happening when I was in the final stages of the book because any time I context-switched, I tried to spend as little time on it as possible so I could get back to work. In retrospect, maybe I should have just taken a day or two to focus on the editor and then never go back. Fortunately, I'm still using NJEdit for other things now that the book is done, so it seems to have been worth the investment. I've also open-sourced it so others can use it or fork it for their own needs, so hopefully others can find a way to benefit from it.

euroclydon 15y ago

Wow! Writing an editor to write a book. You're in good company. Someone else commented to just keep it simple and focus on the writing which is the traditional advice. Did you find that by creating an editor while writing your book, you were able to stay more engaged that if you had simply used a text editor and pushed off formatting until the content was done?

bolinfest 15y ago
Absolutely: it's easier for me to think about my own work when I see it in context (i.e., with the formatting). If I had to mouse around and select "Courier New" and the color green every time I wanted to format a code sample to get an idea of whether it looked right, I would have never finished. I had just enough formatting to tell whether things "felt right," but not so much that configuring it became a distraction. Though what _was_ a distraction was having to stop writing to switch contents and fix bugs or add features to my editor. This was still happening when I was in the final stages of the book because any time I context-switched, I tried to spend as little time on it as possible so I could get back to work. In retrospect, maybe I should have just taken a day or two to focus on the editor and then never go back. Fortunately, I'm still using NJEdit for other things now that the book is done, so it seems to have been worth the investment. I've also open-sourced it so others can use it or fork it for their own needs, so hopefully others can find a way to benefit from it.