Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/korayulusan/korays-homework-sty

Koray's latex homework style package
https://github.com/korayulusan/korays-homework-sty

latex latex-package latex-style

Last synced: about 2 months ago
JSON representation

Koray's latex homework style package

Awesome Lists containing this project

README

        

# Koray's latex homework style

first page of showcase.pdf

This is the style I use in my homeworks. I thought there wasn't enough latex packages and decided to publish this.

You can find visuals [here](./showcase.pdf) and its `.tex` is [here](./showcase.tex).

## Installation

```sh
cd yourProject/
git submodule add https://github.com/KorayUlusan/korays-homework-sty
```

to uninstall:

```sh
cd yourProject/
git rm koray-tex-homework/
```

## Usage

```latex
% You need to include this package in your latex file.
% MAKE SURE YOU'VE SPECIFIED THE PATH CORRECT
\usepackage{./korays-homework-sty/korayHomework}
```

### Answering questions

Since homeworks have a defined structure, it made more sense to write the question numbers by hand. It makes the latex document more readable. (and avoid `\section*{1}`)

```latex
\question{1}
\subquestion{(a)}
\subsubquestion{(i)}
```

you can generate question numberings automatically via

```sh
./qgen.py -1a 3333

# to see help message, use
./qgen.py -h
```

to overwrite the default prefix of the questions add these

```latex
\renewcommand{\questionPreText}{Question }
\renewcommand{\questionPostText}{)}
\renewcommand{\subquestionPreText}{Part }
\renewcommand{\subquestionPostText}{)}
\renewcommand{\subsubquestionPreText}{}
```

### Text styles

```latex
\bdtexttt{text here}
\hltexttt{text here}
```

### Leaving notes

Its important to leave notes to your teampartners. Better communication better
results.

```latex
% first create a command per person
\newcommand{\noteKoray}[1]{\commentPerson{orange}{Note}{Koray}{#1}}

% then you can use it
\noteKoray{text here}
```

Examples:

```latex
\newcommand{\fixmeKoray}[1]{\commentPerson{red}{FixMe}{Koray}{#1}}
\newcommand{\questionKoray}[1]{\commentPerson{blue}{Question}{Koray}{#1}}
\newcommand{\noteKoray}[1]{\commentPerson{orange}{Note}{Koray}{#1}}
```

### Changing Color Theme

You can overwrite these theme colors

- `themeColor`
- `titleColor`
- `contourColor`
- `decorativeColor`
- `backdropcolor`
- `highlighcolor`

```latex
% for example
\definecolor{mycolor}{HTML}{FFD400} % hex must be capitals
\colorlet{themeColor}{mycolor} % overwrite
```

### Decorations
#### headrule

```latex
% you can change it via
\def\headrule{\hrcrown}
```

#### dividers

```latex
\hr
\hrdotted
\hrdotteds

\hrflower
\hrflowerl
\hrflowerr
```