LaTeX forum ⇒ GeneralPackaging custom module or layout

LaTeX specific issues not fitting into one of the other forums of this category.
aparfeno
Posts: 1
Joined: Tue May 22, 2018 3:46 pm

Packaging custom module or layout

Postby aparfeno » Tue May 22, 2018 4:08 pm

Hello,
At my company we use lyx to create giant user manuals in PDF formats. We've organized our work similar to software development lifecycle:

Technical authors (on personal workstations computers) -> SVN -> Jenkins(build server) -> PDF -> Automatic distribution of PDF documents.
So:
1. All document sources (*.lyx and images) live in SVN
2. Since the documents are large, we split them up into multiple parent-child lyx files.

Question:
How can I implement custom templates, global document settings and keep them in SVN (ideally in one place)?
I has hoping to use \input or \include feature, but it seems that it is not possible to include a module by file name (it must be added to local environment)?

Thanks,
Alex

User avatar
Stefan Kottwitz
Site Admin
Posts: 8874
Joined: Mon Mar 10, 2008 9:44 pm

Postby Stefan Kottwitz » Tue May 22, 2018 4:30 pm

Hi Alex,

welcome to the forum!

When I produce documentation in PDF format, I use LaTeX. Like you, I try to keep it simple for my colleagues and me. Instead of LyX, I use LaTeX but I separate content and style. I go so far, that I write pure content without commands. (only macros when needed)

For this, I use Markdown. Any simple editor can be used by anybody. Documents look like this:

  1. \input{header}
  2. \begin{markdown}
  3.  
  4. Overview
  5. ========
  6.  
  7. This document is a summary of the Cisco solution at \location of \customer:
  8.  
  9. - General architecture and functionality
  10. - Setup at \location
  11. - \location specific configuration
  12. - Administration by \customer, \location IT and GIS
  13.  
  14. Wired LAN
  15. ---------
  16.  
  17. The \location network contains Cisco Catalyst 3650 switches in the IDF rooms and Cisco Nexus switches in the MDF rooms that are the data centers (DCs). The DCs also contain Catalyst switches, routers, and WiFi controllers.


The header contains the style file and macros. Using the simple Markdown syntax, text is clean and readable and maintainable. Still I have the full power of LaTeX. Running LaTeX, I get such output for the document above:

document.png
document.png (58.46 KiB) Viewed 133 times


Documentation doesn't need sophisticated code. It's often just headings, bullet points, lists, code, images (the latter loaded via simple macro). In general, using simple macros allows to re-use the same technical documentation for the same product for several different projects for the same customer or even different customers.

Stefan
Site admin


Return to “General”

Who is online

Users browsing this forum: No registered users and 4 guests