Class Examples

source code

                                       object --+    
                                                |    
                        grend.CustomTemplateMixin --+
                                                    |
                   object --+                       |
                            |                       |
       nevow.rend.DataFactory --+                   |
                                |                   |
                   object --+   |                   |
                            |   |                   |
     nevow.rend.RenderFactory --+                   |
                                |                   |
                   object --+   |                   |
                            |   |                   |
      nevow.rend.MacroFactory --+                   |
                                |                   |
                   object --+   |                   |
                            |   |                   |
 nevow.rend.ConfigurableMixin --+                   |
                                |                   |
              nevow.rend.Fragment --+               |
                                    |               |
   nevow.rend.ConfigurableFactory --+               |
                                    |               |
nevow.rend.FreeformChildMixin --+   |               |
                                |   |               |
      nevow.rend.ChildLookupMixin --+               |
                                    |               |
                      nevow.rend.Page --+           |
                                        |           |
                       object --+       |           |
                                |       |           |
           common.CommonRenderers --+   |           |
                                    |   |           |
                grend.GavoRenderMixin --+           |
                                        |           |
                           grend.GavoPage --+       |
                                            |       |
                      grend.ResourceBasedPage --+   |
                                                |   |
                           grend.ServiceBasedPage --+
                                                    |
                                                   Examples

A renderer for examples for service usage.

This renderer formats _example meta items in its service.  Its output
is XHTML compliant to VOSI examples; clients can parse it to, 
for instance, fill forms for service operation or display examples
to users.

The examples make use of RDFa to convey semantic markup.  To see
what kind of semantics is contained, try 
http://www.w3.org/2012/pyRdfa/Overview.html and feed it the
example URL of your service.

The default content of _example is ReStructuredText, and really, not much
else  makes sense.  An example for such a meta item can be viewed by
executing ``gavo admin dumpDF //userconfig``, in the tapexamples STREAM.

To support annotation of things within the example text, DaCHS
defines several RST extensions, both interpreted text roles (used like
``:role-name:`content with blanks```) and custom directives (used
to mark up blocks introduced by a single line like
``.. directive-name ::`` (the blanks before and after the
directive name are significant).

Here's the custom interpreted text roles:

* *dl-id*: An publisher DID a service returns data for (used in 
  datalink examples)
* *taptable*: A (fully qualified) table name a TAP example query is
  (particularly) relevant for; in HTML, this is also a link
  to the table description.
* *genparam*: A "generic parameter" as defined by DALI.  The values
  of these have the form param(value), e.g., :genparam:\`POS(32,4)\`.
  Right now, not parantheses are allowed in the value.  Complain
  if this bites you.

These are the custom directives:

* *tapquery*: The query discussed in a TAP example.

Examples for how to write TAP examples are in the userconfig.rd 
distributed with DaCHS.  Examples for Datalink examples can
be found in the GAVO RDs feros/q and califa/q3.