Opened 13 years ago
Last modified 12 years ago
#1614 closed task
Updated MapGuide Developer's Guide — at Initial Version
| Reported by: | jng | Owned by: | jng |
|---|---|---|---|
| Priority: | medium | Milestone: | |
| Component: | Documentation | Version: | |
| Severity: | major | Keywords: | devguide, documentation |
| Cc: | External ID: |
Description
The original MapGuide Developer's Guide has several problems associated with it:
- It used PHP in all its code samples. The problem is if you didn't know PHP, but knew .net or Java then the actual document does not really help.
- The document is essentially a blob, making it unsuitable for storage under source control as changes cannot be tracked.
- The document does not exist in source form (related to point #2). Having the document source allows us to "compile" it into multiple different forms (html, pdf, chm, etc)
- The document has evidently not been updated in a while to reflect the addition of newer MapGuide APIs and the addition of Fusion and support in OpenLayers
As a first phase, the content of the devguide should be placed into document source form (current thinking is either powerful like LaTeX or something simpler like sphinx (http://sphinx.pocoo.org))
With the second phase being updating the existing PHP devguide samples to match current APIs.
The third phase would be to port this updated sample to Java and .net
The final phase would be to update the devguide content and associated samples with usage examples of newer APIs and examples involving fusion and OpenLayers.
Once in place, the devguide content and examples should be regularly updated as newer MapGuide APIs are introduced.
