Database config - documentation - widgets

[adube]

Some widgets can have different option values depending on which driver we use. For example, the !PDFPrint widget has to have a JSON 'templates' option value when using the new PGSQLMapContextConfig driver and it needs to be in XML when using other drivers.

How should we represent these differences ?

I suggest we have these differences noted inside the widget documentation directly.

[adube]

The new config driver documentation released in #92 has a topic showing all resource options that can be read by widgets in order to bind them together.

Would it make sense to create the same kind of documentation but inside the widget's doc ? To be more clear, would it be nice to have a list of resource option (both mandatory and optionals) for each widget ?

Comments would be welcomed.

[adube]

After implementing the new PGSQLMapContextConfig driver for the first time and having to setup each widgets using the current documentation, I can add more comments about this topic : we should definitively have a complete separate widget documentation for each driver types (XMLConfig and XMLWorkspace config could be together).

When adding a new widget, it is kinda confusing to look for the resource and field options required (and optional) by the widget in the PGSQLMapContextConfig driver documentation. Also, using the current widget documentation becomes confusing as well. There are options no longer supported that are listed (they were mostly moved as resource options), the xml samples don't apply, some option values have changed (the JSON option values are a good example, see in this ticket : #96)

IMHO, we should think of a way to have our 2 widget documentations.