Papyrus 0.0.1 released

Ruby
1

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi there,

I’m pleased to announce the very first release of Papyrus, a RDoc plugin
for generating PDF files from your sourcecode’s documentation.

== Installation

It’s available via RubyGems. Do

gem install papyrus

to get it.

== Usage

You can use it the same way as any other RDoc generator plugin, namely

$ rdoc -f papyrus YOURFILESHERE

You can also use it in Rake tasks if you want;

gem “rdoc” #Note you need the gem!
require “rdoc/task”
RDoc::Task.new do |t|
t.generator = “papyrus”
#…
end

== Websites

== License

It’s licensed under the GPLv2, see COPYING in the source for more
information.

== Thanks

Thanks to Eric H.'s invaluable help–without him, Papyrus wouldn’t
have made it to this release.

Have fun!

Valete,
Marvin
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJOTDaeAAoJELh1XLHFkqhaJ8oH/idZWa6DNWQ9xXF0dmeYKkPd
nih1zRLh9G8Zv2uqT7eYce1tcusaszDjKQyR0hq2GwCZ2/VzDkqvpvK1irnrY1T8
W0Qawu1KFkXtXZFyh1yXWMiWcs0BXvacNp8ZboBvnxjJrtMPt6JqyBbB/meWbLki
xvHdpLawFlyjsG9Kc0l5Qk9DdRfEoJPUslQfpZDnlD1pZ4AIDVagiW1yEPVG/0Y+
9MU7Sd/sd+baxWsUYt5y/PzGP0ruriBbwZwTJsx2jZS3/+UdcFQSq/oYynUTOCT+
yBHkUfq/M/ZHpMRk5rkYeTr464Mlvb1h9QDzc0DXh6gDdHXBFTPzHrz/GaC3VYM=
=99Zp
-----END PGP SIGNATURE-----

2

On Wed, Aug 17, 2011 at 4:47 PM, Quintus [email protected] wrote:

It’s available via RubyGems. Do

Marvin
=99Zp
-----END PGP SIGNATURE-----

“sh: pdflatex: command not found
Invoking pdflatex failed with exitstatus 127!”

I’m not sure how to get this. I tried brew install tex and it sent me
to
http://www.tug.org/mactex/2011/ which is apparently 1.8GB zipped. Too
much
commitment for me, I just want to try it out.

Then I tried dling and installing pdftex (
pdfTeX - TeX Users Group) per the man page’s suggestion (
Linux Manpages Online - man.cx manual pages) which I thought worked, but apparently
not
since there is no pdflatex in my path still, nor anywhere within the dir
I
constructed it in, nor within the original source dirs.

I feel like I might be missing something obvious, what am I doing wrong?

3

On Aug 18, 2011, at 12:45 AM, Josh C. wrote:

== Installation

It’s licensed under the GPLv2, see COPYING in the source for more

9MU7Sd/sd+baxWsUYt5y/PzGP0ruriBbwZwTJsx2jZS3/+UdcFQSq/oYynUTOCT+
http://www.tug.org/mactex/2011/ which is apparently 1.8GB zipped. Too much
commitment for me, I just want to try it out.

Tex is a typesetting system, so it comes with a lot of fonts, styles,
etc.
Hence the bit download for the full distribution. Basically its all
packages
that were ever accepted into the tex package system.

The Tex community values “write once, compile anywhere, even 10 years in
the
future”, so they ensure that the main distributions hold everything.

Then I tried dling and installing pdftex (
pdfTeX - TeX Users Group) per the man page’s suggestion (
Linux Manpages Online - man.cx manual pages) which I thought worked, but apparently not
since there is no pdflatex in my path still, nor anywhere within the dir I
constructed it in, nor within the original source dirs.

Thats too basic, as it only includes the typesetting system and nothing
else :).
You would not want to download all the packages on your own :).

I feel like I might be missing something obvious, what am I doing wrong?

Yes:

http://www.tug.org/mactex/2011/morepackages.html

Has a “BasicTex” package for 69MB. I don’t know whether papyrus uses
extra-fancy stuff, but
from a short glance it doesn’t. As the page correctly says: “The package
is remarkably capable.”,
so it should work.

If it doesn’t work with BasicTex, I recommend writing a bug report to
the author :).

Regards,
Florian

–
Florian G.

smtp: [email protected]
jabber: [email protected]
gpg: 533148E2

4

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Am 18.08.2011 09:50, schrieb Florian G.:

http://www.tug.org/mactex/2011/morepackages.html

Has a “BasicTex” package for 69MB. I don’t know whether papyrus uses
extra-fancy stuff, but from a short glance it doesn’t. As the page
correctly says: “The package is remarkably capable.”, so it should
work.

If it doesn’t work with BasicTex, I recommend writing a bug report to
the author :).

