| ramverma | af74a62 | 2018-07-31 18:25:39 +0100 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!-- |
| 3 | ============LICENSE_START======================================================= |
| 4 | Copyright (C) 2016-2018 Ericsson. All rights reserved. |
| 5 | ================================================================================ |
| 6 | This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE |
| 7 | Full license text at https://creativecommons.org/licenses/by/4.0/legalcode |
| 8 | |
| 9 | SPDX-License-Identifier: CC-BY-4.0 |
| 10 | ============LICENSE_END========================================================= |
| 11 | |
| 12 | @author Sven van der Meer (sven.van.der.meer@ericsson.com) |
| 13 | |
| 14 | --> |
| 15 | |
| 16 | <document> |
| 17 | <properties> |
| 18 | <title>The APEX Developer Guide</title> |
| 19 | <author email="sven.van.der.meer@ericsson.com">Sven van der Meer</author> |
| 20 | <author email="liam.fallon@ericsson.com">Liam Fallon</author> |
| 21 | <author email="john.keeney@ericsson.com">John Keeny</author> |
| 22 | </properties> |
| 23 | <body> |
| 24 | |
| 25 | <section name="The APEX Developer Guide"> |
| 26 | |
| 27 | <p> |
| 28 | The APEX developer guide combines a set of guides and howto documents, all addressing aspects for APEX developers. |
| 29 | These documents look at APEX internals and how to extend build and extend the platform, and how to add applications. |
| 30 | The guide and howto documents are provided as integrated documentation in the APEX site. |
| 31 | Furthermore, we provide stand-alone documents in HTML and PDF. |
| 32 | </p> |
| 33 | |
| 34 | <p> |
| 35 | Note: most of the documentation is written in AsciiDoc. |
| 36 | We are using the AsciiDoctor version. |
| 37 | Due to the different build tools used for the different documentation targets, the rendered documents differ in style. |
| 38 | The content however comes always from a single, normative source located in the APEX source repositories. |
| 39 | </p> |
| 40 | |
| 41 | <h3>APEX User Manual documentation</h3> |
| 42 | <table> |
| 43 | <tr> |
| 44 | <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="20%">Name</th> |
| 45 | <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="50%">Description</th> |
| 46 | <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="30%">Links</th> |
| 47 | </tr> |
| 48 | <tr> |
| 49 | <td>Developer Guide</td> |
| 50 | <td> |
| 51 | The complete APEX Developer Guide, including all HowTos and other documentation. |
| 52 | The stand-alone versions aggregate all other documents listed in this table. |
| 53 | </td> |
| 54 | <td> |
| 55 | <ul> |
| 56 | <li><a href="docs-apex/html/APEX-Developer-Guide.html">stand-alone HTML</a></li> |
| 57 | <li><a href="docs-apex/pdf/APEX-Developer-Guide.pdf">stand-alone PDF</a></li> |
| 58 | </ul> |
| 59 | </td> |
| 60 | </tr> |
| 61 | <tr> |
| 62 | <td>HowTo: Build APEX from source</td> |
| 63 | <td> |
| 64 | This HowTo details all variations to build APEX from the source code. |
| 65 | Some of the options are: standard build with and without tests, build with all test, build with all components. |
| 66 | The document also shows how to build the documentation and the APEX site. |
| 67 | </td> |
| 68 | <td> |
| 69 | <ul> |
| 70 | <li><a href="developer-guide/build/dg-build.html">APEX Site</a></li> |
| 71 | <li><a href="docs-apex/html/HowTo-Build-APEX.html">stand-alone HTML</a></li> |
| 72 | <li><a href="docs-apex/pdf/HowTo-Build-APEX.pdf">stand-alone PDF</a></li> |
| 73 | </ul> |
| 74 | </td> |
| 75 | </tr> |
| 76 | <tr> |
| 77 | <td>HowTo: Codestyle and Automated Style Checks</td> |
| 78 | <td> |
| 79 | This HowTo defines the Java coding rules when developing for the APEX system and any of its components. |
| 80 | It details how to install and configure required Eclipse plugins (JAutoDoc, Checkstyle) and how to run automated style checks. |
| 81 | </td> |
| 82 | <td> |
| 83 | <ul> |
| 84 | <li><a href="developer-guide/codestyle/dg-codestyle.html">APEX Site</a></li> |
| 85 | <li><a href="docs-apex/html/HowTo-Codestyle.html">stand-alone HTML</a></li> |
| 86 | <li><a href="docs-apex/pdf/HowTo-Codestyle.pdf">stand-alone PDF</a></li> |
| 87 | </ul> |
| 88 | </td> |
| 89 | </tr> |
| 90 | </table> |
| 91 | </section> |
| 92 | </body> |
| 93 | </document> |