Improved docs on multi file projects (#535)
This commit is contained in:
parent
c60d5d14ec
commit
59d34eace8
@ -158,10 +158,15 @@ Requirements~
|
|||||||
Support for multi-file projects~
|
Support for multi-file projects~
|
||||||
*vimtex-multi-file*
|
*vimtex-multi-file*
|
||||||
|
|
||||||
|vimtex| supports most multi-file documents. It uses a recursive search
|
|vimtex| supports most multi-file documents. The main method uses a recursive
|
||||||
algorithm that should find the main LaTeX file in most cases. For special
|
search algorithm that should find the main LaTeX file in most cases. For
|
||||||
cases, there are several alternative methods for specifying the main file, see
|
special cases, there are several alternative methods for specifying the main
|
||||||
below. The methods are tried in the following order:
|
file. These alternative methods all require some explicit declaration of the
|
||||||
|
main file. Thus, these methods will be tried first, and the recursive search
|
||||||
|
is tried last if there are no explicit declarations that yield an appropriate
|
||||||
|
main LaTeX file candidate.
|
||||||
|
|
||||||
|
The methods are tried in the following order:
|
||||||
|
|
||||||
1. Buffer variable
|
1. Buffer variable
|
||||||
2. TeX root specifier
|
2. TeX root specifier
|
||||||
@ -171,9 +176,9 @@ below. The methods are tried in the following order:
|
|||||||
|
|
||||||
*b:vimtex_main*
|
*b:vimtex_main*
|
||||||
Buffer variable~
|
Buffer variable~
|
||||||
Finally, the main file may be specified through the buffer variable
|
The main file may be specified through the buffer variable `b:vimtex_main`.
|
||||||
`b:vimtex_main`. If one uses project specific |vimrc| files, one may then
|
If one uses project specific |vimrc| files, one may then use an |autocmd| to
|
||||||
use an |autocmd| to specify the main file through this buffer variable with >
|
specify the main file through this buffer variable with >
|
||||||
|
|
||||||
autocmd FileType tex let b:vimtex_main = 'main.tex'
|
autocmd FileType tex let b:vimtex_main = 'main.tex'
|
||||||
|
|
||||||
@ -183,8 +188,6 @@ TeX root specifier~
|
|||||||
|
|
||||||
%! TEX root = /path/to/my-main.tex
|
%! TEX root = /path/to/my-main.tex
|
||||||
<
|
<
|
||||||
Note that this method should work for the case where the recursive search
|
|
||||||
does not work.
|
|
||||||
*vimtex-subfiles*
|
*vimtex-subfiles*
|
||||||
*vimtex-import*
|
*vimtex-import*
|
||||||
Subfiles package~
|
Subfiles package~
|
||||||
@ -210,9 +213,10 @@ File .latexmain specifier~
|
|||||||
that `path/file.tex` is the main LaTeX file.
|
that `path/file.tex` is the main LaTeX file.
|
||||||
|
|
||||||
Recursive search~
|
Recursive search~
|
||||||
The recursive search detects the main LaTeX file by searching for a file in
|
If no other method provides an appropriate candidate, then the recursive
|
||||||
the current and parent directories that includes the present file and that
|
search detects the main LaTeX file by searching for a file in the current
|
||||||
has the `\documentclass` line.
|
and parent directories that includes the present file and that has the
|
||||||
|
`\documentclass` line.
|
||||||
|
|
||||||
This should work in most cases, but it may fail if for instance the project
|
This should work in most cases, but it may fail if for instance the project
|
||||||
structure is something like this: >
|
structure is something like this: >
|
||||||
@ -222,6 +226,7 @@ Recursive search~
|
|||||||
<
|
<
|
||||||
That is, the main file detection will not work for the file `chapter.tex`,
|
That is, the main file detection will not work for the file `chapter.tex`,
|
||||||
because the main file does not live in the same folder or a parent folder.
|
because the main file does not live in the same folder or a parent folder.
|
||||||
|
In this particular case, the TeX root specifier should work.
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
Comment on internal tex plugin~
|
Comment on internal tex plugin~
|
||||||
|
Loading…
x
Reference in New Issue
Block a user