As I already stated, I can’t be of much help on OS X, but for the record
here are the LaTeX packages that Papyrus makes use of:

  • LaTeX itself.
  • babel
  • inputenc
  • fontenc
  • lmodern
  • textcomp
  • eurosym [Loaded, but not used yet]
  • lastpage
  • geometry
  • fancyhdr
  • fancyvrb
  • longtable
  • xcolor
  • titlesec
  • titletoc
  • hyperref

If any of these is missing, Papyrus will fail with a “Invoking pdflatex
failed with exitstatus XY” exception. To get more detailed output, you
can run rdoc with the --debug switch, but this can be a mess as it gives
you the full output pdflatex produces during all three runs. Furthermore
you can examine the generated .tex files in the tmp/ subdirectory of
doc/ (or whereever you generate the output into) if Papyrus crashes.

Regards, Florian

Valete,
Marvin
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJOTOdUAAoJELh1XLHFkqha/FIH/2B7ysAMvocjm6myauBTCln2
GNRUcs//kYqKfeR/dXysypXVlVxQ+v27xRevGiOCg3v93KKro1j4aV1oG1UNzYGP
C+rXhWtB+BA5h/2A7h4lBt8C0JO8r41eQy8XaUqhFn0b2WPObGfVrtWyK69OYRiS
Uj8LMFY3X7xwdlSNAc95iqAV3rBjFPXOCszAmt8BdNwspFydALF82KENEugaIqIi
OCJ/thgXHJWiB8OfnXsADLYRgUrF1/SSM2SA5E3beYmxYNP+3vTmi+ke0Mv7OEwb
S3K1A6L5N929sjJF7vg8MvHuydzFbe/LunRKtl0ER2NVX3Hk18vFW62d+ONJiSM=
=kXR1
-----END PGP SIGNATURE-----

5

On Aug 18, 2011, at 12:20 PM, Quintus wrote:

wrong?

  • lmodern
  • hyperref
    The problem is less that I don’t know what packages you use. The problem
    is
    that I am a heavy TeX user and always have the full package installed.
    So I
    cannot tell you for sure whether all those packages are included in
    BasicTex.

Also, MacTex corresponds to TexLive but with more OS X integrations (a
special
editor etc.). OtherSo BasicTex is a texlive distribution for OS X that
installs
a minimal profile.

In my experience, MacTex does not differ from texlive. It comes with
everything
you expect (tlmgr, etc.) and doesn’t change anything on his own.

Regards,
Florian

6

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Am 18.08.2011 00:45, schrieb Josh C.:

Then I tried dling and installing pdftex (
pdfTeX - TeX Users Group) per the man page’s
suggestion ( Linux Manpages Online - man.cx manual pages) which I thought worked,
but apparently not since there is no pdflatex in my path still, nor
anywhere within the dir I constructed it in, nor within the original
source dirs.

I feel like I might be missing something obvious, what am I doing
wrong?

Hi Josh,

I can’t help with OS X-specific issues as I don’t have one–I’m using
Arch Linux and TeX Live as my LaTeX distribution, just installed via

pacman -S texlive-full

I’m not sure how to get this. I tried brew install tex and it sent
me to http://www.tug.org/mactex/2011/ which is apparently 1.8GB
zipped. Too much commitment for me, I just want to try it out.

Yeah, if one doesn’t have LaTeX installed, it looks really heavy, it’s
one of the biggest softwares I’m aware of. It is however incredibily
powerful you should really have a look at it aside form Papyrus.

Then I tried dling and installing pdftex (

It seems you’re running into the difference between TeX and LaTeX. LaTeX
is a macro package atop of TeX, and usually doing plain TeX is
considered lowlevel when dealing with LaTeX as most people do. Maybe
someone using a Mac can comment on this? I’ll put something up in
Papyrus’ wiki then.

If you want to have a glance on the output it produces, download

http://redmine.pegasus-alpha.eu/attachments/3/Documentation.pdf

. This is Papyrus’ own documentation generated with Papyrus itself.

Vale,
Marvin
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJOTMW5AAoJELh1XLHFkqha8m0H/R1Jr2pPFdrUKUvRjuDabic1
aopw13TIS4/8I2jnVkhkRtdY3xGrEuoerBXgXFK1vXadEVzvOyCj9GaM63bDa+uj
tq5BVslCpuz0Nyqix25uq2H+kP+wwP58ijhSQFI/XyI3vTQxSpKZRvsgNEFOPyhh
7Wdb0h7kV6xpFw10B7CvknkBkd8nrnuZeSJRrrjChHp3SqkST92QoGiSlaAdJYvR
vKmRJ5l5a6ngJWFVoDp0imGwoNU8/iSGjplOyIskh6XGsinizAb/UV0qLKBu6oiH
94bhrsyL8+egkQeQ7sq0qgC7Kv4ZNgX1FU1KIgQ1t6EeXWdv2wEMlukWbyl1p24=
=kPj7
-----END PGP SIGNATURE-----

7

On Thu, Aug 18, 2011 at 2:50 AM, Florian G.
[email protected]wrote:

remarkably capable.",
so it should work.

If it doesn’t work with BasicTex, I recommend writing a bug report to the
author :).

