CTAN Comprehensive TeX Archive Network

Direc­tory support/arara

README.md
arara

arara

Version: 4.0Revision: 1Language: JavaMinimum JRE: 5.0

License: New BSDCTAN packaging: 4.0.5

arara is a au­toma­tion tool based on rules and di­rec­tives. It gives you a way to en­hance your ex­pe­ri­ence. The tool is an ef­fort to pro­vide a con­cise way to au­to­mate the daily work­flow for users and also pack­age writ­ers. Users might write their own rules when the pro­vided ones do not suf­fice.

Ba­sic use

To use arara, you need to tell it what to do. Un­like most other tools, you give arara these di­rec­tives in the doc­u­ment it­self – usu­ally near the top. So to run pdflatex once on your doc­u­ment, you should say some­thing like:

% arara: pdflatex
\documentclass{article}
\begin{document}
Hello, world!
\end{document}

Now when you run arara myfile, that di­rec­tive (% arara: ...) will be seen and car­ried out as de­scribed by the pdflatex rule. You can read more about rules and di­rec­tives in the user man­ual avail­able in our re­leases sec­tion. In ad­di­tion to doc­u­ment­ing all of the rules that come stan­dard with arara, the man­ual gives a de­tailed ex­pla­na­tion of how arara works, as well as how to cre­ate and use your own rules.

Ver­sions

Current version: 4.0Development version: 5.0

The sta­ble ma­jor ver­sion of arara is the 4.0 se­ries (note that re­vi­sion num­bers may vary). Please re­fer to the de­vel­op­ment branch for more in­for­ma­tion on the up­com­ing 5.0 se­ries re­lease. The mas­ter branch al­ways refers to the sta­ble ver­sion (in­clud­ing po­ten­tial re­vi­sions). The CTAN pack­ag­ing for the cur­rent ver­sion is 4.0.3 (for in­ter­nal use).

For his­tor­i­cal pur­poses, the source code for older ver­sions of arara is avail­able in the re­leases sec­tion of our repos­i­tory. How­ever, be mind­ful that these ver­sions are un­sup­ported.

Build sta­tus

Version: 4.0Travis CI for 4.0

Version: 5.0Travis CI for 5.0

arara uses Travis CI as a hosted con­tin­u­ous in­te­gra­tion ser­vice. For each and ev­ery com­mit, we can see in real time the build sta­tus of our ap­pli­ca­tion checked against a range of Java VM ven­dors. It is worth not­ing that the cur­rent se­ries is de­signed and built to be Java 5.0 com­pli­ant, so if you have an old JVM, it is al­most sure that you will be able to run arara in it with­out any prob­lems.

Sup­port

Gitter chatroom GitHub issues

We use a Git­ter cha­t­room for dis­cussing things re­lated to arara. You are more than wel­come to come join the fun and say hi! to us. We also have the is­sues sec­tion in our repos­i­tory as a valid chan­nel to re­port prob­lems, bugs and sug­gest im­prove­ments.

Lo­cal­iza­tion

Would you like to make arara speak your own lan­guage? Splen­did! We would love to have you in the team! Just send us an e-mail, join our ded­i­cated cha­t­room or open an is­sue about it. The lo­cal­iza­tion pro­cess is quite straight­for­ward, we can help you! Any lan­guage is wel­come!

A big thanks to our trans­la­tors Marco Daniel, Cle­mens Nieder­berger, Ul­rike Fis­cher, Gert Fis­cher, En­rico Gre­go­rio and Mar­ijn Schraa­gen for the awe­some lo­cal­iza­tion work!

Down­loads

Download from GitHub Download from Bintray

From the 4.0 se­ries on, the team de­cided to not re­lease cross-plat­form in­stallers any more. Our tool is avail­able out of the shelf on all ma­jor dis­tri­bu­tions, in­clud­ing Live and MiK, which makes man­ual in­stal­la­tion un­nec­es­sary given the sig­nif­i­cant cov­er­age of such dis­tri­bu­tions. Chances are you al­ready have arara in your sys­tem!

You can ob­tain the of­fi­cial pack­age avail­able in the re­leases sec­tion of our project repos­i­tory, as well as the Bin­tray soft­ware dis­tri­bu­tion ser­vice. Please re­fer to the doc­u­men­ta­tion on how to man­u­ally de­ploy our tool.

Li­cense

This ap­pli­ca­tion is li­censed un­der the New BSD Li­cense. Please note that the New BSD Li­cense has been ver­i­fied as a GPL-com­pat­i­ble free soft­ware li­cense by the Free Soft­ware Foun­da­tion, and has been vet­ted as an open source li­cense by the Open Source Ini­tia­tive.

The team

arara, the cool au­toma­tion tool, is brought to you by Paulo Cereda, Marco Daniel, Brent Long­bor­ough and Ni­cola Tal­bot. If you want to sup­port de­vel­op­ment by a do­na­tion, the best way to do this is do­nat­ing to the Users Group.

Down­load the con­tents of this pack­age in one zip archive (6.9M).

arara – Au­toma­tion of com­pi­la­tion

Arara is com­pa­ra­ble with other well-known com­pi­la­tion tools like la­texmk and rub­ber. The key dif­fer­ence is that arara de­ter­mines its ac­tions from meta­data in the source code, rather than re­ly­ing on in­di­rect re­sources, such as log file anal­y­sis.

Arara re­quires a Java vir­tual ma­chine.

Pack­agearara
Sup­porthttps://git­ter.im/cereda/arara
Bug trackerhttps://github.com/cereda/arara/is­sues
Re­pos­i­toryhttps://github.com/cereda/arara
Ver­sion4.0.5
Li­censesBSD Style Li­cense
Copy­right2012–2018 Paulo Roberto Massa Cereda
Main­tainerPaulo Roberto Massa Cereda
TDS archivearara.tds.zip
Con­tained inTeX Live as arara
MiKTeX as arara
TopicsCom­pi­la­tion
...
Guest Book Sitemap Contact Contact Author