Git Product home page Git Product logo

glossaryivcip1's Introduction

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

glossaryivcip1's People

Contributors

ksm2 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.