search

ceylon / ceylon-spec

DEPRECATED
Apache License 2.0
108 stars 34 forks source link

Add Texinfo support #1408

Closed lucaswerkmeister closed 9 years ago

lucaswerkmeister commented 9 years ago

I wrote some XSLT stylesheets that transform the spec’s Docbook into Texinfo.

To test it, run:

ant -Dlang=en lang.docinfo.install

and then you can view the specification with

info ceylon-spec

or

emacs # open emacs
C-h i # open info directory
mCeylon # menu item Ceylon

We could also add Texinfo→HTML and Texinfo→PDF transformation, but that’s kinda pointless, since we already have those two formats, and the Texinfo version looks worse.

Note: this pull request also contains the commit from #1407 (closes #1407), since it’s required for this to work (all nodes need to have IDs).

quintesse commented 9 years ago

NB: for this to work you need to have makeinfo installed

lucaswerkmeister commented 9 years ago

Is that not installed by default on most Linuxes?

quintesse commented 9 years ago

It wasn't on mine (Fedora 21)

quintesse commented 9 years ago

btw to test I had to type info build/en/ceylon-spec

lucaswerkmeister commented 9 years ago

so you didn’t install it?

lucaswerkmeister commented 9 years ago

It wasn't on mine (Fedora 21)

seems to be part of the texinfo package on Debian and Arch, and in both distros that package seems to be part of the base distribution

quintesse commented 9 years ago

so you didn’t install it?

I ran the "ant" command just as you describe above

lucaswerkmeister commented 9 years ago 
ant -Dlang=en lang.docinfo.install

This one should install it in your global info directory. Needs sudo, install, install-info though.

quintesse commented 9 years ago

I don't think the "sudo" command got executed at all

quintesse commented 9 years ago

Does it ask you for credentials when you run that task?

lucaswerkmeister commented 9 years ago

yes

quintesse commented 9 years ago

Wtf? IT's because you put -Dlang.en in the command instead of -Dlang=en!

But then why does it even get to the doc generation?

lucaswerkmeister commented 9 years ago

…oops :D

sorry, but does it work with -Dlang=en?

quintesse commented 9 years ago

yup

lucaswerkmeister commented 9 years ago

ok good

I should probably do something in ceylon-dist too so that our published packages install the file as well.

quintesse commented 9 years ago

Although I'm thinking of just doing an <echo> of that install line, running sudo from a script without seeing what it is going to do is not something I normally like to do