mysociety / whatdotheyknow-theme

The Alaveteli theme for WhatDoTheyKnow (UK)
http://www.whatdotheyknow.com/
MIT License
31 stars 26 forks source link

Add a glossary to the site's help pages #1353

Closed confirmordeny closed 1 year ago

confirmordeny commented 2 years ago

Suggested text here: https://wdtkwiki.mysociety.org/wiki/Glossary

garethrees commented 2 years ago

This is fantastic!

mdeuk commented 2 years ago

This is fantastic!

Agreed, this is a fabulous body of work, thanks for kicking it off, @confirmordeny!

I wonder if we could use something like Tocbot to make it easily accessible for browsing users? This might have the handy benefit of acting as a starting point for resolving #878.

confirmordeny commented 2 years ago

A question for the coders ... what format would you want this in? For example, I know that html has special tags for glossaries (dl/dd/dt) I think I would be able to put the glossary in that format if it would help.

garethrees commented 2 years ago

what format would you want this in?

Definition lists seem appropriate for this, yeah:

<h2>A</h2>

<dl>
  <dt>Aarhus Convention</dt>
  <dd>The Aarhus Convention provides a right of access to environmental information. The Convention was signed in June 1998 in the Danish city of Aarhus. The full name of the Aarhus Convention is the UNECE Convention on Access to Information, Public Participation in Decision-making and Access to Justice in Environmental Matters.</dd>
  <dt>Absolute exemption </dt>
  <dd>An absolute exemption is one that is not subject to a public interest test.</dd>

  …
</dl>

<h2>B</h2>

<dl>
  <dt>Bulk request</dt>
  …
confirmordeny commented 1 year ago

I have created a file here - it isn't perfect but I have taken in about as far as I can: https://github.com/confirmordeny/whatdotheyknow-theme/blob/confirmordeny-work-in_progress-2/lib/views/help/glossary.html.erb

confirmordeny commented 1 year ago

This has been published: https://www.whatdotheyknow.com/help/glossary :)