Code Monkey home page Code Monkey logo

notes-packages's Introduction

Notes-Packages

When I started university I started learning to use LaTeX. After my first year the preamble of my notes documents was large enough that I made a separate .sty file, called NotesPackage.sty. After another year this was a mess and I decided to start again. I created NotesPackage2. After a third year I wanted to greatly extend the package and the results of this are in this repository. The source for the initial NotesPackage and NotesPackage2 can be found here.

I decided to split the package into two packages and a class, each responsible for a different aspect of the document:

  • NotesClass — this class contains all code relevant to the set-up of the document.
  • NotesMaths — this package contains all code relevant to typesetting maths, including importing some common packages and defining some commands.
  • NotesBoxes — this package declares a lot of boxes from the tcolorbox package.

Details on how these three packages work is given here.

Also in this repository is a package called ParticlesPackage, which is simply a list of definitions for commands for inserting symbols for particles. All fundamental particles are included. Each particle typically has four commands associated with it, for example \Pelectron for an electron, or the short form \Pe, and \APelectron or \APe for an antielectron (positron). There are some package options for typesetting the particles as upright or italic (upright is the preffered standard but many people don't follow it). There are also three gluons (red, blue and green) which appear coloured in the document and a package option to turn this off.

As well as these packages I also wrote styles for glossaries/indexes to use with makeindex. To go with these I wrote a .bat script, mkindex.bat, which runs the necessary commands to compile the indices. To use this script simply edit in the paths to your .gst and .ist files, place the .bat in your PATH and then execute

mkindex <.tex file name without .tex extension>

For example, if your .tex file is main.tex run

mkindex main

Also included in this repository are .cwl files for the two packages and class. These are used by TeXtudio to autocomplete commands.

notes-packages's People

Contributors

willoughbyseago avatar

Stargazers

 avatar Karuna avatar

Watchers

 avatar

notes-packages's Issues

Update Documentation

Since changing NotesStyle.sty into NotesClass.cls the documentation is out of date.

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.