style(README):Test bold text
[BK-2020-04.git] / README.org
... / ...
CommitLineData
1* BK-2020-04: Baltakatei Engineering Drawing Templates
2#+AUTHOR: Steven Baltakatei Sandoval
3#+DATE: 2023-08-19
4#+EMAIL: baltakatei@gmail.com
5
6** Scope
7This repository contains drawing files for constructing personal P&IDs
8([[https://en.wikipedia.org/wiki/Piping_and_instrumentation_diagram][Piping and Instrumentation Diagrams]]) and PFDs ([[Process flow diagram][Process Flow
9Diagrams]]).
10
11** Summary
12See the [[File:REVISION.org][drawing revision history]] for a list of tracked files.
13
14Some drawings may be uploaded to Wikimedia Commons. Notable sets include:
15
16- [[https://commons.wikimedia.org/wiki/File:ISO_10628-2_2012_Symbols.pdf][BK-2020-04-PID-1]]: Chemical engineering symbols ([[https://en.wikipedia.org/wiki/ISO_10628][ISO 10628]]-2:2012 Symbols)
17- [[https://commons.wikimedia.org/wiki/File:Technical_drawing_templates_(ISO_5457_1999_Sizes_A0-A4).pdf][BK-2020-04-TMP-1]]: Technical drawing templates (ISO 5457:1999 Sizes A0—A4)
18
19** Contents
20*** Directories
21- ~DEL~: Deliverables. A directory that may include plain SVG files
22 and exported PDF files. *This is probably what you want*.
23- ~DWG~: Drawing source files. A directory that may include [[https://inkscape.org/][Inkscape]]
24 SVG files.
25- ~EXEC~: Executable files. A directory that may include scripts
26 useful for manipulating files.
27- ~IMG~: Reference image files. A directory that may include various
28 image files used in creation of project source files.
29*** Files
30- ~README.org~: This file.
31- ~REVISIONS.org~: A file containing a detailed version history of
32 each drawing.
33- ~TODO.org~: A file containing a list of pending tasks for the
34 project.
35
36** Usage
37*** Generate a combined PDF
38A script is available at ~./EXEC/combine_pdfs.sh~ to merge multiple
39single-page PDFs into a single PDF file; the script uses the [[https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/][pdftk
40utility]] available on typical [[https://www.debian.org/][Debian]]-based [[https://en.wikipedia.org/wiki/Gnu-Linux][GNU/Linux]] machines
41of 2023. On a typical Debian 12 system, the following command may be
42used to merge ~input1.pdf~ and ~input2.pdf~ files into ~output.pdf~.
43
44: $ /bin/bash combine_pdfs.sh output.pdf input1.pdf input2.pdf
45
46** License
47Unless otherwise specified, source and deliverable files are copyright
482023 [[https://baltakatei.com][Steven Baltakatei Sandoval]] and available under a [[https://creativecommons.org/licenses/by-sa/4.0/][CC BY-SA 4.0]]
49license.