Added documentation for SubfileToggle (#211)

This commit is contained in:
Karl Yngve Lervåg 2016-01-14 15:04:14 +01:00
parent 38aaf18dc5
commit de89fe4fa5
2 changed files with 19 additions and 2 deletions

View File

@ -51,7 +51,7 @@ disabled if desired.
- Support for `dot2tex` with nested syntax highlighting - Support for `dot2tex` with nested syntax highlighting
- Support for multi-file project packages - Support for multi-file project packages
- [import](http://ctan.uib.no/macros/latex/contrib/import/import.pdf) - [import](http://ctan.uib.no/macros/latex/contrib/import/import.pdf)
- [subfiles](http://ctan.uib.no/macros/latex/contrib/import/import.pdf) (partly) - [subfiles](http://ctan.uib.no/macros/latex/contrib/import/import.pdf)
See the documentation for a more thorough introduction of the plugin (e.g. `:h See the documentation for a more thorough introduction of the plugin (e.g. `:h
vimtex`). vimtex`).

View File

@ -114,7 +114,7 @@ Feature overview~
- Support for `dot2tex` with nested syntax highlighting - Support for `dot2tex` with nested syntax highlighting
- Support for multi-file project packages - Support for multi-file project packages
- `import` - `import`
- `subfiles` (partly) - `subfiles`
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
Requirements~ Requirements~
@ -204,6 +204,8 @@ Subfiles~
Note that this is a special case in that it is only relevant for users who Note that this is a special case in that it is only relevant for users who
use the `subfiles` package. use the `subfiles` package.
See also |VimtexSubfileToggle|.
*vimtex-import* *vimtex-import*
Import~ Import~
|vimtex| also supports the `import` package, in that it should correctly |vimtex| also supports the `import` package, in that it should correctly
@ -1055,6 +1057,21 @@ Commands~
in a scratch buffer. Press `q` or `<esc>` to close in a scratch buffer. Press `q` or `<esc>` to close
the buffer. the buffer.
*VimtexSubfileToggle*
*<plug>(vimtex-subfile-toggle)*
:VimtexSubfileToggle Toggle between the current subfile and the main
project file as "current project". This allows one
to work on a subfile directly, disconnected from the
main project. That is, when the subfile is active,
then commands for compiling and similar work on the
subfile.
Note also that it is possible to have both projects
active simultaneously. That is, if one starts
latexmk for the main file, then toggles to the
subfile, then the main file will still be available
and under latexmk compilation.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
Map definitions~ Map definitions~
*vimtex-mappings* *vimtex-mappings*