Skip to content
This repository has been archived by the owner on Sep 24, 2020. It is now read-only.

Document DiCy vs arara and latexmk #89

Merged
merged 12 commits into from
Sep 20, 2017
Merged

Document DiCy vs arara and latexmk #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
815bc51
Add comparision doc
yitzchak Sep 18, 2017
a4e8f65
Add log parsing and configuration section
yitzchak Sep 18, 2017
6dd5314
Add rule comparison
yitzchak Sep 18, 2017
0f1ea69
Update for comparison doc
yitzchak Sep 18, 2017
897f1ba
Add missing arara link
yitzchak Sep 18, 2017
b72af16
Small tweaks
yitzchak Sep 19, 2017
087bc18
Make suggested changes
yitzchak Sep 20, 2017
971f088
Fix typos
yitzchak Sep 20, 2017
6147d1d
Update CHANGELOG
yitzchak Sep 20, 2017
a2be1c4
Fix wrapping
yitzchak Sep 20, 2017
272bd1c
Fix typo
yitzchak Sep 20, 2017
d59d6f2
Tweak some language
yitzchak Sep 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
### Added

- `pweaveKernel` option to specify Jupyter kernel \[[#83][]].
- Documentation comparing DiCy to latexmk and arara \[[#89][]]. Suggested and
edited by [@yudai-nkt][].

## [v0.9.1][] — 2017-09-04

Expand Down Expand Up @@ -184,6 +186,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).

[v0.1.0]: https://github.com/yitzchak/dicy/tree/v0.1.0

[#89]: https://github.com/yitzchak/dicy/pull/89

[#83]: https://github.com/yitzchak/dicy/pull/83

[#82]: https://github.com/yitzchak/dicy/pull/82
Expand Down Expand Up @@ -213,3 +217,5 @@ This project adheres to [Semantic Versioning](http://semver.org/).
[#23]: https://github.com/yitzchak/dicy/pull/23

[#21]: https://github.com/yitzchak/dicy/pull/21

[@yudai-nkt]: https://github.com/yudai-nkt
47 changes: 29 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,16 @@ a library use `npm install @dicy/core`. To install for command line access use
Basic usage of the Command Line interface and library can be found below. For
more detailed documentation please see the following pages.

- [Configuration][configuration]
- [Options][options]
- [Commands][commands]
- [Rules][rules]
- [Events][events]
- [Comparison of Builders][] — A comparision of DiCy to [arara][] and
[latexmk][].
- [Commands][] — The commands that can be passed to DiCy.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The terminology subcommand seems more common (e.g., google/subcommands, spf13/cobra, and maxogden/subcommand). So something like [Commands][] — A list of DiCy's subcommands is more simple.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only thing that I am probably not going to change right now even though I totally agree with you. Unfortunately I use the same terminology in the library API so I will need to do some code refactoring in order to change terminology. Therefore a separate PR will probably be needed.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the reason and agree that this should be a separate PR.

P.S. I really appreciate the built-in PythonTeX integration as I'll probably use PythonTeX in my thesis, which requires some add_cus_dep in latexmk. Thanks! 😄

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! Let me know how it goes with PythonTeX or anything else in regards to DiCy.

- [Configuration][] — How DiCy configures the build including the order of
configuration.
- [Options][] — The options that can be passed to DiCy from the command line,
the YAML option files, or TeX magic comments.
- [Events][] — The events emitted during a build. Only applicable when using
the library interface to DiCy.
- [Rules][] — A description of the rules used when executing a DiCy build.

## Command Line Usage

Expand Down Expand Up @@ -104,13 +109,17 @@ commands should always be `load` and `save`, respectively.

[appveyor]: https://ci.appveyor.com/project/yitzchak/dicy/branch/master

[arara]: https://ctan.org/pkg/arara

[asymptote]: http://asymptote.sourceforge.net/

[biber]: http://biblatex-biber.sourceforge.net/
[biber]: https://www.ctan.org/pkg/biber

[bibtex]: http://www.bibtex.org/

[bibtex8]: http://www.ctan.org/pkg/bibtex8bit
[bibtex8]: https://www.ctan.org/pkg/bibtex8bit

[comparison of builders]: https://yitzchak.github.io/dicy/comparison-of-builders

[commands]: https://yitzchak.github.io/dicy/commands

Expand All @@ -124,15 +133,15 @@ commands should always be `load` and `save`, respectively.

[devdependency]: https://david-dm.org/yitzchak/dicy?type=dev

[dvipdfm]: http://www.ctan.org/pkg/dvipdfm
[dvipdfm]: https://www.ctan.org/pkg/dvipdfm

[dvipdfmx]: http://project.ktug.org/dvipdfmx/

[dvips]: http://www.tug.org/texinfohtml/dvips.html

[dvisvgm]: http://dvisvgm.bplaced.net/

[epstopdf]: http://www.ctan.org/pkg/epstopdf
[epstopdf]: https://www.ctan.org/pkg/epstopdf

[events]: https://yitzchak.github.io/dicy/events

Expand All @@ -144,6 +153,8 @@ commands should always be `load` and `save`, respectively.

[latex]: https://www.latex-project.org/

[latexmk]: https://ctan.org/pkg/latexmk

[lhs2tex]: http://www.andres-loeh.de/lhs2tex/

[literate agda]: http://wiki.portal.chalmers.se/agda/pmwiki.php?n=Main.LiterateAgda
Expand All @@ -152,9 +163,9 @@ commands should always be `load` and `save`, respectively.

[lualatex]: http://www.luatex.org/

[makeglossaries]: http://www.ctan.org/pkg/glossaries
[makeglossaries]: https://www.ctan.org/pkg/glossaries

[makeindex]: http://www.ctan.org/pkg/makeindex
[makeindex]: https://www.ctan.org/pkg/makeindex

[mendex]: https://www.ctan.org/pkg/mendex

Expand All @@ -164,25 +175,25 @@ commands should always be `load` and `save`, respectively.

[patchsynctex]: https://cran.r-project.org/package=patchSynctex

[pbibtex]: http://www.ctan.org/pkg/pbibtex-base
[pbibtex]: https://www.ctan.org/pkg/pbibtex-base

[pdf2ps]: http://linux.die.net/man/1/pdf2ps

[pdflatex]: http://www.tug.org/applications/pdftex/

[platex]: http://www.ctan.org/pkg/platex
[platex]: https://www.ctan.org/pkg/platex

[ps2pdf]: http://ghostscript.com/doc/current/Ps2pdf.htm

[pweave]: https://github.com/mpastell/Pweave

[pythontex]: http://www.ctan.org/pkg/pythontex
[pythontex]: https://www.ctan.org/pkg/pythontex

[rules]: https://yitzchak.github.io/dicy/rules

[sagetex]: http://www.ctan.org/tex-archive/macros/latex/contrib/sagetex/
[sagetex]: https://www.ctan.org/tex-archive/macros/latex/contrib/sagetex/

[splitindex]: http://www.ctan.org/pkg/splitindex
[splitindex]: https://www.ctan.org/pkg/splitindex

[texindy]: http://xindy.sourceforge.net/

Expand All @@ -192,8 +203,8 @@ commands should always be `load` and `save`, respectively.

[upbibtex]: http://www.t-lab.opal.ne.jp/tex/uptex_en.html

[uplatex]: http://www.ctan.org/pkg/uplatex
[uplatex]: https://www.ctan.org/pkg/uplatex

[upmendex]: http://www.ctan.org/pkg/upmendex
[upmendex]: https://www.ctan.org/pkg/upmendex

[xelatex]: http://xetex.sourceforge.net/
46 changes: 30 additions & 16 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,16 @@ a library use `npm install @dicy/core`. To install for command line access use
Basic usage of the Command Line interface and library can be found below. For
more detailed documentation please see the following pages.

- [Configuration][configuration]
- [Events][events]
- [Options][options]
- [Rules][rules]
- [Comparison of Builders][] — A comparision of DiCy to [arara][] and
[latexmk][].
- [Commands][] — The commands that can be passed to DiCy.
- [Configuration][] — How DiCy configures the build including the order of
configuration.
- [Options][] — The options that can be passed to DiCy from the command line,
the YAML option files, or TeX magic comments.
- [Events][] — The events emitted during a build. Only applicable when using
the library interface to DiCy.
- [Rules][] — A description of the rules used when executing a DiCy build.

## Command Line Usage

Expand Down Expand Up @@ -91,32 +97,40 @@ commands should always be `load` and `save`, respectively.

[agda]: http://wiki.portal.chalmers.se/agda/pmwiki.php

[arara]: https://ctan.org/pkg/arara

[asymptote]: http://asymptote.sourceforge.net/

[biber]: http://biblatex-biber.sourceforge.net/

[bibtex]: http://www.bibtex.org/

[bibtex8]: http://www.ctan.org/pkg/bibtex8bit
[bibtex8]: https://www.ctan.org/pkg/bibtex8bit

[comparison of builders]: https://yitzchak.github.io/dicy/comparison-of-builders

[commands]: https://yitzchak.github.io/dicy/commands

[configuration]: https://yitzchak.github.io/dicy/configuration

[dvipdfm]: http://www.ctan.org/pkg/dvipdfm
[dvipdfm]: https://www.ctan.org/pkg/dvipdfm

[dvipdfmx]: http://project.ktug.org/dvipdfmx/

[dvips]: http://www.tug.org/texinfohtml/dvips.html

[dvisvgm]: http://dvisvgm.bplaced.net/

[epstopdf]: http://www.ctan.org/pkg/epstopdf
[epstopdf]: https://www.ctan.org/pkg/epstopdf

[events]: https://yitzchak.github.io/dicy/events

[knitr]: https://yihui.name/knitr/

[latex]: https://www.latex-project.org/

[latexmk]: https://ctan.org/pkg/latexmk

[lhs2tex]: http://www.andres-loeh.de/lhs2tex/

[literate agda]: http://wiki.portal.chalmers.se/agda/pmwiki.php?n=Main.LiterateAgda
Expand All @@ -125,9 +139,9 @@ commands should always be `load` and `save`, respectively.

[lualatex]: http://www.luatex.org/

[makeglossaries]: http://www.ctan.org/pkg/glossaries
[makeglossaries]: https://www.ctan.org/pkg/glossaries

[makeindex]: http://www.ctan.org/pkg/makeindex
[makeindex]: https://www.ctan.org/pkg/makeindex

[mendex]: https://www.ctan.org/pkg/mendex

Expand All @@ -137,32 +151,32 @@ commands should always be `load` and `save`, respectively.

[patchsynctex]: https://cran.r-project.org/package=patchSynctex

[pbibtex]: http://www.ctan.org/pkg/pbibtex-base
[pbibtex]: https://www.ctan.org/pkg/pbibtex-base

[pdf2ps]: http://linux.die.net/man/1/pdf2ps

[pdflatex]: http://www.tug.org/applications/pdftex/

[platex]: http://www.ctan.org/pkg/platex
[platex]: https://www.ctan.org/pkg/platex

[ps2pdf]: http://ghostscript.com/doc/current/Ps2pdf.htm

[pweave]: https://github.com/mpastell/Pweave

[pythontex]: http://www.ctan.org/pkg/pythontex
[pythontex]: https://www.ctan.org/pkg/pythontex

[rules]: https://yitzchak.github.io/dicy/rules

[sagetex]: http://www.ctan.org/tex-archive/macros/latex/contrib/sagetex/
[sagetex]: https://www.ctan.org/tex-archive/macros/latex/contrib/sagetex/

[splitindex]: http://www.ctan.org/pkg/splitindex
[splitindex]: https://www.ctan.org/pkg/splitindex

[texindy]: http://xindy.sourceforge.net/

[upbibtex]: http://www.t-lab.opal.ne.jp/tex/uptex_en.html

[uplatex]: http://www.ctan.org/pkg/uplatex
[uplatex]: https://www.ctan.org/pkg/uplatex

[upmendex]: http://www.ctan.org/pkg/upmendex
[upmendex]: https://www.ctan.org/pkg/upmendex

[xelatex]: http://xetex.sourceforge.net/
Loading