[OpenLayers-Dev] best practices in examples

Marc Jansen jansen at terrestris.de
Fri Sep 17 07:19:03 EDT 2010


Hi Chris,

On 17.09.2010 12:48, christopher.schmidt at nokia.com wrote:
> On Sep 17, 2010, at 6:14 AM, ext Marc Jansen wrote:
>
>    
>> Hi all,
>>
>> Since tags are now being used by the search box, I would add the notice to provide comma-seperated tags for the respective example inside a div with id = "tags", e.g.:
>>
>>          <div id="tags">
>>              panning, animation, effect, smooth, panMethod
>>          </div>
>>
>> While going through the examples at the FOSS4G codesprint, I again realised that the presentation of the examples could possibly enhanced:
>> 	• The search box should auto-suggest (and -complete), since only "full" matches will give results at all
>> 	• maybe we could agree on certain standard tags like e.g. "basic"/"enhanced", ... to naturally group the examples by topics
>> 	• The tags under the shortdesc of the examples on the left side should be clickable links, that do a search by the clicked tag
>> 	• Every documentation file should include a link to the examples page that filters the examples by an appropriate keyword, so that when you are seeing the docs for OpenLayers.Layer.Google a link like "http://openlayers.org/dev/examples/?q=google" is included
>>      
> Is this different from the #3 immediately previous?
>    

No, it's basically the same. But it is a different area where these 
links should be added: in the JS-files that are used to generate the 
documentation.

Regards,
Marc


More information about the Dev mailing list