Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the interaction between LaTeX-Workshop and arara #2139

Closed
BambOoxX opened this issue Jun 4, 2020 · 1 comment
Closed

Document the interaction between LaTeX-Workshop and arara #2139

BambOoxX opened this issue Jun 4, 2020 · 1 comment
Labels
question Issue represents a question

Comments

@BambOoxX
Copy link

BambOoxX commented Jun 4, 2020

Is your feature request related to a problem? Please describe.

This feature request is related to #1996 (now closed and locked, so I could not add this proposal in there), where some issues between the ways arara and LaTeX-Workshop behave have been pointed out.
These issues are :

  • Compilations started with arara without the --verbose option are not in interactive mode, but do not show error/warning logging that could be parsed by LaTeX-Workshop, And with --verbose option show the logging, but may lead to hidden zombie child processes in case of a compilation fail.
  • Due to the way LaTeX-Workshop parses error / warning logging, some compilation options are added to the user-defined options e.g. with the pdflatex recipe, but not with arara since the "args": field cannot pass the same instruction on the fly to arara.

In order to help newcomers to LaTex-Workshop (as myself) to setup their compilation process easily, I propose to document these observations in the Wiki, so other people do not ask the same question over and over again.
Also (see below), I propose a set of customized arara rules for LaTeX-Workshop, so that everything works (mostly) out-of-the-box

Describe alternatives you've considered
In order to avoid using additional options to the default arara rules, e.g.

% arara: pdflatex: {
% arara: --> interaction: nonstopmode,
% arara: --> options: ['-file-line-error','-max-print-line=200'],
% arara: --> synctex: yes,
% arara: --> }

in each document, I propose the following process :

  1. Define a araraconfig.yaml file placed in the user home to configure arara to look for user-defined rules, where araraconfig.yaml is
!config
paths:
- absolute/path/to/my/custom/arara/rules
  1. Place the following lwpdflatex.yaml rule and potentially others (but I mostly use pdflatex) in the absolute/path/to/my/custom/arara/rules directory
!config
# arara configuration file compatible with LaTeX-Workshop behavior
# based on the original pdflatex rule
# requires arara 5.1.3+
identifier: lwpdflatex
name: PDFLaTeX
authors:
- BambOoxX (https://github.com/BambOoxX)
commands:
- name: PDFLaTeX engine with LaTeX-Workshop presets
  command: >
    @{
        return getCommand('pdflatex', '-interaction=nonstopmode', '-synctex=1','-file-line-error','-max-print-line=200',reference.getName());
    }
  1. When compiling the document, the new rule becomes :
% arara: lwpdflatex

Additional context

As I did for #1996 , I will also discuss this topic with the developpers of arara to see if they would be willing to document this on their side, or even to ship such specific rules with arara itself.

In any case, keep up the good work, this software is very nice !

@BambOoxX BambOoxX added the feature request Feature request label Jun 4, 2020
@tamuratak tamuratak removed the feature request Feature request label Jun 4, 2020
@tamuratak
Copy link
Contributor

You can contribute. https://github.com/jlelong/LaTeX-Workshop-wiki

Repository owner locked as resolved and limited conversation to collaborators Jun 6, 2020
@tamuratak tamuratak added the question Issue represents a question label Mar 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
question Issue represents a question
Projects
None yet
Development

No branches or pull requests

2 participants