Mapfile Keywords missing and problems in documentation

[aboudreault]

Here's a list of some missing keywords in the documentation:

• JOIN-> header/footer
• LAYER-> maxgeowidth/mingeowidth
• LAYER->PLUGIN
• WEB->QUERYFORMAT
• WEB->BROWSEFORMAT
• WEB->LEGENDFORMAT

Other problems:

• update outputformat.html: the png experimental switch stated is not valid
• WEB->OUTPUTFORMAT no more valid ? documentation said yes
• LAYER->CONNECTIONTYPE : MYGIS, WFS options are not documented
• JOIN->CONNECTIONTYPE not well documented.. What are valid options

[aboudreault]

Here's one more missing keyword in the documentation:

• STYLE->MAXWIDTH

[aboudreault]

Default value stated in documentation is wrong:

• STYLE->MAXSIZE : doc says 50 by default...... but it's 500. (See MS_MAXSYMBOLSIZE constant in mapserver.h)

[aboudreault]

WEB->OUTPUTFORMAT : outputformat is not recognized in the web object. Should be removed from the documentation.

[sdlime]

Would really be nice to get the MIN/MAXGEOWIDTH params covered...

Steve

[jmckenna]

thanks for the bump...I'll tackle this next.

[jmckenna]

In preparing to document the JOIN object, in testing (with MapServer 5.6.5) I found that if I set the HEADER, FOOTER, and TEMPLATE in the JOIN object my queries would always return "msQueryByPoint(): Search returned no results. No matching record(s) found" (even though there should have been results). If I set the HEADER, FOOTER, and TEMPLATE in the above MAP object I would get valid results and the JOIN would occur.

I will document the missing HEADER, FOOTER parameters in the JOIN object now, but please note that I was unable to get them to work with MapServer 5.6.5.

[jmckenna]

To clarify: setting HEADER, FOOTER, TEMPLATE in the *LAYER* object returns valid query results with the join. setting those 3 parameters inside the JOIN object return no results through a query.

[jmckenna]

I also attempted to document an example of joining a shapefile to a table in MySQL, but mapserv.exe crashes when attempting to do the query/join (with MapServer 5.6.5 and MySQL 5.1.49:

  JOIN
    NAME "test"
    CONNECTION "MYSQL:test,user=root,password=mysql,port=3306"
    CONNECTIONTYPE OGR
    TABLE "lookup"     
    FROM "ID"
    TO "ident"
    TYPE ONE-TO-ONE
  END

Even though that same connection works fine through ogrinfo.

So I cannot add the example to the docs, as I can't make it work myself :)

[aboudreault]

Just a quick guess: Does your query contain null shape? If so, turning off the DEBUG should do the trick. See changeset: ​http://trac.osgeo.org/mapserver/changeset/10354

[jmckenna]

Unfortunately no. I also tried joining from a cleaned GMAP parks shapefile to a different MySQL table...mapserv.exe crashes each time for every join attempt. I have spent so much time trying to join shp to MySQL that i must move on. I will add the steps to the doc, but unfortunately I have no way of knowing that they work.

[jmckenna]

(I am testing with trunk)

[sdlime]

I'd just leave MySQL out for the moment and document the other connections (I think only dbf, simple csv and postgres. Then file a ticket for your MySQL problems and we'll fix for 6.0.

Steve

[jmckenna]

I'm looking at web-queryformat,browseformat,legendformat...and I discovered a ticket where I said that i added them and checked them into SVN, 2 years ago (but they are not in svn now) ???!!!! ticket:1518 I vaguely do remember testing them. um, where did the text go? yikes i will look in svn...

[jmckenna]

they were overwritten with an old version it seems. solved.

[jmckenna]

I've made a lot of doc changes directly/indirectly as a result of this ticket:

• added join->HEADER/FOOTER params
• added JOIN->CONNECTIONTYPE examples
• added MySQL spatial instructions to MySQL vector page
• added note on mygis wiki page about deprecated, see MySQL vector page
• added LAYER->maxgeowidth/mingeowidth (and tested, I like it!!!)
• added LAYER->PLUGIN with example
• re-added WEB->QUERYFORMAT,BROWSEFORMAT,LEGENDFORMAT
• added outputformat note from tbonfort
• removed WEB->OUTPUTFORMAT (it's not even in the code anymore)
• added LAYER->CONNECTIONTYPE WFS , and added a note about mygis (sending users to MySQL vector page)
• changed type to double for style and label size/width (ticket:2766)
• changed STYLE->MAXSIZE default value to 500

Thanks for the feedback, keep it coming! :)

[jmckenna]

oh and I finally made a note on the old WEB->LOG parameter. finally :)