diff --git a/README.md b/README.md index 0f5aeed..c5911ae 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,11 @@ regular LaTeX documents without many modifications, which could be natively run Compared to other existing packages, presenter won't need any additional frame or slide environment to split different pages, but uses sectioning commands as the natural way to split different points. -**This project is still a Work In Progress (WIP).** Since it is still in the development state, you need to unpack the dtx files before using the package. Use the command +**This project is still a Work In Progress (WIP).** + +## Usage + +Since it is still in the development state, you need to unpack the dtx files before using the package. Use the command ``` l3build unpack @@ -18,8 +22,20 @@ latex presenter.ins ``` to get the unpacked style files as the dependency of your document. Or you could install the tds zip `presenter.tds.zip` from the release section to your computer for global use. +## Examples + You can see more examples in the [`testfiles/`](testfiles/) folder. Refer to the documentation for more instructions. +## Documentation + +The test results from [`testfiles/`](testfiles/) are used in the documentation, thus to compile the documentation, the check should be run first. +``` +l3build check +l3build doc +``` + +## Showwheel + ```diff -\documentclass{article} +\documentclass{presenter} diff --git a/doc/presenter.tex b/doc/presenter.tex index edb8559..1a6fd74 100644 --- a/doc/presenter.tex +++ b/doc/presenter.tex @@ -23,7 +23,7 @@ \NewDocumentCommand{\presenter}{}{\textsc{Presenter}} \title{\presenter: A \LaTeX{} presentation framework with seamless migration} \author{Log Creative} -\date{2023-06-24 \quad v0.2.5} +\date{2023-06-29 \quad v0.3.0} \usepackage{graphicx} \NewDocumentCommand{\previewtest}{O{1} m}{ @@ -67,7 +67,7 @@ run by any latest \TeX{} distributions. Compared to other existing packages, \presenter{} won't need any additional - \env{frame} or \env{slide} environment to split different pages, but uses + \env{frame} or \env{slide} environments to split different pages, but uses sectioning commands as the natural way to split different points. This package can not summarize the contents yet but it is promising to have such a function in other ways in the future. diff --git a/source/presenter.dtx b/source/presenter.dtx index 065ec9b..973550c 100644 --- a/source/presenter.dtx +++ b/source/presenter.dtx @@ -24,7 +24,7 @@ %\ProvidesExplClass %\ProvidesExplPackage {presenter} - {2023-06-24}{v0.2.5} + {2023-06-29}{v0.3.0} % {A LaTeX presentation framework with seamless migration (class)} % {A LaTeX presentation framework with seamless migration (package)} % @@ -249,6 +249,10 @@ % For the stared version of the sectioning command, \tn{@ssect} will be called % as the child command. No typesetting in the body and insert the information to % the mark. +% +% NOTICE: since there is no name or level of the sectioning in the paramenters +% of \tn{@ssect}, the current implementation will make displaying the star +% sectioning look identical despite of different levels of starred sectioning. % \begin{arguments} % \item indent % \item beforeskip diff --git a/source/pretbg.dtx b/source/pretbg.dtx index 429b0fe..578a3ae 100644 --- a/source/pretbg.dtx +++ b/source/pretbg.dtx @@ -23,7 +23,7 @@ % {pretbg-default} % {pretbg-block} % {pretbg-l3block} - {2023-06-24}{v0.2.5} + {2023-06-29}{v0.3.0} % {default background style for presenter} % {block background style for presenter} % {block background style for presenter implemented in l3draw} diff --git a/source/pretfg.dtx b/source/pretfg.dtx index c6608cd..aa927cf 100644 --- a/source/pretfg.dtx +++ b/source/pretfg.dtx @@ -22,7 +22,7 @@ \ProvidesExplPackage % {pretfg-default} % {pretfg-dual} - {2023-06-24}{v0.2.5} + {2023-06-29}{v0.3.0} % {default foreground style for presenter} % {dual foreground style for presenter} % @@ -167,7 +167,6 @@ % \end{macrocode} % \begin{variable}[int]{\c_@@_fg_headline_lowest_sec_lv_int} % The lowest section level constant. -% FIXME: Maybe refactored. % \begin{macrocode} \int_const:Nn \c_@@_fg_headline_lowest_sec_lv_int { 10 } % \end{macrocode} @@ -201,8 +200,6 @@ \box_new:N \l_@@_fg_headline_parent_box % \end{macrocode} % \end{variable} -% -% FIXME: Maybe mark is not necessary. % \begin{macrocode} \NewMarkClass { pretprevmark } \NewMarkClass { pretcurmark }