[mapguide-internals] RE: Documenting

[Walt Welton-Lair]

Codewise that's probably all that's involved.  The MG0001 format seems reasonable to me.

But should there be some classification scheme to the numbering?  E.g. generic error messages start with MG0xxx, server-specific ones start with MG1xxx, web-specific ones start with MG2xxx?  For third parties built on top of MG who need to add their own error messages, what MGxxxx values should they use?  This information should then be documented somewhere.

Walt


-----Original Message-----
From: mapguide-internals-bounces at lists.osgeo.org [mailto:mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Zac Spitzer
Sent: Wednesday, April 07, 2010 8:56 PM
To: MapGuide Internals Mail List
Subject: Re: [mapguide-internals] RE: Documenting

ok :)

I could write a quick script to enumerate through and assign error numbers?

http://trac.osgeo.org/mapguide/browser/trunk/MgDev/Common/MapGuideCommon/Resources/mapguide_en.res

how does everyone feel about the MG0001 format?

as for where we put the information about the errors, putting the info
on stackoverflow would be good as there are comments and moderation
of answers, as I think trac fails us terribly here

z

On 8 April 2010 10:46, Walt Welton-Lair <walt.welton-lair at autodesk.com> wrote:
> This sounds like a good starter project for Zac :-).
> ________________________________________
> From: mapguide-internals-bounces at lists.osgeo.org [mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Tom Fukushima
> Sent: Wednesday, April 07, 2010 7:50 PM
> To: MapGuide Internals Mail List
> Subject: RE: [mapguide-internals] RE: Documenting
>
> Can someone quickly describe the approximate amount of effort it would take to do something like this? Bruce and Trevor, you've both worked pretty closely with the error logging system, perhaps you have some idea.
>
> Thanks
> Tom
>
> -----Original Message-----
> From: mapguide-internals-bounces at lists.osgeo.org [mailto:mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Zac Spitzer
> Sent: Wednesday, April 07, 2010 5:42 PM
> To: MapGuide Internals Mail List
> Subject: Re: [mapguide-internals] RE: Documenting
>
> It makes the documentation much easier to access via search engines
>
> for example, the updated error about can't connecting shows this
> message via the mapagent tests
>
> Problem:\nCannot establish connection to the MapGuide
> Server.\n\nPossible Causes:\n-Your session has been idle for too
> long;\n-MapGuide Server is no longer responding;\n-Internet connection
> problems.\n\nSolution:\nRestart your application / session, restart
> the MapGuide Server service, or contact with the server administrator.
> Problem:\nCannot establish connection to the MapGuide
> Server.\n\nPossible Causes:\n-Your session has been idle for too
> long;\n-MapGuide Server is no longer responding;\n-Internet connection
> problems.\n\nSolution:\nRestart your application / session, restart
> the MapGuide Server service, or contact with the server administrator.
>
> Ignoring the \n issue, this is a rather verbose error message
>
> If there was a error code MG001, the user could then simply google it and
> find (any) related documentation, mailing list posts or blog entries
> which relate
> to this error.
>
> Error: MG001 Cannot establish connection to the MapGuide Server
>
> Is much clearer and provides the user with a simple action path if
> they don't know
> what has happened. search for MG001 which would then bring the user to
> a trouble shooting page on the wiki.
>
> z
> _______________________________________________
> mapguide-internals mailing list
> mapguide-internals at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/mapguide-internals
> _______________________________________________
> mapguide-internals mailing list
> mapguide-internals at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/mapguide-internals
>



-- 
Zac Spitzer
Solution Architect / Director
Ennoble Consultancy Australia
http://www.ennoble.com.au
http://zacster.blogspot.com
+61 405 847 168
_______________________________________________
mapguide-internals mailing list
mapguide-internals at lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/mapguide-internals