This folder demonstrates the expected structure and configuration files for a guide that can be transformed into HTML or PDF by the doc_build infrastructure.
File/Folder | Description |
---|---|
adoc/ | Folder containing AsciiDoc source for the guide. |
assets | Folder containing assets used in guide transformation. |
build.properties | Ant property file, specifying where the guide source lives, and where the doc_build infrastructure exists. |
build.xml | Ant build file. |
xml/ | Folder containing DocBook XML source for the guide. |
Note: You normally only need one source for a guide, AsciiDoc or Docbook. AsciiDoc guides are transformed into DocBook with AsciiDoctor, and then processed as a DocBook guide. This sample guide provides both formats so you can test building HTML and PDF with either source format, and compare markup strategies.
<!--- vim: set ts=2 sw=2 tw=74 ai si: -->
# Sample Guide This folder demonstrates the expected structure and configuration files for a guide that can be transformed into HTML or PDF by the [doc_build](../README.md) infrastructure. | File/Folder | Description | | ---------------- | ----------- | | adoc/ | Folder containing AsciiDoc source for the guide. | | assets | Folder containing assets used in guide transformation. | | build.properties | Ant property file, specifying where the guide source lives, and where the doc_build infrastructure exists. | | build.xml | Ant build file. | | xml/ | Folder containing DocBook XML source for the guide. | Note: You normally only need one source for a guide, AsciiDoc or Docbook. AsciiDoc guides are transformed into DocBook with AsciiDoctor, and then processed as a DocBook guide. This sample guide provides both formats so you can test building HTML and PDF with either source format, and compare markup strategies. <!--- vim: set ts=2 sw=2 tw=74 ai si: -->
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
//guest/perforce_software/doc_build/main/sample_guide/README.md | |||||
#2 | 12844 | eedwards | Fix a Markdown link typo. | ||
#1 | 12843 | eedwards |
#review-1055133 Add a sample guide to the doc infrastructure that demonstrates the directory layout, configuration, and source markup for both AsciiDoc and DocBook. @matt, @jschaffer, and @jbujes should review. Rendered HTML is available for review: http://10.2.0.75/docs/ethel/index.html |