Merge pull request #12 from ACHinrichs/dev

[hwa] Homeworkassignment v3.0

README.md

@@ -5,17 +5,40 @@ or use frequently. If I am not the author, this will be noted.
 ## Installation
 ### Classes and Styles
 #### Release
-Located on branch `master` just copy the `.sty` or `.cls` file into a
-directory LaTeX searches (eg `~/texmf/latex/` for TeXLive under
-Ubuntu).
-If you are using TeXLive (under Ubuntu) you may simply clone this repo to that
-directory, using MikTex makes things more complicated.
+##### From source
+If the class is not uploaded to CTAN (I am planning to upload all, but
+Iam lazy), clone the repository into a directory searched by
+LaTeX. (Using TexLive under Linux this directory could be
+`~/texmf/tex/latex`, using MikTech under Windows, this is
+configurable) and index them (TexLive+Linux `$ texhash`,
+MikTech+Windows Refresh teh osurces via the MikTech-Settings as
+Admin).
+
+##### From CTAN
+If I uploaded the class to CTAN, install them like any other class or package.
 #### Development versions
-Run LaTeX (not pdflatex) on the `.ins`-File. This will generate a new
-`.sty` or `.cls` file. Then just proceed as above.
+I am not always updating the .cls-files when developing new features,
+so when you want to use developtment-versions (why would you want to do
+that?) Proceed as above when installing from source, but after you
+checked out th branch `dev` for the class you want to use, run LaTeX (not
+pdflatex) on the `.ins`-File. This will generate a new `.sty` or
+`.cls` file. Then just proceed as above.
 #### Generate Documentation
 If the documentation in this repository does not correspond to the latest
-version of the corresponding package or class, just run pdfLaTeX on the `.dtx`file, which will generate a ready-to-use `.cls` file.
-## HomeworkAssignment
+version of the corresponding package or class, just run (pdf)LaTeX on
+the `.dtx`file.
+## homeworkassignment
 This class provides a relatively simple document–type for homework, mainly created
-for assignments at the University during my studies in Computer Science.
+for assignments at the University during my studies in Computer
+Science. 
+
+It features an easy to use sectioning, frequently used packages and
+configurations and macros fo mathematical functions and operators,
+which I need often.
+## cheatsheet
+I found out, that the sourcecode of Cheat-Sheets in LaTeX is always a
+hughe pile of badly documented code, which is basically identical for
+all CheatSheets, so I bundeled it in a class. Just load
+`\documentclass{cheatsheet}` and you are ready to go.
+
+Available on CTAN

homeworkassignment/HomeworkAssignment.ins → homeworkassignment/homeworkassignment.ins

@@ -71,22 +71,22 @@ SOFTWARE.
 
 
 \keepsilent
-\usedir{tex/latex/LaTeX-templates/HomeworkAssignment}
+\usedir{tex/latex/LaTeX-templates/homeworkassignment}
  
-\generate{\file{HomeworkAssignment.cls}{\from{HomeworkAssignment.dtx}{class}}}
+\generate{\file{homeworkassignment.cls}{\from{homeworkassignment.dtx}{class}}}
 
 %\obeyspace
 \Msg{****************************************************}
 \Msg{*                                                  *}
-\Msg{* Thanks for using my Homework Assignment class!   *}
+\Msg{*  Thanks for using my homeworkassignment class!   *}
 \Msg{*                                                  *}
 \Msg{* To finish the installation you, have to move the *}
 \Msg{* following file into a directory searched by TeX: *}
 \Msg{*                                                  *}
-\Msg{*      HomworkAssignment.ins                       *}
+\Msg{*              homworkassignment.ins               *}
 \Msg{*                                                  *}
 \Msg{* To produce the documentation compile the file    *}
-\Msg{* HomeworkAssignment.dtx with LaTeX                *}
+\Msg{* homeworkassignment.dtx with LaTeX                *}
 \Msg{*                                                  *}
 \Msg{* Happy TeXing!                                    *}
 \Msg{*                                                  *}

homeworkassignment/test.ex

