Opened 8 years ago

Closed 6 years ago

#1614 closed task (fixed)

Updated MapGuide Developer's Guide

Reported by: jng Owned by: jng
Priority: medium Milestone:
Component: Documentation Version:
Severity: major Keywords: devguide, documentation
Cc: External ID:

Description (last modified by jng)

The original MapGuide Developer's Guide has several problems associated with it:

  1. 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.
  1. The document is essentially a blob, making it unsuitable for storage under source control as changes cannot be tracked.
  1. 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) and integrate it as part of the build process
  1. 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 PHP sample to Java and .net while respecting the development style of the respective languages.

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.

Attachments (2)

build_bat.patch (761 bytes) - added by jng 8 years ago.
installer_build_bat.patch (1.8 KB) - added by jng 8 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 Changed 8 years ago by jng

Version: 2.1.0

comment:2 Changed 8 years ago by jng

Description: modified (diff)

comment:3 Changed 8 years ago by tomfukushima

I tried to get the source of the document a while back but was unsuccessful. I think that the best thing to do would be to extract the contents from the PDF and start with that.

Changed 8 years ago by jng

Attachment: build_bat.patch added

Changed 8 years ago by jng

Attachment: installer_build_bat.patch added

comment:4 Changed 6 years ago by jng

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.