Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
documentation_notes [2007-06-09 11:31] – external edit 127.0.0.1 | documentation_notes [2014-02-28 01:41] (current) – [documents that are in PDF format] nik | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ===== notes on documentation, | ||
+ | ===== formats + software ===== | ||
+ | [[File Formats]] | ||
- | ===== notes on documentation, | + | ==== documents that are in PDF format==== |
+ | using Skim to annotate pdfs on MacOS > http:// | ||
- | ==== formats + software ==== | + | merging two pdfs '' |
- | [[File Formats]] | + | |
+ | to merge annotations/ | ||
+ | - open doc-1.pdf in Skim | ||
+ | - export note from "File > Export" | ||
+ | - open doc-2.pdf in Skim | ||
+ | - import notes via "File > Read Notes" make sure to unselect " | ||
+ | - save doc-2.pdf | ||
- | === docs using | + | ==== documents that uses LaTeX ==== |
- | "The original documentation source is [[LaTeX]]. Simply running LaTeX gives you DVI, which you can convert into publication quality Postscript. Using pdflatex (NOT ps2pdf), you can also create very high quality PDF, which includes a real PDF table of contents, cross-references, | + | "The original documentation source is [[LaTeX|LaTeX]]. Simply running |
" | " | ||
Line 27: | Line 35: | ||
* It's available for minimal money and effort. | * It's available for minimal money and effort. | ||
* It's highly extensible. If you need to do something that doesn' | * It's highly extensible. If you need to do something that doesn' | ||
- | * [[LaTeX]] versions are not incompatible. The file format has never changed. I have LaTeX files from 1989 that work without problem in the latest version of LaTeX. | + | * [[LaTeX]] versions are not incompatible. The file format has never changed. I have $\LaTeX$ files from 1989 that work without problem in the latest version of $\LaTeX$. |
- | The only downside I can think of is the learning curve. Basic LaTeX use is fine, but for really good output, you're going to want your own class file and/or packages. That's fantastic once you've got it -- all your docs follow a consistent style, and you can make it easy for newbies to learn the tool. Someone has to be pretty sharp to write the class/ | + | The only downside I can think of is the learning curve. Basic $\LaTeX$ use is fine, but for really good output, you're going to want your own class file and/or packages. That's fantastic once you've got it -- all your docs follow a consistent style, and you can make it easy for newbies to learn the tool. Someone has to be pretty sharp to write the class/ |
---- | ---- | ||
- | === XML, XSLT and Docbook === | + | ==== XML, XSLT and Docbook |
I've been using XML and Docbook for a while now, and I really, really like it, particularly if you use Docbook as an intermediate format rather than what you actually write your documentation in. | I've been using XML and Docbook for a while now, and I really, really like it, particularly if you use Docbook as an intermediate format rather than what you actually write your documentation in. |