help-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Texinfo conventions/recommendations for using @include


From: Benjamin Kalish
Subject: Texinfo conventions/recommendations for using @include
Date: Thu, 12 Dec 2024 08:59:52 -0500

I'm working on a large project and have been using @include a lot. It's definitely helpful, but I'm feeling a bit overwhelmed by all the possibilities and I'm curious what conventions others have found helpful.

For example, if you have a directory of Texinfo files to be included, do you have an index file to include them all in the proper order? What do you call it, and does it live in that directory, or the directory above? I haven't settled on a convention yet, and the mix of approaches is definitely getting confusing.

For example, if I'm including my appendices I might  have this in my root file:

@include appendices/first-appendix.texi
@include appendices/second-appendix.texi
@include appendices/third-appendix.texi

or I might have that in a file called appendices.texi and use

@include appendices.texi or @include appendices/appendices.texi

There is also part of me, raised on web conventions, that wants to use @include appendices/index.texi

Two related questions:
  • I believe that @include paths are always relative to the location of the root file. Is that correct? I'd love to be able to @include using paths relative to the file doing the including. Is that possible?
  • How do you decide when to @include in the first place? It seems like many projects have very large Texinfo files, but I find I often get lost when editing files so large.
Thanks!

Benjamin Kalish

reply via email to

[Prev in Thread] Current Thread [Next in Thread]