prepare for release

fmarotta · Mar 23, 2021 · e7498ba · e7498ba
1 parent a6a0168
commit e7498ba
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 18 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,8 +2,16 @@
 Changelog for package kaobook
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+0.9.6 (2021/03/23)
+------------------
+* Short margin tocs
+* Dynamic section-number-width in the margintoc
+* Use kvoptions instead of xkeyval
+* Slight modification of the page layout so that margin and wide pages 
+  have the same total width
+
 0.9.5 (2020/12/30)
-------------
+------------------
 * Use \DeclareCiteCommand in kaobiblio.sty (fixes #68)
 * Support f24paper
 * Include scrhack
@@ -15,13 +23,13 @@ Changelog for package kaobook
 * Set default chapter styles for front-, main-, and back- matter
 
 0.9.0 (2020/12/02)
-----------------
+------------------
 * First official release on GitHub
 * Define \hscale and \vscale, and rescale lengths accordingly
 * Allow user to choose papersize in the documentclass options
 
-1.3 (2020/02/18)
-----------------
+Ancient history
+---------------
 * Add the sidecite command modified to work with BibTeX
 * Add an example on how to use the kao_book template with BibTeX
 * Add short way to references equations, chapters and sections

diff --git a/examples/documentation/chapters/textnotes.tex b/examples/documentation/chapters/textnotes.tex
@@ -111,6 +111,17 @@ \section{Margintoc}
 \chapter{Chapter title}
 \end{lstlisting}
 
+As the space in the margin is a valuable resource, we have defined also 
+the \Command{margintocshort} command, which is roughly equivalent to the 
+normal \Command{margintoc}, except that it prints another version of the 
+section title. This version should be shorter than the real section 
+title and can be specified by the user when creating the section using 
+the following syntax:
+
+\begin{lstlisting}[style=kaolstplain]
+\section[alternative-title-for-toc]{title-as-written-in-text}[alternative-title-for-margintoc]
+\end{lstlisting}
+
 \section{Marginlisting}
 
 On some occasions it may happen that you have a very short piece of code 

diff --git a/examples/minimal_report/main.pdf b/examples/minimal_report/main.pdf
diff --git a/kaobook.cls b/kaobook.cls
@@ -1,7 +1,7 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % kaobook
 % LaTeX Class
-% Version 0.9.5 (2020/12/30)
+% Version 0.9.6 (2021/03/23)
 %
 % This template originates from:
 % https://www.LaTeXTemplates.com
@@ -25,10 +25,9 @@
 %----------------------------------------------------------------------------------------
 
 \NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{kaobook}[2020/12/30 v0.9.5 kaobook]
+\ProvidesClass{kaobook}[2021/03/23 v0.9.6 kaobook]
 \newcommand{\@baseclass}{scrbook} % Base class name
 
-%\RequirePackage{xkeyval} % Manage class key-value options
 \RequirePackage{kvoptions} % Manage class key-value options
 
 \SetupKeyvalOptions{

diff --git a/kaohandt.cls b/kaohandt.cls
@@ -1,7 +1,7 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % kaobook
 % LaTeX Class
-% Version 0.9.5 (2020/12/30)
+% Version 0.9.6 (2021/03/23)
 %
 % This template originates from:
 % https://www.LaTeXTemplates.com
@@ -25,22 +25,29 @@
 %----------------------------------------------------------------------------------------
 
 \NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{kaohandt}[2020/12/30 v0.9.5 kaohandt]
-
-\RequirePackage{xkeyval} % Manage class key-value options
-
+\ProvidesClass{kaohandt}[2021/03/23 v0.9.6 kaohandt]
 \newcommand{\@classname}{kaohandt} % Class name
 \newcommand{\@baseclass}{scrartcl} % Base class name
 
-\newcommand{\@secnumdepth}{2} % Set default numbering depth up to subsections
-\DeclareOptionX{secnumdepth}{% % Declare secnumdepth as an option
-	\renewcommand{\@secnumdepth}{#1}%
+\RequirePackage{kvoptions} % Manage class key-value options
+
+\SetupKeyvalOptions{
+    family = kao,
+    prefix = kao@
 }
 
 % Set the default options
 \PassOptionsToClass{a4paper}{\@baseclass}
-\DeclareOptionX*{\PassOptionsToClass{\CurrentOption}{\@baseclass}} % Pass through any options to the base class
-\ProcessOptionsX\relax % Process the options
+
+% Define kao-specific options
+\DeclareStringOption[1]{secnumdepth}
+
+% Pass through any other options to the base class
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\@baseclass}} 
+
+\ProcessKeyvalOptions*
+\ProcessOptions\relax % Process the options
+
 \LoadClass{\@baseclass} % Load the base class
 \input{styles/kao.sty} % Load the code common to all classes
 
@@ -86,7 +93,7 @@
 %	NUMBERING
 %----------------------------------------------------------------------------------------
 
-\setcounter{secnumdepth}{\@secnumdepth} % Set section numbering depth
+\setcounter{secnumdepth}{\kao@secnumdepth} % Set section numbering depth
 
 \counterwithin*{sidenote}{section} % Uncomment to reset the sidenote counter at each section
 %\counterwithout{sidenote}{section} % Uncomment to have one sidenote counter for the whole document