Opened 14 years ago

Closed 12 years ago

#159 closed enhancement (fixed)

Samples are a bit messy

Reported by: adube Owned by:
Priority: major Milestone:
Component: samples Version:
Keywords: Cc:

Description

I think we all agree that the samples are a little bit messy. Here's a list of the things we could do :

  • remove the images (which IMHO are no help at all and take space) and list them in a standard way, classified by widgets. For example :
* Widgets :
  * QueryOnClick
    * Simple
      Description of the "simple" sample
    * CustomWidgets
      Description of the "CustomWidgets" sample
  * ZoomSlider
    Description of the "ZoomSlider" unique sample
* Templates
  ....
  ....
  • Remove all "multiple" widgets samples, like BDGA, Sample1. If they show unique features, there should be new samples showing each one of them separately
  • Remove all samples showing deprecated widgets and also remove all deprecated widgets from all samples
  • have more "ext" templates for the samples (i.e. no full viewport, documentation embed in the sample, etc, link for the source files included, etc.)
  • instead of having one template per widget, why not have one for the entire samples (that would use the "ext" way of showing the features). It would include all non-deprecated widgets and also draw all of them too.

Priority

I think this enhancement is very important. Samples are usually the first points of entry for newcomers. Currently, they are hard to navigate...

Change History (19)

comment:1 by adube, 13 years ago

r925, featuring :

  • new samples.xslt template in ./src/client/templates directory to be used with all samples
  • the above template features the header.inc.html and footer.inc.html files, which plain html contents added before and after the map. Used to describe the samples.
  • new methods in ./samples/config.php to check if the above files exist in the sample, else use the ones in ./samples (which are blanks)
  • samples modified :
    • bdga -> removed
    • mapfishlayertree -> updated
    • mappanel/gymo -> updated
    • editfeature -> new (replaces bdga)

comment:2 by adube, 13 years ago

r926, featuring :

  • samples.xslt template updated :
    • mappanel width and height now "auto"
    • little hack to have the sample widget shown when not using viewport (which is the case in this template)
  • samples modified :
    • navtools -> removed
    • zoomslider -> added (replaces navtools)
    • scale -> updated
  • some old useless files removed

comment:3 by adube, 13 years ago

r927, featuring :

  • OneGeology sample updated :
    • xml config file moved from config dir to sample dir
    • vmap base layer was broken, replaced by WorldMap
    • sample files reorganized

comment:4 by adube, 13 years ago

r928, featuring :

  • samples.xslt template now blindly including a 'style.css' file in sample in order to be able to have a specific stylesheet per sample. Having no such file in a sample doesn't hurt.
  • samples updated :
    • proxycaching -> updated
    • htwindow -> updated

comment:5 by adube, 13 years ago

r929, featuring :

  • InitialView sample updated :
    • select page removed, links now in demo instead (in footer.inc.html)
    • direct link to the demo
    • mention of the UnselectAll widget as well

comment:6 by adube, 13 years ago

r930, r931, featuring :

  • All QueryOnClick and ResultExtGrid samples updated

comment:7 by adube, 13 years ago

r932, featuring :

  • samples.xslt template now checks if Shortcut widgets are present in a GeoExtToolbar. If so, it doesn't draw them in a panel.
  • All Shortcut samples updated :
    • intoolbar (updated)
    • activateresources (updated)
    • inpanel (removed, was duplicate of above)

comment:8 by adube, 13 years ago

r933, featuring :

  • some WMS service 'source' changed in samples to point to executable file in cgi-bin instead of defining map=/path/to/map.map

comment:9 by adube, 13 years ago

r934, featuring:

  • samples.xslt now drawing filetreepanel widgets
  • FileTreePanel sample --> updated

comment:10 by adube, 13 years ago

r935, featuring :

  • samples.xslt now drawing featurepanel_selector and geoextprintform
  • samples updated :
    • geoexttoolbar/customcontrols -> updated
    • geoexttoolbar/withseparator -> updated
    • geoexttoolbar/pgsqlconfig -> removed
    • pgsqlconfig/allwidgets -> new (replacement for above)

comment:11 by adube, 13 years ago

r936, r937, featuring :

  • all geoextprintform samples updated

comment:12 by adube, 13 years ago

r938, featuring :

  • all samples in geoextux directory updated :
    • geonamesearchcombo -> removed
    • redliningpanel -> removed
    • redliningpanelintoolbar -> updated
    • zoomto -> updated
    • shortcutcombo -> updated
    • layertreebuilder -> updated and now using MapPanel and Layer widgets instead of Map widget

comment:13 by adube, 13 years ago

r940, all the following samples were removed :

  • sandbox1
  • release
  • quickzoom
  • alloverlays
  • wmslayeradder
  • merge_split
  • sample0
  • helloworld
  • google

comment:14 by adube, 13 years ago

r941, featuring :

  • pdfprint widgets now printed by samples.xslt file
  • pdfprint sample updated

comment:15 by adube, 13 years ago

r947, featuring :

  • all XMLWorkspaceConfig samples updated :
    • complex_workspace -> removed
    • workspace -> removed
    • xmlworkspaceconfig -> added, replaces the 2 above, simpler, doesn't demonstrate widget 'overriding' though since it doesn't seem to work well with overridden widgets inside a toolbar

comment:16 by adube, 13 years ago

r948, featuring :

  • samples/sample1/default -> removed
  • samples/sample1/auth_xml -> removed
  • samples/borealisacl/xml -> new (replaces the one above)

comment:17 by adube, 13 years ago

This ticket now requires #179 to be fixed.

comment:18 by adube, 13 years ago

This ticket now also requires #185 to be fixed (since it's related to broken samples, which are not cool).

comment:19 by adube, 12 years ago

Resolution: fixed
Status: newclosed

The only things remaining in this ticket are :

  • reorganize the sample browsing on the website. I consider this a "wontfix".
  • #179
  • #185

So I'm closing this ticket as fixed.

Note: See TracTickets for help on using tickets.