You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
camilo 80310136e6 Update Read me 3 years ago
README.md Update Read me 3 years ago

README.md

Glossary-making-tool

This is a Work-in-progress experiment tool to make living glossaries Webpages using simple Python, Javascript, and CSS from an Etherpad/Markdown file.

What makes it living?

  • The glossary structure uses the idea of 'gloss' that means annottation and layer. It makes the glossary a layering of anotations rather than a list of definitions. The pad template uses each word as a card with multiple annotations. See the example.

  • Being written in a markdown file makes it permeable to changes, new elements and transformations.

  • It also offers the option of add properties to each word in order to find connections and multiple types of organization between them.

PD: This tool is also published as a JupyterLab notebook which makes easier to run. Find here how to install JupyterLab in your computer and here the notebook. It would simplify the process of writing the Glossary environment.

How to use it?

If you are interested into make a glossary that you can expand and easily manipulate via markdownfile. You can write any name of in the input field, this will create a new glossary environment.

What do you need?

  • python: extract the information from the pad and write the content for the website.
  • Markdown File: all words for the glossary are collected here. (It can be written in a pad Instance)
  • stylesheet: all CSS rules for the Glossary are collected here (written in CSS)
  • html: render the lay out as a HTML (rendered with PyPandoc)
  1. Write the Markdown File with the first Glossary Words. Each word