Skip to content

ksm2/GlossaryIVCIP1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Glossary for IVC and IP1

This is a glossary for IVC and IP1.

Generate the Glossary

First of all, you need PHP 5.5 or higher and to get Composer:

curl -sS https://getcomposer.org/installer | php

Then, you can use the PHP-script to generate the Wiki and the LaTeX include file:

php src/main.php

To generate the glossary with LaTeX, use

xelatex glossary 
makeglossaries glossary 
xelatex glossary 
open glossary.pdf

(XeLaTeX comes with most LaTeX distributions.)

The wiki gets dumped to build/wiki/. When it gets pushed to Github, it can be displayed there.

How to Contribute

You need to edit the glossary-file located in src/glossary.txt.

Main Defintions

The language is as follows:

Key-Name: #Some #Tags #And #Some !images !located !in !img !folder
  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor 
  invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam 
  et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est 
  Lorem ipsum dolor sit amet.

So the body of a defintion is indented with a Tab ("\t").

References

To make references, use an arrow symbol => and write the referenced key afterwards. You can use sqaured brackets ([...]) to add some displayed text and curly brackets ({...}) to add text to referenced Key (won't be displayed).

Empty Definitions

Just leave out the body of a definition (you can still use tags and images, though).

Empty Key: - #Some #Tags !empty !image

About

Glossary for IVC and IP1.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published