<h1>SDP Documentation Information</h1> <p>Now being converted to ASCIIDoctor format (*.adoc), from which we can create HTML and PDF output.</p> <h1>How to run</h1> <p>With tools installed, it is as simple as:</p> <pre><code>make </code></pre> <h1>Installing Tools</h1> <ul> <li><code>pandoc</code> for conversions</li> <li><code>asciidoctor</code> for basic HTML</li> <li><code>asciidoctor-pdf</code> for PDF output</li> </ul> <p>Downloads:</p> <ul> <li>https://asciidoctor.org/docs/user-manual/#system-requirements</li> <li>https://asciidoctor.org/docs/asciidoctor-pdf/#getting-started</li> <li>https://pandoc.org/installing.html</li> </ul> <h1>Converting from MS Word</h1> <p>Conversions from Word done like this:</p> <p>https://asciidoctor.org/docs/migrating-from-msword/</p> <p>pandoc --from=docx --to=asciidoc --wrap=none --atx-headers --extract-media=extracted-media SDP_Guide.Unix#13.docx > output.adoc</p> <p>You may need to look at the extracted-media directory.</p> <h1>Finding non UTF8 chars</h1> <p>When converting from MS Word you may get an error message from <code>asciidoctor-pdf</code> about UTF8/binary problems and things like smart quotes, or em-dashes.</p> <p>perl -ne 'print "$. $<em>" if m/[\x80-\xFF]/' SDP</em>Guide.Unix.adoc</p>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 30043 | C. Thomas Tyler |
Released SDP 2023.2.30041 (2023/12/22). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
//guest/perforce_software/sdp/dev/doc/README.html | |||||
#1 | 30040 | C. Thomas Tyler | Regenerated docs. |