+\documentclass[twoside]{HomeworkAssignment}
+\usepackage{lipsum}
+\author{Adrian C. Hinrichs Matr. 74656}
+\tutorium{\"Ubungsgruppe 42}
+\kurs{Analysis f\"ur Informatiker}
+\date{\today}
+\begin{document}
+\maketitle
+\newproblem
+\newsubproblem
+\lipsum[1]
+\newsubproblem
+\lipsum[2]
+\lipsum[3]
+\solution
+\lipsum[4]
+\solution[i]
+\lipsum[5]
+\subproblem{Schlussfolgerung}
+\newsubsubproblem
+\lipsum[1]
+\newsubsubproblem
+\lipsum[2]
+\newproblem
+\lipsum[4]
+\proof
+\lipsum[5]
+\problem{Bonusaufgabe}
+\lipsum[6]
+\proof[durch vollst\"andige Induktion]
+\lipsum[7]
+\end{document}

homeworkassignment/test.tex

+\documentclass[twoside]{homeworkassignment}
+\usepackage{lipsum}
+\author{Adrian C. Hinrichs Matr. 74656}
+\tutorium{\"Ubungsgruppe 42}
+\kurs{Analysis f\"ur Informatiker}
+\date{\today}
+\begin{document}
+\maketitle
+\makeGradingTable[6]
+\newproblem[2]{5,3}
+\newsubproblem
+\lipsum[1]
+\newsubproblem
+\lipsum[2]
+\lipsum[3]
+\solution
+\lipsum[4]
+\solution[i]
+\lipsum[5]
+\newsubproblem[3]{4}
+\newsubsubproblem{3}
+\lipsum[1]
+\newsubsubproblem[1]
+\lipsum[2]
+\newproblem
+\lipsum[4]
+\proof
+\lipsum[5]
+\problem{Bonusaufgabe}
+\lipsum[6]
+\proof[durch vollst\"andige Induktion]
+\lipsum[7]
+\QED
+\makeGradingTable
+\end{document}

todos.org

-#+STARTUP: showeverything 
+# +STARTUP: showeverything 
 This file lists all ToDos for all LaTeX-Packages and Classes in this
  Repo
 
+* TODO Rework Readme
+  - Installation is very outdated
+  - cheatsheet is not present in readme
+  - info about CTAN
+
 
 * cheatsheet
   - [ ] BUG: Footnotes appear all on the first page
 
 
 * HomeworkAssignment
-  - [ ] Rename to homeworkassignment
+** TODO [100%] v3.0
+  - [X] Rename to homeworkassignment
     - To comply to CTANs requirements of all lowercase packagenames.
-    - [ ] Add proof by contradiction environment
-  - [ ] Add points for excercises
-    - Expand \textbackslash {} newproblem newsubproblem etc by an
-      optional argument to take the maximum ammount of point one can
-      gain at this problem.
-      - When passed this is passed to \textbackslash{}newsubproblem,
+  - [X] Add proof by contradiction environment
+  - [X] Create environments for all existing proofs
+    - Contradiction, plain üroof and a varable one are implemented;
+      that should be enough
+  - [X] [2/2] Add points for excercises
+    - [X] Expand \textbackslash{}newproblem \textbackslash{}newsubproblem etc
+      by an optional argument to take the maximum ammount of point one
+      can gain at this problem. 
+      - [X] When passed this is passed to \textbackslash{}newsubproblem,
         create a box to write the points down
-      - Add this number of points to the »gradingtable«
-    - To implement this, the existing optional argument, taking
+      - [X] Add this number of points to the »gradingtable«
+    - [X] To implement this, the existing optional argument, taking
       the exercise number has to be replaced with an own command
-      - [ ] replace the optional argument of
+      - replace the optional argument of
         \textbackslash{}newproblem by a new command
         \textbackslash{}setproblemnumber
-    - [ ] Add Option to remove the hlines from the layout
-      - Standard hlines=all
-      - hlines=none remove all
-      - hlines=header just remove the hlines around the Title
+	- Solved different
+  - [X] Add Option to remove the hlines from the layout
+    - Standard hlines=all
+    - hlines=none remove all
+    - hlines=header just remove the hlines around the Title
+  - [X] Remove legacy styles
+  - [X] Rework Docu
+    - [X] Unite Implementation and Documentation part of Documentation
+    - [X] Document all features
+    - [X] Update Changelog
+  - [X] Add allowdisplaybreaks
+  - [X] BUG of onecolumn and maketitle
+    - Pull changes from NumRech u3
+  - [X] BUG Subproblem counter not reset on newproblem with number
+    (see NumRech u5)
+    - [X] Fix
+    - [X] Check if subsubproblem works!

todos.tex

-% Created 2017-09-04 Mo 17:10
+% Created 2017-11-19 So 12:50
 \documentclass[11pt]{article}
 \usepackage[utf8]{inputenc}
 \usepackage[T1]{fontenc}
@@ -31,45 +31,77 @@
 This file lists all ToDos for all \LaTeX{}-Packages and Classes in this
  Repo
 
+\section{{\bfseries\sffamily TODO} Rework Readme}
+\label{sec-1}
+\begin{itemize}
+\item Installation is very outdated
+\item cheatsheet is not present in readme
+\item info about CTAN
+\end{itemize}
+
 
 \section{cheatsheet}
-\label{sec-1}
+\label{sec-2}
 \begin{itemize}
 \item $\square$ BUG: Footnotes appear all on the first page
 \end{itemize}
 
 
 \section{HomeworkAssignment}
-\label{sec-2}
+\label{sec-3}
+\subsection{{\bfseries\sffamily TODO} [60\%] v3.0}
+\label{sec-3-1}
 \begin{itemize}
-\item $\square$ Rename to homeworkassignment
+\item $\boxtimes$ Rename to homeworkassignment
 \begin{itemize}
 \item To comply to CTANs requirements of all lowercase packagenames.
-\item $\square$ Add proof by contradiction environment
 \end{itemize}
-\item $\square$ Add points for excercises
+\item $\square$ Add proof by contradiction environment
+\item $\square$ Create environments for all existing proofs
+\item $\boxtimes$ [2/2] Add points for excercises
 \begin{itemize}
-\item Expand \textbackslash \{\} newproblem newsubproblem etc by an
-optional argument to take the maximum ammount of point one can
-gain at this problem.
+\item $\boxtimes$ Expand \textbackslash{}newproblem \textbackslash{}newsubproblem etc
+by an optional argument to take the maximum ammount of point one
+can gain at this problem. 
 \begin{itemize}
-\item When passed this is passed to \textbackslash{}newsubproblem,
+\item $\boxtimes$ When passed this is passed to \textbackslash{}newsubproblem,
 create a box to write the points down
-\item Add this number of points to the »gradingtable«
+\item $\boxtimes$ Add this number of points to the »gradingtable«
 \end{itemize}
-\item To implement this, the existing optional argument, taking
+\item $\boxtimes$ To implement this, the existing optional argument, taking
 the exercise number has to be replaced with an own command
 \begin{itemize}
-\item $\square$ replace the optional argument of
+\item replace the optional argument of
 \textbackslash{}newproblem by a new command
 \textbackslash{}setproblemnumber
+\begin{itemize}
+\item Solved different
+\end{itemize}
 \end{itemize}
-\item $\square$ Add Option to remove the hlines from the layout
+\end{itemize}
+\item $\boxtimes$ Add Option to remove the hlines from the layout
 \begin{itemize}
 \item Standard hlines=all
 \item hlines=none remove all
 \item hlines=header just remove the hlines around the Title
 \end{itemize}
+\item $\boxtimes$ Remove legacy styles
+\item $\boxminus$ Rework Docu
+\begin{itemize}
+\item $\boxtimes$ Unite Implementation and Documentation part of Documentation
+\item $\boxtimes$ Document all features
+\item $\square$ Update Changelog
+\end{itemize}
+\item $\boxtimes$ Add allowdisplaybreaks
+\item $\boxtimes$ BUG of onecolumn and maketitle
+\begin{itemize}
+\item Pull changes from NumRech u3
+\end{itemize}
+\item $\boxminus$ BUG Subproblem counter not reset on newproblem with number
+(see NumRech u5)
+\begin{itemize}
+\item $\boxtimes$ Fix
+\item $\square$ Check if subsubproblem works!
 \end{itemize}
 \end{itemize}
 % Emacs 25.1.1 (Org mode 8.2.10)