[ANN] Full Ruport Book manuscripts now on Github

[Gregory Brown]

Hi folks,

I'm happy to announce that my friend Chenoa Siegenthaler has converted
the entire Ruport Book to asciidoc, and that the sources are now
available on github.

http://github.com/ruport/book

The bookcan be build through Asciidoc to produce HTML and PDF, though
build instructions will need to wait until another day. But in the
mean time, people are welcome to start contributing fixes and
otherwise helping out. I will likely update the book when Ruport 2
rolls around, but the conversion of the sources to asciidoc represents
the next step in fully freeing the Ruport book up for community
contributions. It is licensed under the Creative Commons
Attribution-Sharealike license[0], so you are fairly unrestricted in
what you can do with it. Please enjoy, and feel free to discuss any
suggested changes or ideas you might have on the Ruport mailing list:
http://list.rubyreports.org

Though most of you are not likely to know Chenoa, I have been training
her in Ruby programming, and it's safe to say that this won't be her
only contribution to the Ruby community in general. So a big thanks
to her, and please enjoy the raw manuscript.

-greg

[0] http://creativecommons.org/licenses/by-sa/3.0/

 

[Gregory Brown]

Hmm I got some problems but with the adapted rakefile and new
manuscript/forward.txt I get 98 pages and 15 chapters, still having
some errors though.

Looks like we hardcoded the path for image generation. I won't be
able to look at this right away, but I'll check it out when I get a
chance.

Thanks for reporting this issue Robert.

-greg

 

[Rick DeNatale]

[Note: parts of this message were removed to make it a legal post.]

Looks like we hardcoded the path for image generation. I won't be
able to look at this right away, but I'll check it out when I get a
chance.

Thanks for reporting this issue Robert.

Hmmm, I tried myself on OS X Leopard, figuring I might be able to debug the
problem.

First I installed ascii doc using ports.

Then I discovered that I don't have dblatex which isn't available in
macports. I think that fink (which I've never used, and have no idea how it
plays with macports) has it, but I wasn't interested enough to pursue it.

Oh well.

 

[Gregory Brown]

Hmmm, I tried myself on OS X Leopard, figuring I might be able to debug the
problem.

Thanks for checking it out.

I know what's wrong, I just haven't had a chance to fix it. Currently
the images are prefaced with a full path to a directory in the
manuscript... we need to make them relative. I'll get to it when I
can.

As far as I know, the PDF will still build, it just might omit some of
the figures.

Then I discovered that I don't have dblatex which isn't available in
macports. I think that fink (which I've never used, and have no idea how it
plays with macports) has it, but I wasn't interested enough to pursue it.

I think I just built dblatex from source, after grabbing asciidoc
using macports.

 

[Gregory Brown]

I think I just built dblatex from source, after grabbing asciidoc
using macports.

Sorry, that was pretty ambiguous. I meant, I installed asciidoc
through macports and manually built dblatex.

-greg

 

[Robert Dober]

As far as I know, the PDF will still build, it just might omit some of
the figures.

98 pages, affirmative, I had not had any time looking into it though

 

[Rick DeNatale]

[Note: parts of this message were removed to make it a legal post.]

98 pages, affirmative, I had not had any time looking into it though

I got it to build, with images, and it's 103 pages.

That was a manual process though, I replaced all of the path prefixes for
the images in the manuscript/*.txt files with a hard-coded path prefix which
works for my machine.

It looks like there's some process which generates the manuscript/*.txt
files from the textile files, which we don't have. At least that's my
guess.

 

[Rick DeNatale]

[Note: parts of this message were removed to make it a legal post.]

I got it to build, with images, and it's 103 pages.

That was a manual process though, I replaced all of the path prefixes for
the images in the manuscript/*.txt files with a hard-coded path prefix
which
works for my machine.

It looks like there's some process which generates the manuscript/*.txt
files from the textile files, which we don't have. At least that's my
guess

As a follow-up, I forked the git hub repository and added two tasks to the
rake_file

rake fix_images will convert any hard coded image links in the manuscript
directory so that they
work on your local machine. They'll still be hard coded, but they will
be hard coded just for you!

rake convert_all will run ascii doc on all of the manuscript/*.txt files
rather than requiring each one
to be passed in as a command line arg.

http://github.com/rubyredrick/book/tree/master

Greg, feel free to pull these changes if you're happy with them.

 

[Gregory Brown]

As a follow-up, I forked the git hub repository and added two tasks to the
rake_file

rake fix_images will convert any hard coded image links in the manuscript
directory so that they
work on your local machine. They'll still be hard coded, but they will
be hard coded just for you!

rake convert_all will run ascii doc on all of the manuscript/*.txt files
rather than requiring each one
to be passed in as a command line arg.

http://github.com/rubyredrick/book/tree/master

Greg, feel free to pull these changes if you're happy with them.

Good stuff, I'll definitely pull in convert_all. I might try to find
a more suitable fix for the image stuff.

Thanks for looking into this. On a completely unrelated note: You
might want to rename your fork ruport-book or something, for less
ambiguity. I guess my trick of github.com/ruport/book has its
disadvantages. :-/

-greg

 

[Rick DeNatale]

[Note: parts of this message were removed to make it a legal post.]

Good stuff, I'll definitely pull in convert_all. I might try to find
a more suitable fix for the image stuff.

Thanks for looking into this. On a completely unrelated note: You
might want to rename your fork ruport-book or something, for less
ambiguity. I guess my trick of github.com/ruport/book has its
disadvantages. :-/

Okay the url is now
http://github.com/rubyredrick/ruport-book/tree/masterand the clone url
is now: git://
github.com/rubyredrick/ruport-book.git

Anyone who cloned it be warned, you'll want to do something like

git remote rm origin
git remote add origin git://github.com/rubyredrick/ruport-book.git

 

[Robert Dober]

Okay the url is now
http://github.com/rubyredrick/ruport-book/tree/masterand the clone url
is now: git://
github.com/rubyredrick/ruport-book.git

Anyone who cloned it be warned, you'll want to do something like

git remote rm origin
git remote add origin git://github.com/rubyredrick/ruport-book.git

Great job Rick! Just one question, would this patch for the Rakefile be useful?
------------------- 8< ---------------------
--- Rakefile 2009-02-09 01:03:27.000000000 +0100
+++ Rakefile.new 2009-02-09 01:09:37.000000000 +0100
@@ -1,6 +1,6 @@
task :default => [:build]

-task :build do
+task :build => :convert_all do
sh "export PATH=/opt/local/bin:$PATH"
sh "dblatex xml/book.xml -o book.pdf"
sh "open book.pdf"
@@ -12,7 +12,7 @@
sh "asciidoc -d book -b docbook -o xml/ch_#{basefile} -s #{ARGV[1]}"
end

-task :convert_all do
+task :convert_all => :fix_images do
targetDir = File.join(File.dirname(__FILE__), 'xml')
sh "export PATH=/opt/local/bin:$PATH"
FileList[File.join(File.dirname(__FILE__), 'manuscript',
'*.txt')].each do |src|
---------------- >8 ----------------------------

Cheers
Robert

 

[Gregory Brown]

Great job Rick! Just one question, would this patch for the Rakefile be useful?

Yeah I plan to do that

-greg

 

[Rick DeNatale]

[Note: parts of this message were removed to make it a legal post.]

useful?

Yeah I plan to do that

I actually had it that way at first, but decided to not change too much at
once.