Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
ots-doctools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ots
ots-doctools
Commits
cec5bf3e
Commit
cec5bf3e
authored
1 year ago
by
Karl Fogel
Browse files
Options
Downloads
Patches
Plain Diff
Document some known LaTeX idiosyncracies
parent
bd9f543c
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+39
-1
39 additions, 1 deletion
README.md
with
39 additions
and
1 deletion
README.md
+
39
−
1
View file @
cec5bf3e
...
...
@@ -41,7 +41,7 @@ improving this infrastructure.
behaves oddly, we also recommend
`mkdir ~/texmf/tex/latex/dummy`
so
that kpathsea will follow the symlink properly.)
##
Usage
##
Building Documents
The top-level
`Makefile`
in your document's source tree -- remember,
that's a different tree from this one -- should be a copy of the file
...
...
@@ -77,6 +77,44 @@ underscore.
See the plugins in ./pipeline/plugins for documentation on specific
plugins.
## LaTeX Usage
Mostly you should just use standard LaTeX in OTS Doctools documents.
However, there are some things you should know:
### Avoid accidentally triggering jinja
If you start a LaTeX comment using two or more percent signs together
("%%") at the beginning of a line, then the jinja template parser --
which runs before LaTeX -- will try to interpret that line as a jinja
command, usually resulting in an error:
```
Traceback (most recent call last):
[... long traceback stack here ...]
jinja2.exceptions.TemplateSyntaxError: tag name expected
```
The solution is to just always put a space after the first "%" when
starting off a LaTeX comment at the beginning of a line:
```
%%% This will cause a problem, because the line starts with "%%".
% %% But this, on the other hand, will be fine.
```
### Use `longtable` for tables.
Use the
[
longtable
](
https://ctan.org/pkg/longtable
)
package for
tables, instead of the default LaTeX tabular environment. This is
really a generic recommendation, not specific to OTS Doctools, but
it's
[
come up
before
](
https://code.librehq.com/ots/ots-doctools/-/issues/2
)
so we
thought we'd document it here. Among other things, if you use
`longtable`
, then in-table footnotes will be
[
handled
correctly
](
https://code.librehq.com/ots/ots-doctools/-/issues/3
)
.
## Windows
Linux and OS X should generally do the right thing with these
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment