| CDD GENERATION README |
| ===================== |
| |
| The HTML CDD is generated via build script from the source files in the |
| platform/compatibility/cdd component. See the README in that component for |
| details. Once the HTML is generated, then it is copied to this directory and the |
| PDF is generated using the procedure given below. |
| |
| PDF GENERATION |
| ============== |
| |
| OVERVIEW |
| ================== |
| This section describes how to create a CDD PDF from the CDD HTML file. You need to generate a cover file and a body file, then use a PDF editor to insert the cover page into the body.pdf. |
| |
| The Android Compatibilty Definition Document (CDD) is maintained as an html file but distributed as a .pdf. The partner team updates the CDD for every new major Android release and the APE doc team posts the new .pdf to source.android.com in http://source.android.com/compatibility/. |
| |
| To create the pdf from the html file, use wkhtmltopdf (http://wkhtmltopdf.org/) plus a little bit of PDF editing. You can do the conversion on a Mac or Linux (or even Windows); you just need to download the wkhtmltopdf pkg for your system. However, you must perform the editing in a professional PDF editor; for Mac and Windows this is Adobe Acrobat Pro; for Linux this is PDF Studio 10 (none of the free Linux PDF apps can do the swap successfully and still maintain the PDF bookmarks and links). |
| |
| |
| 1. INSTALL WKHTMLTOPDF |
| ======================= |
| Go to http://wkhtmltopdf.org/ and download the app for your system OS. It's command line only. |
| |
| |
| 2. GENERATE COVER PDF |
| ======================= |
| |
| Syntax: |
| |
| wkhtmltopdf [page-size] [page-margins] cover path-to-html path-to-pdf |
| |
| page-size |
| Set to letter. |
| Ex. -s letter |
| |
| page-margins |
| set to 0in (cover goes all the way to page edges) |
| Ex. -B 0in -T 0in -L 0in -R 0in |
| |
| path-to-html |
| The full path to the cover html file. You will need to update the cover text to specify the release name , number, and date. You might also need to swap the image out for the image associated with the release (store images in compatibility/images). |
| Ex: docs/source.android.com/src/compatibility/5.1/android-cdd-cover_5_1.html |
| |
| path-to-pdf |
| The full path to where you want the output pdf file to reside. If the pdf file is NOT open (in Preview or some other app), running the command will silently overwrite the existing .pdf. |
| Ex. docs/source.android.com/src/compatibility/5.1/android-cdd-cover.pdf |
| |
| Example cover command run from top-level project: |
| wkhtmltopdf -s letter -B 0in -T 0in -L 0in -R 0in cover docs/source.android.com/src/compatibility/5.1/android-cdd-cover_5_1.html docs/source.android.com/src/compatibility/5.1/android-cdd-cover.pdf |
| |
| Example cover command run from 5.1 release folder: |
| wkhtmltopdf -s letter -B 0in -T 0in -L 0in -R 0in cover android-cdd-cover_5_1.html /android-cdd-cover.pdf |
| |
| |
| 3. GENERATE BODY PDF |
| ==================== |
| Syntax: |
| |
| wkthmltopdf [page-margins] page path-to-html path-to-footer path-to-pdf |
| |
| page-margins |
| set to 1in on top and bottom, .75in on left and right. |
| Ex. -B 1in -T 1in -L .75in -R .75in |
| |
| path-to-html |
| The full path to the body html file. This is the main cdd.html, which will change with each release. |
| Ex. docs/source.android.com/src/compatibility/5.1/android-5.1-cdd.html |
| |
| path-to-footer |
| The full path to the footer html file. This is a simple html file that contains the android logo and some javascript to calculate the page number and count. The footer should NOT change from release to release. |
| Ex. --footer-html docs/source.android.com/src/compatibility/5.1/android-cdd-footer.html |
| |
| path-to-pdf |
| The full path to where you want the output pdf file to reside. If the pdf file is NOT open (in Preview or some other app), running the command will silently overwrite the existing .pdf. |
| Ex. docs/source.android.com/src/compatibility/5.1/android-cdd-body.pdf |
| |
| Example body command run from top-level project: |
| wkhtmltopdf -B 1in -T 1in -L .75in -R .75in page docs/source.android.com/src/compatibility/5.1/android-5.1-cdd.html --footer-html docs/source.android.com/src/compatibility/5.1/android-cdd-footer.html docs/source.android.com/src/compatibility/5.1/android-cdd-body.pdf |
| |
| Example body command run from 5.1 release folder: |
| wkhtmltopdf -B 1in -T 1in -L .75in -R .75in page android-5.1-cdd.html --footer-html android-cdd-footer.html android-cdd-body.pdf |
| |
| 4. CREATE CDD PDF |
| ================== |
| A. Open the body.pdf: |
| On a Mac or Windows, use Adobe Acrobat Pro (you *cannot* use Acrobat Reader for this task). |
| On Ubuntu, use PDF Studio 10 (other free pdf programs *cannot* handle the merge + bookmarks). |
| B. Replace page 1 of the body.pdf with page 1 of the cover.pdf. For example, if you are using Adobe Acrobat Pro: |
| 1. Open the body.pdf in Adobe Acrobat Pro. |
| 2. Select Tools > Pages > Replace. |
| 2. Open the cover.pdf file. |
| 3. Replace page 1 of the body.pdf with page 1 of the cover.pdf. |
| C. Save the new file as the android-cdd_x_x.pdf (where X_X is the number of the release, such as 5.1). |
| |
| QUESTIONS? |
| ================== |
| - For details on wkhtmltopdf, see http://wkhtmltopdf.org/usage/wkhtmltopdf.txt. |
| - CDD html, css, and pdf files are in docs/source.android.com/src/compatibility/release. |
| - CDD images are in docs/source.android.com/src/compatibility/images. |
