Update Documentation for v0.42.0 (#326)

* Update README for build settings file and Zathura * CHANGELOG updaes * Version bump
thomasjo · Jan 2, 2017 · 68c3c21 · 68c3c21
1 parent 0a68913
commit 68c3c21
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,23 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.42.0] / 2017-01-02
+### Added
+- Magic comment override of `cleanExtensions`, `enableSynctex`,
+  `enableShellEscape`, `enableExtendedBuildMode` and
+  `moveResultToSourceDirectory`.
+- Output directory and job name support in knitr SyncTeX patching.
+- Support for Zathura PDF/PS viewer.
+- Override of build settings via YAML formatted build setting file.
+
+### Changed
+- Use commas as delimiters in `jobnames` magic comment.
+
+### Removed
+- Deprecated `texify` builder in favor of `latexmk` builder.
+- Unneeded `builder` magic comment.
+- `Use Master File Search` setting and algorithm in favor of `root` magic comment.
+
 ## [0.41.0] / 2016-11-17
 ### Fixed
 - Parsing of FDB files is more rigorous resulting in correct output path
@@ -541,6 +558,7 @@ minor release.
 - First release.
 
 <!--- refs --->
+[0.42.0]: https://github.com/thomasjo/atom-latex/compare/v0.41.0...v0.42.0
 [0.41.0]: https://github.com/thomasjo/atom-latex/compare/v0.40.0...v0.41.0
 [0.40.0]: https://github.com/thomasjo/atom-latex/compare/v0.39.1...v0.40.0
 [0.39.1]: https://github.com/thomasjo/atom-latex/compare/v0.39.0...v0.39.1

diff --git a/README.md b/README.md
@@ -65,24 +65,36 @@ The `latex` package supports other commands as detailed in the table below.
 | `latex:sync-log`      | None                                        | Display and highlight log messages from the current cursor position.     |
 | `latex:check-runtime` | None                                        | Check for the existence of `latexmk`, `Rscript` and PDF/PS/DVI viewers.  |
 
-### Magic comments
-This package has support for various "magic" TeX comments in the form of
-`% !TEX <name> = <value>` as detailed in the table below.
-
-| Name               | Value                                         | Use                                               |
-|:-------------------|:----------------------------------------------|:--------------------------------------------------|
-| `format`           | `dvi`, `ps` or `pdf`                          | Override the output format                        |
-| `jobnames`         | space separated names, e.g. `foo bar`         | Control the number and names of build jobs.       |
-| `output_directory` | directory path, e.g. `build`                  | Specify the output directory that should be used. |
-| `producer`         | `dvipdf`, `dvipdfmx`, `xdvipdfmx` or `ps2pdf` | Override the PDF producer                         |
-| `program`          | `pdflatex`, `lualatex`, etc.                  | Override the LaTeX engine to use for build.       |
-| `root`             | file path, e.g. `../file.tex`                 | Specify the root file that should be built.       |
+### Overriding Build settings
+Many of the build settings in the settings page of the `latex` package can be
+overridden on a per file basis. One way to override specific build settings is
+to use "magic" TeX comments in the form of `% !TEX <name> = <value>`. Another
+way is to use a [YAML] formatted file with the same name as your root LaTeX
+file, but with an extension of `.yaml`. The settings and values that can
+overridden via either method are listed in the table below. If multiple setting
+names are listed then the first is preferred and following names are available
+for compatibility. More details can found at [Overridding Build Settings].
+
+| Name                                    | Value                                          | Use                                                                                       |
+|:----------------------------------------|:-----------------------------------------------|:------------------------------------------------------------------------------------------|
+| `cleanPatterns`                         | comma separated patterns, e.g. `**/*.blg, foo` | Specify patterns to use for `latex:clean`                                                 |
+| `enableSynctex`                         | `yes`, `no`, `true` or `false`                 | Override SyncTeX setting                                                                  |
+| `enableExtendedBuildMode`               | `yes`, `no`, `true` or `false`                 | Override extended build mode setting                                                      |
+| `enableShellEscape`                     | `yes`, `no`, `true` or `false`                 | Override shell escape setting                                                             |
+| `engine` or `program`                   | `pdflatex`, `lualatex`, etc.                   | Override the LaTeX engine to use for build.                                               |
+| `moveResultToSourceDirectory`           | `yes`, `no`, `true` or `false`                 | Override move result to source directory setting                                          |
+| `outputFormat` or `format`              | `dvi`, `ps` or `pdf`                           | Override the output format                                                                |
+| `jobNames`, `jobnames` or `jobname`     | comma separated names, e.g. `foo, bar`         | Control the number and names of build jobs. Only a single name can be used for `jobname`. |
+| `outputDirectory` or `output_directory` | directory path, e.g. `build`                   | Specify the output directory that should be used.                                         |
+| `producer`                              | `dvipdf`, `dvipdfmx`, `xdvipdfmx` or `ps2pdf`  | Override the PDF producer                                                                 |
+| `root`                                  | file path, e.g. `../file.tex`                  | Specify the root file that should be built. Only available via "magic" TeX comments.      |
 
 ### PDF/DVI/PS Viewers
 The `latex` package currently supports [Atril], [Evince], [Okular], [pdf-view],
-[Preview], [Skim], [Sumatra PDF], Windows shell open, [xdg-open] and [Xreader] as PDF/DVI/PS viewers. This
-includes support for cursor synchronization via SyncTeX if possible. Specific
-features of each of the viewers is detailed at [Supported Viewers].
+[Preview], [Skim], [Sumatra PDF], Windows shell open, [xdg-open], [Xreader] and
+[Zathura] as PDF/DVI/PS viewers. This includes support for cursor
+synchronization via SyncTeX if possible. Specific features of each of the
+viewers is detailed at [Supported Viewers].
 
 ## Development status
 Please note that this package is in a **beta** state. It is stable, but lacks
@@ -104,6 +116,7 @@ Any and all help is greatly appreciated!
 [latexmk with MiKTeX]: https://github.com/thomasjo/atom-latex/wiki/Using-latexmk-with-MiKTeX
 [MiKTeX]: http://miktex.org/
 [Okular]: https://okular.kde.org/
+[Overridding Build Settings]: https://github.com/thomasjo/atom-latex/wiki/Overridding-Build-Settings
 [pdf-view]: https://atom.io/packages/pdf-view
 [Preview]: https://support.apple.com/en-us/HT201740
 [Skim]: http://skim-app.sourceforge.net/
@@ -113,4 +126,6 @@ Any and all help is greatly appreciated!
 [travis svg]: https://travis-ci.org/thomasjo/atom-latex.svg?branch=master
 [travis]: https://travis-ci.org/thomasjo/atom-latex
 [xdg-open]: https://linux.die.net/man/1/xdg-open
-[Xreader]: https://github.com/linuxmint/xreader
+[Xreader]: https://github.com/linuxmint/xreader
+[YAML]: http://yaml.org/
+[Zathura]: https://github.com/pwmt/zathura
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "latex",
-  "version": "0.41.0",
+  "version": "0.42.0",
   "description": "Compile LaTeX documents from within Atom.",
   "keywords": [
     "tex",