Thanks. I installed this, now it’s failing with status of 1

“uh-oh! RDoc had a problem:
Invoking pdflatex failed with exitstatus 1!”

I assume that means I’m missing packages, but don’t really know.

8

On Thu, Aug 18, 2011 at 11:25 AM, Quintus [email protected] wrote:

Pass the --debug option to RDoc and post the output (but please not
inside the email, use pastie or something like that–you’ll get pages).

It looks like this is the issue:

“! LaTeX Error: File `lmodern.sty’ not found.”

Which seems to be a font called Latin Modern. IDK how the LaTeX
community
distributes / installs these things, though.

9

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Am 18.08.2011 18:08, schrieb Josh C.:

Thanks. I installed this, now it’s failing with status of 1

“uh-oh! RDoc had a problem: Invoking pdflatex failed with exitstatus
1!”

I assume that means I’m missing packages, but don’t really know.

Pass the --debug option to RDoc and post the output (but please not
inside the email, use pastie or something like that–you’ll get pages).

Vale,
Marvin
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJOTTxiAAoJELh1XLHFkqhabJEH/RDqBIwPxg15qxeOhEGfQDxv
pw2zZldXId5yhUVR3HVVvS+KDrieu0tPp/FInatZQPWoM7CLzaUT9cmHAfds93f+
35aK15qZj46DueJjORCWRQS6SL1kGwlnKPTK8ZrG9jS7FjS/+DhMRKvwqsVjeGa/
cJqmfVkCc/ztK9e8V7Do/46RDeRKmcvY44nztMWZ4ypmFRz96I7JP2VjLd/st/PI
ttOQPic5hIpSJ/VT83ockhBAML5SDHOc4cjP0yiIlaiJpBedIpXOZ//o5c/xPx4e
93bjm3DbMbWdVMtLWEvwn8Aqk6TGu/9+Y/YceFEyRlHMNkREpDeNFqVLibp70/o=
=xLuK
-----END PGP SIGNATURE-----

10

On Thu, Aug 18, 2011 at 12:49 PM, Josh C. [email protected]
wrote:

“! LaTeX Error: File `lmodern.sty’ not found.”

Which seems to be a font called Latin Modern. IDK how the LaTeX community
distributes / installs these things, though.

http://mirror.hmc.edu/ctan/fonts/lm.zip

http://www.tug.org/fonts/fontinstall.html
TeX Live and MacTeX
From a system terminal (aka command prompt, shell window) enter
the command kpsewhich --var-value TEXMFLOCAL to see the directory
name. The default on Unix is (the perhaps unusual-looking)
/usr/local/texlive/2010/…/texmf-local, which is just another way of
writing /usr/local/texlive/texmf-local. The year may vary, of course.
After determining your local tree for installation (see previous
section), the next step is to copy the new files into subdirectories
of that tree. Hopefully, your new font came as a zip or other archive
file that is already arranged according to the standard TeX Directory
Structure (TDS). If this is the case, you can simply unpack it at the
top level of your chosen tree.
Run the command mktexlsr (the command texhash is a synonym). On
Unix-like systems, run sudo -H mktexlsr if you installed your system
as root (not recommended).
Run the command:
updmap-sys --enable Map newfont.map

11

On Aug 18, 2011, at 7:00 PM, [email protected] wrote:

the command kpsewhich --var-value TEXMFLOCAL to see the directory
Unix-like systems, run sudo -H mktexlsr if you installed your system
as root (not recommended).
Run the command:
updmap-sys --enable Map newfont.map

If I can make some suggestions:

a) Throw out the font and use a basic font. Package installation,
especially
font installation for TeX comes straight from the 1970s and is
appropriately
ugly.
b) Use XeTeX instead of PDFLaTeX. In my experience, it provides better
output anyways,
despite some oddball packages being incompatible with it[1]. It also has
built-in UTF-8
support. XeTeX has access to system fonts and an easy macro set to
specify them. So you
can pick a nice font that is present on all platforms and just use it.

Regards,
Florian

[1]: Mostly because they check the ability of PDF output by checking
whether they run
on PDFLatex. Kind of similar to gems not running on jruby because they
check on a MRI
version string.

–
Florian G.

smtp: [email protected]
jabber: [email protected]
gpg: 533148E2