git subrepo clone git@github.com:KWARC/LaTeX-bluenote.git LaTeX-bluenote

subrepo: subdir: "LaTeX-bluenote" merged: "0709a2d" upstream: origin: "git@github.com:KWARC/LaTeX-bluenote.git" branch: "master" commit: "0709a2d" git-subrepo: version: "0.3.1" origin: "git@github.com:ingydotnet/git-subrepo.git" commit: "a7ee886"

git subrepo clone git@github.com:KWARC/LaTeX-bluenote.git LaTeX-bluenote
cee8033e · Michael Kohlhase · cee8033e · cee8033e · cee8033e · cee8033e
Commit cee8033e authored 7 years ago by Michael Kohlhase
--- a/LaTeX-bluenote/.gitignore
+++ b/LaTeX-bluenote/.gitignore
+auto
+*.aux
+*.log
+*.glo
+*.out
+*.toc
+*-blx.bib
+*.bbl
+*.blg
+*.pdf
+*.run.xml
+*.synctex.gz
--- a/LaTeX-bluenote/.gitrepo
+++ b/LaTeX-bluenote/.gitrepo
+; DO NOT EDIT (unless you know what you are doing)
+;
+; This subdirectory is a git "subrepo", and this file is maintained by the
+; git-subrepo command. See https://github.com/git-commands/git-subrepo#readme
+;
+[subrepo]
+	remote = git@github.com:KWARC/LaTeX-bluenote.git
+	branch = master
+	commit = 0709a2d2310e6faed1ed3d99175adcd1c6885c95
+	parent = none
+	cmdver = 0.3.1
--- a/LaTeX-bluenote/Makefile
+++ b/LaTeX-bluenote/Makefile
+PACKAGE = bluenote
+all: $(PACKAGE).pdf
+
+$(PACKAGE).sty: $(PACKAGE).dtx $(PACKAGE).ins
+	pdflatex $(PACKAGE).ins
+
+$(PACKAGE).pdf: $(PACKAGE).dtx $(PACKAGE).sty
+	pdflatex $(PACKAGE).dtx
--- a/LaTeX-bluenote/README.md
+++ b/LaTeX-bluenote/README.md
+bluenote.sty: KWARC blue notes
+
+Copyright(c) 2012 Michael Kohlhase
+The package is distributed under the terms of the LaTeX Project Public License (LPPL)
+
+The development version of this package can be found at
+https://github.com/KWARC/LaTeX-bluenote
+
+# Using this repo in a paper repository
+We write most of our papers in ```git``` repositories, there it is usually a good idea to
+make this repository into an external sub-repository that can be updated as necessary. In
+the instructions below we assume that you - as the paper repos maintainer - want to add the
+KWARC LaTeX-bluenote as a sub-repository at path ```LaTeX-bluenote``` from the top of the paper
+repository.
+## The best way for GIT
+is via the ```git-subrepo``` extension of ```git```. Unfortunately this is not part of git
+(yet). So you as the paper repos maintainer have to
+[install it first](https://github.com/git-commands/git-subrepo#readme) if you want to
+install the KWARC LaTeX-bluenote as a subrepos. Your users do not, they will get the subrepos
+automatically on ```git clone``` or ```git pull```. 
+
+1. go to the top of your paper preository: ```cd path/to/top``` (you can only make a
+  "subrepo" from there) 
+2. add the KWARC LaTeX-bluenote repos as a "subrepo": ```git subrepo clone git@github.com:KWARC/LaTeX-bluenote.git LaTeX-bluenote```
+
+Note that under ```git-subrepo``` the "external" is not updated automatically, a
+maintainer has to "pull" it. This can be seen as a feature and not a bug (there is less of
+a chance to break things).
+
+1. go to the top of your paper preository: ```cd path/to/top``` (you can only pull from there)
+2. pull the KWARC LaTeX-bluenote repos as a "subrepo": ```git subrepo pull LaTeX-bluenote```
+
+To contribute changes back to the the KWARC LaTeX-bluenote repository, you analogously do 
+
+1. go to the top of your paper preository: ```cd path/to/top``` (you can only push from there)
+2. pull the KWARC LaTeX-bluenote repos as a "subrepo": ```git subrepo push LaTeX-bluenote```
+
+easypeasy!
+
+## The second best way for GIT
+is via ```git subtree```. 
+
+1. go to the top of your paper repository: ```cd path/to/top```
+2. add the KWARC LaTeX-bluenote repos as a remote: ```git remote add LaTeX-bluenote
+    git@github.com:KWARC/LaTeX-bluenote.git``` under the name ```LaTeX-bluenote```.
+3. add the remote ```LaTeX-bluenote```  as a subtree: ```git subtree add --prefix=LaTeX-bluenote LaTeX-bluenote master --squash```
+  (here under the path ```LaTeX-bluenote```). The ```--squash``` reduces history noise. 
+
+When you want to update the subrepository to the newest version, you have to "subtree
+pull" as above: 
+
+1. go to the top of your paper repository: ```cd path/to/top```
+2. subtree-pull: ```git subtree pull --prefix=LaTeX-bluenote LaTeX-bluenote master --squash```
+  this is a bit inconvenient, but works well.
+
+Contributing back to the KWARC LaTeX-bluenote repository is somewhat more complex; RTFM!
+
+## Externals in SVN
+In a subversion repository you can must make an external by
+
+1. go to the top of your paper preository: ```cd path/to/top```
+2. make the ```lib``` subdir if necessary: ```mkdir lib```
+3. add the external: ```svn propedit svn:externals lib```
+4. an editor will appear, add the line ```LaTeX-bluenote LaTeX-bluenote https://github.com/KWARC/LaTeX-bluenote/trunk```
+5. commit your work: ```svn commit -m'adding external for the KWARC LaTeX-bluenote'```
+
+Note that in SVN any ```snv update``` will update the KWARC LaTeX-bluenote in the external as well. 
--- a/LaTeX-bluenote/bluenote.cls
+++ b/LaTeX-bluenote/bluenote.cls
+%%
+%% This is file `bluenote.cls',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% bluenote.dtx  (with options: `cls')
+%% 
+\NeedsTeXFormat{LaTeX2e}[1999/12/01]
+\ProvidesClass{bluenote}[2012/07/20 v0.2 Blue notes]
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
+\ProcessOptions
+\LoadClass{article}
+\RequirePackage{a4wide}
+\RequirePackage{url}
+\RequirePackage{xspace}
+\RequirePackage{paralist}
+\RequirePackage{draftwatermark}
+\SetWatermarkScale{8}
+\SetWatermarkAngle{50}
+\SetWatermarkText{Blue Note}
+\SetWatermarkFontSize{3cm}
+\SetWatermarkLightness{.9}
+\newcommand\blueProject[1]{\def\blue@project{#1}}
+\blueProject{KWARC}
+\newif\ifblueURI\blueURItrue
+\newcommand\noblueURI{\blueURIfalse}
+\newcommand\blueURI{\urldef{\blue@URI}\url}
+\blueURI{http://kwarc.info}
+\def\title#1{\gdef\@title{--- {\blue@project} Blue Note\thanks{Inspired by the ``blue book''
+      in Alan Bundy's group at the University of Edinburgh, {\blue@project} blue notes,
+      are documents used for fixing and discussing $\epsilon$-baked ideas in projects by
+      the {\blue@project} group\ifblueURI\ (see \blue@URI)\fi. Unless specified otherwise, they are for
+      project-internal discussions only. Please only distribute outside the
+      {\blue@project} group after consultation with the author.}\quad ---\\ #1}}
+\endinput
+%%
+%% End of file `bluenote.cls'.
--- a/LaTeX-bluenote/bluenote.dtx
+++ b/LaTeX-bluenote/bluenote.dtx
+% \iffalse meta-comment
+% Editorial Notes for LaTeX
+% Copyright (c) 2009 Michael Kohlhase, all rights reserved
+%
+% This file is distributed under the terms of the LaTeX Project Public
+% License from CTAN archives in directory  macros/latex/base/lppl.txt.
+% Either version 1.0 or, at your option, any later version.
+%  
+% The development version of this file can be found at
+% https://github.com/KWARC/LaTeX-bluenote
+% \fi
+% 
+% \iffalse
+%<cls>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
+%<cls>\ProvidesClass{bluenote}[2012/07/20 v0.2 Blue notes]
+%
+%<*driver>
+\documentclass[twoside]{ltxdoc}
+\DoNotIndex{\def,\long,\edef,\xdef,\gdef,\let,\global}
+\DoNotIndex{\begin,\AtEndDocument,\newcommand,\newcounter,\stepcounter}
+\DoNotIndex{\immediate,\openout,\closeout,\message,\typeout}
+\DoNotIndex{\section,\scshape,\arabic}
+\EnableCrossrefs
+%\CodelineIndex
+%\OnlyDescription
+\RecordChanges
+\usepackage{textcomp,url,a4wide}
+\usepackage[show]{ed}
+\usepackage[eso-foot,today,draft]{svninfo}
+\usepackage{hyperref}
+%\makeindex
+\begin{document}
+\DocInput{bluenote.dtx}
+\end{document}
+%</driver>
+% \fi
+% 
+%\CheckSum{49}
+% 
+% \changes{v0.1}{2012/04/06}{First Version with Documentation}
+% \changes{v0.2}{2012/07/20}{making the group customizable}
+% 
+% \GetFileInfo{bluenote.cls}
+% 
+% \MakeShortVerb{\|}
+% \title{KWARC Blue Notes\thanks{Version {\fileversion} (last revised
+%        {\filedate})}} 
+%    \author{Michael Kohlhase\\
+%            Computer Science, Jacobs University\\
+%            \url{http://kwarc.info/kohlhase}}
+% \maketitle
+%
+% \begin{abstract}
+%   This package provides a tailored document class for KWARC blue notes, a special
+%   document for fixing and discussing $\epsilon$-baked ideas. 
+% \end{abstract}
+%
+% \tableofcontents\newpage
+%
+% \section{Introduction}\label{sec:intro}
+% 
+% Inspired by the ``blue book'' in Alan Bundy's group at the University of Edinburgh,
+% KWARC blue notes are documents used for fixing and discussing $\epsilon$-baked ideas in
+% projects by the KWARC group (see \url{http://kwarc.info}). Unless specified otherwise,
+% they are for project-internal discussions only. 
+% 
+% The |bluenote| class is a specialization of the |article| class with decorations to make
+% the status of being a blue note clear.
+% 
+% The development version of the |bluenote| class can be found at
+% \url{https://github.com/KWARC/LaTeX-bluenote}
+%
+% \section{The User Interface}\label{sec:user-interface}
+% 
+% The |bluenote| class is almost automatic for KWARC, for other projects, we have to 
+% 
+% \subsection{Customizing for other Projects/Groups}
+%
+% The |bluenote| class uses internal macros for the KWARC project name and the KWARC URI,
+% they can be redefined by \DescribeMacro{\blueProject}|\blueProject| and
+% \DescribeMacro{\blueURI}|\blueURI|, e.g. by putting 
+% \begin{verbatim}
+% \blueProject{Foo}
+% \blueURI{http://bar.org/~bar}
+% \end{verbatim}
+% into the document preamble. If the project does not have a URI, this can be specified by
+% the \DescribeMacro{\noblueURI}|\noblueURI| macro.
+%
+% \subsection{Package Options}
+%
+% The |bluenote| class accepts all the options that the |article| class does.
+%
+% \StopEventually{\newpage\PrintChanges}\newpage
+%
+% \section{The Implementation} 
+%
+% The implementation is rather standard. We first set up the options for the package.
+%
+% \subsection{Package Options}
+%
+% We just pass the options to |article.cls|
+%    \begin{macrocode}
+%<*cls>
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
+\ProcessOptions
+%    \end{macrocode}
+% The next step is to load the packages we want and configure them. 
+%    \begin{macrocode}
+\LoadClass{article}
+\RequirePackage{a4wide}
+\RequirePackage{url}
+\RequirePackage{xspace}
+\RequirePackage{paralist}
+\RequirePackage{draftwatermark}
+\SetWatermarkScale{8}
+\SetWatermarkAngle{50}
+\SetWatermarkText{Blue Note}
+\SetWatermarkFontSize{3cm}
+\SetWatermarkLightness{.8}
+%    \end{macrocode}
+%    This ends the package setup code, so we can come to the implementation of the
+%    functionality of the package. 
+%
+% \subsection{Customization}
+%
+% \begin{macro}{\blueProject}
+%    \begin{macrocode}
+\newcommand\blueProject[1]{\def\blue@project{#1}}
+\blueProject{KWARC}
+%    \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\noblueURI}
+%    \begin{macrocode}
+\newif\ifblueURI\blueURItrue
+\newcommand\noblueURI{\blueURIfalse}
+%    \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\blueURI}
+%    \begin{macrocode}
+\newcommand\blueURI{\urldef{\blue@URI}\url}
+\blueURI{http://kwarc.info}
+%    \end{macrocode}
+% \end{macro}
+%
+% \subsection{Title Page}
+%
+% \begin{macro}{\title}
+%    We start with the configuration part, predefining
+%    |\epdnoteshape| to be sans serif. 
+%    \begin{macrocode}
+\def\title#1{\gdef\@title{--- {\blue@project} Blue Note\thanks{Inspired by the ``blue book''
+      in Alan Bundy's group at the University of Edinburgh, {\blue@project} blue notes,
+      are documents used for fixing and discussing $\epsilon$-baked ideas in projects by
+      the {\blue@project} group\ifblueURI\ (see \blue@URI)\fi. Unless specified otherwise, they are for
+      project-internal discussions only. Please only distribute outside the
+      {\blue@project} group after consultation with the author.}\quad ---\\ #1}}
+%</cls>
+%    \end{macrocode}
+% \end{macro}
+% \Finale
+\endinput
+
+% LocalWords:  LPPL dtx ednote ednotes todolist newpart oldpart serif todo ToDo
+% LocalWords:  EdNote BegNP EndNP BegOP EndOP EdNotes MiKo ednotemessage textbf
+% LocalWords:  usepackage kohlhase HeadURL iffalse nomargins edissue maketitle
+% LocalWords:  fileversion textvisiblespace textvisiblespace marginpar newif
+% LocalWords:  DescribeEnv edexplanation edexplanation ednoteshape showednotes
+% LocalWords:  ifshowednotes showednotesfalse ifmargins marginstrue compactenum
+% LocalWords:  showednotestrue marginsfalse xcolor epdnoteshape sffamily endnew
+% LocalWords:  newcounter footnotetext scshape addtocounter footnotemark bgroup
+% LocalWords:  ednotelabel tweaklabel edissuelabel providecommand theednote
+% LocalWords:  newpartlabels newenvironment oldpartlabels todolabel egroup
+% LocalWords:  endcomment endtodo endtodolist ifnum typeout Oldparts
+% LocalWords:  automtatically
--- a/LaTeX-bluenote/bluenote.ins
+++ b/LaTeX-bluenote/bluenote.ins
+%%
+%% This file generates files required to use the ed package.
+%% At your command prompt write
+%%
+%%     latex ed.ins
+%%
+%% Copyright(c) 2007 Michael Kohlhase
+%% The development version of this file can be found at
+%% $HeadURL: https://svn.kwarc.info/repos/kwarc/doc/macros/forCTAN/bluenote/bluenote.ins $
+%%
+%% This file is distributed under the terms of the LaTeX Project Public
+%% License from CTAN archives in directory  macros/latex/base/lppl.txt.
+%% Either version 1.0 or, at your option, any later version.
+%%
+\input docstrip
+\preamble
+\endpreamble
+
+%\usedir{tex/latex/listings}
+\keepsilent
+\askforoverwritefalse
+
+% generate base package
+\generate{\file{bluenote.cls}{\from{bluenote.dtx}{cls}}}
+
+\Msg{*}
+\Msg{* You probably need to move the file bluenote.cls into a directory searched by TeX.}
+\Msg{*}
+\Msg{* And don't forget to refresh your filename database}
+\Msg{* if your TeX distribution uses such a database.}
+\Msg{*}
+
+\endbatchfile
--- a/LaTeX-bluenote/bluenote.pdf
+++ b/LaTeX-bluenote/bluenote.pdf
--- a/LaTeX-bluenote/note.tex
+++ b/LaTeX-bluenote/note.tex
+\documentclass{bluenote}
+\usepackage[show]{ed}
+\usepackage{listings}
+\lstset{basicstyle=\sf,columns=fullflexible}
+\usepackage[hyperref,backend=bibtex,style=alphabetic]{biblatex}
+\addbibresource{../bibs/kwarcpubs.bib}
+\addbibresource{../bibs/extpubs.bib}
+\addbibresource{../bibs/kwarccrossrefs.bib}
+\addbibresource{../bibs/extcrossrefs.bib}
+\usepackage{hyperref}
+
+\title{Blue Notes -- Writing down $\epsilon$-baked ideas in {\LaTeX}}
+\author{Michael Kohlhase\\
+  Computer Science, FAU Erlangen-N\"urnberg\\
+  \url{http://kwarc.info/kohlhase}}
+
+\begin{document}
+\maketitle
+\begin{abstract}
+  This is a skeleton for a blue note.
+\end{abstract}
+
+\section{Introduction}\label{sec:intro}
+
+Blue notes are a great way to preserve your ideas. 
+
+\section{Workflow}\label{sec:main}
+
+You choose a repository for your blue notes, e.g. \url{http://gl.kwarc.info/jdoe/blue},
+and make \lstinline|git subrepo|s for the KWARC bibs~\cite{KBibs:on} and the
+\lstinline|bluenote| class~\cite{BlueNote:on} (see the \lstinline|README.md| files for
+details), then you can copy this paper into a subdir of \lstinline|blue|, and just start
+writing.
+
+It is a good idea to write from the middle (i.e. intro/conclusion last) and use the
+\lstinline[language=TeX]|\ednote| macro~\cite{ed:on} to mark up editorial comments to
+yourself -- e.g. what you still need to introduce for the text to make sense.
+
+\section{Conclusion}\label{sec:concl}
+
+Blue notes are a great way to preserve your ideas. The \lstinline|bluenote| class makes it
+easier for {\LaTeX} users. 
+
+\begin{sloppypar}
+\printbibliography
+\end{sloppypar}
+\end{document}
+
+%%% Local Variables: 
+%%% mode: latex
+%%% TeX-master: t
+%%% End: