\documentclass[DIV=13,%
               BCOR=0mm,%
               headinclude=false,%
               footinclude=false,open=any,%
               fontsize=10pt,%
               oneside,%
               paper=a5]%
               {scrbook}






\usepackage[noautomatic]{imakeidx}



\usepackage{microtype}
\usepackage{graphicx}
\usepackage{alltt}
\usepackage{verbatim}
\usepackage[shortlabels]{enumitem}
\usepackage{tabularx}
\usepackage[normalem]{ulem}
\def\hsout{\bgroup \ULdepth=-.55ex \ULset}
% https://tex.stackexchange.com/questions/22410/strikethrough-in-section-title
% Unclear if \protect \hsout is needed. Doesn't looks so
\DeclareRobustCommand{\sout}[1]{\texorpdfstring{\hsout{#1}}{#1}}
\usepackage{wrapfig}

% avoid breakage on multiple <br><br> and avoid the next [] to be eaten
\newcommand*{\forcelinebreak}{\strut\\*{}}

\newcommand*{\hairline}{%
  \bigskip%
  \noindent \hrulefill%
  \bigskip%
}

% reverse indentation for biblio and play

\newenvironment*{amusebiblio}{
  \leftskip=\parindent
  \parindent=-\parindent
  \smallskip
  \indent
}{\smallskip}

\newenvironment*{amuseplay}{
  \leftskip=\parindent
  \parindent=-\parindent
  \smallskip
  \indent
}{\smallskip}

\newcommand*{\Slash}{\slash\hspace{0pt}}


% http://tex.stackexchange.com/questions/3033/forcing-linebreaks-in-url
\PassOptionsToPackage{hyphens}{url}\usepackage[hyperfootnotes=false,hidelinks,breaklinks=true]{hyperref}
\usepackage{bookmark}

\usepackage[english,shorthands=off]{babel}
\babelfont{rm}[Path=/usr/share/texmf/fonts/opentype/public/tex-gyre/,%
 BoldFont=texgyrepagella-bold.otf,%
 BoldItalicFont=texgyrepagella-bolditalic.otf,%
 ItalicFont=texgyrepagella-italic.otf]{texgyrepagella-regular.otf}
\babelfont{tt}[Scale=MatchLowercase,%
 Path=/usr/share/fonts/truetype/cmu/,%
 BoldFont=cmuntb.ttf,%
 BoldItalicFont=cmuntx.ttf,%
 ItalicFont=cmunit.ttf]{cmuntt.ttf}
\babelfont{sf}[Scale=MatchLowercase,%
 Path=/usr/share/fonts/truetype/cmu/,%
 BoldFont=cmunsx.ttf,%
 BoldItalicFont=cmunso.ttf,%
 ItalicFont=cmunsi.ttf]{cmunss.ttf}



\renewcommand*{\partpagestyle}{empty}


% global style

\pagestyle{plain}




\usepackage{indentfirst}

% remove the numbering
\setcounter{secnumdepth}{-2}

% remove labels from the captions
\renewcommand*{\captionformat}{}
\renewcommand*{\figureformat}{}
\renewcommand*{\tableformat}{}
\KOMAoption{captions}{belowfigure,nooneline}
\addtokomafont{caption}{\centering}







\deffootnote[3em]{0em}{4em}{\textsuperscript{\thefootnotemark}~}


\addtokomafont{disposition}{\rmfamily}
\addtokomafont{descriptionlabel}{\rmfamily}


\frenchspacing
% avoid vertical glue
\raggedbottom

% this will generate overfull boxes, so we need to set a tolerance
% \pretolerance=1000
% pretolerance is what is accepted for a paragraph without
% hyphenation, so it makes sense to be strict here and let the user
% accept tweak the tolerance instead.
\tolerance=200
% Additional tolerance for bad paragraphs only
\setlength{\emergencystretch}{30pt}

% (try to) forbid widows/orphans
\clubpenalty=10000
\widowpenalty=10000





% given that we said footinclude=false, this should be safe
\setlength{\footskip}{2\baselineskip}
\setlength{\parindent}{15pt}

\title{Version 2.5}
\date{}
\author{}
\subtitle{}






% https://groups.google.com/d/topic/comp.text.tex/6fYmcVMbSbQ/discussion
\hypersetup{%
pdfencoding=auto,
pdftitle={Version 2.5},%
pdfauthor={},%
pdfsubject={},%
pdfkeywords={releases}%
}


\begin{document}









  \begin{titlepage}


  \strut\vskip 2em
  \begin{center}

  {\usekomafont{title}{\huge Version 2.5\par}}%
  \vskip 1em
  
  \vskip 2em
  
  \vskip 1.5em



   
   \vfill



  
    \strut\par
  


  \end{center}


     \end{titlepage}
     
     \cleardoublepage





\tableofcontents
% start a new right-handed page

\cleardoublepage



\chapter{Overview}


The 2.5 series brings in file inclusion in Muse documents, which is
detailed in \href{/library/file-inclusion}{its own page}.


There are no upgrade or backcompatibility issues.

\chapter{Changes}

\section{2.597 2024-04-04}


\begin{itemize}
\item\relax 
Fix JS breakage on newtext because of select2 library not loaded.



\item\relax 
Updated eu localization. Thanks to @a-mento




\end{itemize}
\section{2.596 2024-02-12}


\begin{itemize}
\item\relax 
Add basque (eu) i18n. Thanks to @a-mento




\end{itemize}
\section{2.595 2024-02-10}


\begin{itemize}
\item\relax 
Fix crash in OAI-PMH with Marc21 and hard-deleted entry.




\end{itemize}
\section{2.594 2024-02-06}


\begin{itemize}
\item\relax 
Keep the collections items ordered as the user defined them



\item\relax 
Remove the order number input in the aggregation widgets (that
should be done with the drag\&drop in the parent)




\end{itemize}
\section{2.593 2024-02-01}


\begin{itemize}
\item\relax 
Keep the bookcover template tokens sorted



\item\relax 
Add descriptions to aggregations and series



\item\relax 
Add uri checker for collections



\item\relax 
Random fixes




\end{itemize}
\section{2.592 2024-01-31}


\begin{itemize}
\item\relax 
Fix breakage in bookcovers when installed via .deb




\end{itemize}
\section{2.591 2024-01-31}


\begin{itemize}
\item\relax 
New feature: bookcovers. This is the companion for the bookbuilder.
See \Slash{}bookcovers as starting point.




\end{itemize}
\section{2.590 2024-01-25}


\begin{itemize}
\item\relax 
New features: aggregations and series (anthologies and periodical).
See \texttt{/aggregate/manage}.



\item\relax 
Improved collections (previously known as nodes)



\item\relax 
Create an authorization mechanism for IP, so scripts can access
\texttt{/git} and private sites. See (\texttt{/console/git})



\item\relax 
Changed default for cgit public interface to false. This option is
now reserved for root users



\item\relax 
i18n: uk (thanks to @nykula)



\item\relax 
Fix jumpy navbar in some mobile browsers (thanks to @nykula)




\end{itemize}
\section{2.583 2024-01-01}


\begin{itemize}
\item\relax 
Expose the format definitions to the API



\item\relax 
Serve the .bare.html file if requested




\end{itemize}
\section{2.582 2023-12-16}


\begin{itemize}
\item\relax 
i18n: tr (updated)



\item\relax 
Add function to send mails from the site under site-admin\Slash{}send-email



\item\relax 
Add Bump Pubdate function (\#450)




\end{itemize}
\section{2.581 2023-10-21}


\begin{itemize}
\item\relax 
improve OAI-PMH's MARC21 output with more data (notably uri, label
and content type)



\item\relax 
on annotation and collection changes, bump the relevant records for
incremental harvesting




\end{itemize}
\section{2.580 2023-10-18}


\begin{itemize}
\item\relax 
i18n: tr (updated)



\item\relax 
Improve UI for federation: allow multiple urls by pasting




\end{itemize}
\section{2.579 2023-10-04}


\begin{itemize}
\item\relax 
i18n: tr (updated)



\item\relax 
Implement OAI-ORE aggregations in RDF file. This is somehow
experimental and unclear if it's actually useful and\Slash{}or if it's
been correctly implemented, so it's EXPERIMENTAL.



\item\relax 
Implement text annotations. These values which you don't want to go
into the muse file, so they excluded from the git. Possible use
cases: large scan files used as working copies, physical book
location, comments. If marked as active and public, the annotations
(excluding the files) are exposed via OAI-PMH.




\end{itemize}
\section{2.578 2023-08-31}


\begin{itemize}
\item\relax 
i18n: add initial support for uk



\item\relax 
oai-pmh: expose the categories




\end{itemize}
\section{2.577 2023-07-24}


\begin{itemize}
\item\relax 
Rename in the front-end the "nodes" to "collections". URLs and
table names are intact.



\item\relax 
Expose the nodes\Slash{}collections as OAI-PMH sets




\end{itemize}
\section{2.576 2023-07-14}


\begin{itemize}
\item\relax 
Add initial RTL support



\item\relax 
Add Farsi i18n




\end{itemize}
\section{2.575 2023-06-25}


\begin{itemize}
\item\relax 
OAI-PMH: add a "web" set and serve marc21 for GetRecord call as well




\end{itemize}
\section{2.574 2023-06-02}


\begin{itemize}
\item\relax 
Upgraded jquery to latest



\item\relax 
Upgraded jquery-ui to latest



\item\relax 
Implement MARCXML output for AOI-PMH. The AOI-PMH feature is still
experimental



\item\relax 
Upgraded TeXlive! script



\item\relax 
Updated installation scripts for fonts and js




\end{itemize}
\section{2.573 2023-05-29}


\begin{itemize}
\item\relax 
Implement attachment pruning



\item\relax 
i18n: cs (updated)



\item\relax 
minor corrections to AOI-PMH code




\end{itemize}
\section{2.572 2023-05-17}


\begin{itemize}
\item\relax 
Optimization for the OAI-PMH update run, which was too slow.




\end{itemize}
\section{2.570 2023-05-16}


\begin{itemize}
\item\relax 
Implement the OAI-PMH protocol at \Slash{}oai-pmh




\end{itemize}
\section{2.566 2023-05-06}


\begin{itemize}
\item\relax 
I18N: tr (updated)



\item\relax 
Try to address the content jumping when the navbar becomes fixed




\end{itemize}
\section{2.565 2023-03-20}


\begin{itemize}
\item\relax 
Save the images' \texttt{alt\_text} on site serialization.




\end{itemize}
\section{2.564 2023-03-20}


\begin{itemize}
\item\relax 
Make the language selection explicit in the user preferences. So
far it was a side effect of changing the site locale via the
language selector.




\end{itemize}
\section{2.563 2023-02-19}


\begin{itemize}
\item\relax 
Display an icon if the attachment thumbnail generation failed (\href{https://github.com/melmothx/amusewiki/issues/422}{GH\#422})



\item\relax 
Autoimport site\_files\Slash{}autoimport\Slash{}\{categories,legacy\_links\}.yml if found



\item\relax 
Add alternate Wordpress importer




\end{itemize}
\section{2.562 2022-12-04}


\begin{itemize}
\item\relax 
I18N: ro (new)



\item\relax 
Add missing font preview (\href{https://github.com/melmothx/amusewiki/issues/403}{GH\#403})



\item\relax 
Support images' alt text via ajax call (\href{https://github.com/melmothx/amusewiki/issues/421}{GH\#421})




\end{itemize}
\section{2.561 2022-11-05}


\begin{itemize}
\item\relax 
I18N: cs (new), tr (updated)



\item\relax 
Improve enclosure handling for RSS, OPDS, static indexes



\item\relax 
Minor adjustments for custom categories



\item\relax 
Support navlog-alt.png and local-alt.css for theming



\item\relax 
New option to enforce the email on submission



\item\relax 
Support \texttt{\#formats none} in the header




\end{itemize}
\section{2.560 2022-09-24}


\begin{itemize}
\item\relax 
Extend the custom categories with new option. Include them in
Xapian facets, in the creation form, in the colophon.



\item\relax 
Improve preview on edit with all the relevant fields



\item\relax 
Honor the pubdate in the RSS for special pages



\item\relax 
Add kmr localization support



\item\relax 
Updated it and tr i18n




\end{itemize}
\section{2.551 2022-05-14}


\begin{itemize}
\item\relax 
New "body only" option for custom formats and bookbuilder




\end{itemize}
\section{2.550 2022-05-07}


\begin{itemize}
\item\relax 
Correct text\Slash{}categories redirection status code (make them permanent)



\item\relax 
Add URI preview on text creation  (\href{https://github.com/melmothx/amusewiki/issues/392}{GH\#392})



\item\relax 
Add URI rename function (\href{https://github.com/melmothx/amusewiki/issues/392}{GH\#392})




\end{itemize}
\section{2.545 2022-04-22}


\begin{itemize}
\item\relax 
Fix puzzling crashes on attachment list, federation page and
pending revisions.



\item\relax 
Implement login by email instead of username (transparent)



\item\relax 
Add option to enforce manual URI




\end{itemize}
\section{2.544 2022-03-29}


\begin{itemize}
\item\relax 
Update tr and ja i18n.



\item\relax 
Bump parser and compiler for \texttt{<ruby>} support




\end{itemize}
\section{2.543 2022-03-26}


\begin{itemize}
\item\relax 
Improve check on \#title upon submitting



\item\relax 
Fix startup crash on older distributions (\href{https://github.com/melmothx/amusewiki/issues/389}{GH\#389})




\end{itemize}
\section{2.542 2022-03-19}


\begin{itemize}
\item\relax 
Remove crawlable OPDS page. This is huge performance and bandwith
waste.



\item\relax 
Optimize the static indexes production. This will let datatable do
the actual table rendering while the app will just provide the JSON
data with some predigested HTML. The gain is huge.



\item\relax 
Remove the asciified indexing in Xapian. Doing this unconditionally
is a mistake. To be restored for selected languages only, in case.




\end{itemize}
\section{2.541 2022-03-12}


\begin{itemize}
\item\relax 
Update ja i18n



\item\relax 
Optimization for large sites




\end{itemize}
\section{2.540 2022-03-05}


\begin{itemize}
\item\relax 
Add federation feature [EXPERIMENTAL]




\end{itemize}
\section{2.535 2022-02-26}


\begin{itemize}
\item\relax 
Add paragraph indentation option to custom formats and bookbuilder



\item\relax 
Enable ceb and tl languages




\end{itemize}
\section{2.534 2022-02-12}


\begin{itemize}
\item\relax 
Bump prerequisites: require amusewiki-texlive



\item\relax 
Migrate from polyglossia to babel via
Text::Amuse\Slash{}Text::Amuse::Compile, greatly extending the supported
languages.



\item\relax 
Add option to use Unicode category names. This should be used when
the ASCII category names are not accurate (notably Japanese)



\item\relax 
Implement language setting for \href{/library/custom-fonts}{fonts}




\end{itemize}
\section{2.533 2021-12-24}


\begin{itemize}
\item\relax 
Add proper links to \texttt{/console/git-fine-diff}



\item\relax 
Add Chinese i18n (without \texttt{Text::Amuse} support)




\end{itemize}
\section{2.532 2021-12-19}


\begin{itemize}
\item\relax 
Add a new route \texttt{/console/git-fine-diff} do compare given commits on
a file.




\end{itemize}
\section{2.531 2021-11-21}


\begin{itemize}
\item\relax 
Always provide an https:\Slash{}\Slash{} site. This aligns the behavior to the
expected one. Now "Use SSL for authenticated users" means exactly
that, i.e. redirect login and authenticated users to https, while
so far disabling that would have prevented https altogether.
(\href{https://github.com/melmothx/amusewiki/issues/385}{GH\#385})




\end{itemize}
\section{2.530 2021-11-20}


\begin{itemize}
\item\relax 
Add linespacing PDF option (via Text::Amuse::Compile bump)



\item\relax 
Exclude pseudo TLD from Let's Encrypt renewals \href{https://github.com/melmothx/amusewiki/issues/385}{GH\#385}



\item\relax 
Add Esperanto i18n




\end{itemize}
\section{2.522 2021-10-22}


\begin{itemize}
\item\relax 
New theme, \texttt{amusebaskerville}




\end{itemize}
\section{2.521 2021-10-10}


\begin{itemize}
\item\relax 
Fix \texttt{/api/latest} missing critical key



\item\relax 
Fix \texttt{/p/xxx} sitemap and robots




\end{itemize}
\section{2.520 2021-10-10}


\begin{itemize}
\item\relax 
Add experimental routes \texttt{p/xxx} mapping to \texttt{repo/site\_files/public/xxx} to
build arbitrary custom pages.



\item\relax 
add \texttt{/api/latest} exposing the title info as JSON




\end{itemize}
\section{2.519 (2021-08-04)}


\begin{itemize}
\item\relax 
Deny access to git pull logs to anonymous users. This fixes a
potential information disclosure (git logs) when using the
pulling with a system user. \textbf{[SECURITY]}




\end{itemize}
\section{2.518 (2021-08-03)}


\begin{itemize}
\item\relax 
Fix theme-switcher persistence for non-logged in (reported by
\texttt{anelki} on the \texttt{\#amusewiki} channel)




\end{itemize}
\section{2.517 (2021-08-02)}


\begin{itemize}
\item\relax 
Fix crash on debian package when temporary process is gone (\href{https://github.com/melmothx/amusewiki/issues/373}{GH\#373})



\item\relax 
Increase paper size values



\item\relax 
Prevent db insertion crash on \#uid too long (\href{https://github.com/melmothx/amusewiki/issues/376}{GH\#376})



\item\relax 
New restricted option preventing redirection on aliases to canonical (\href{https://github.com/melmothx/amusewiki/issues/377}{GH\#377})



\item\relax 
New restricted option to inject nginx configuration snippets into site stanza (\href{https://github.com/melmothx/amusewiki/issues/378}{GH\#378})



\item\relax 
Theme switcher (dark\Slash{}light toggler) (\href{https://github.com/melmothx/amusewiki/issues/379}{GH\#379})




\end{itemize}
\section{2.516 (2021-06-19)}


\begin{itemize}
\item\relax 
Display the fail details on compilation failure
(\href{https://github.com/melmothx/amusewiki/issues/371}{GH\#371})



\item\relax 
Support arbitrary margin in the bookbuilder
(\href{https://github.com/melmothx/amusewiki/issues/372}{GH\#372})



\item\relax 
Update texlive install script for TeXlive! 2021




\end{itemize}
\section{2.515 (2021-06-05)}


\begin{itemize}
\item\relax 
\textbf{[SECURITY]} When pulling a remote git, remove symlinks pointing
outside the tree. This is a security patch against potential
symlink-based attacks coming from remote repository, tricking the
application to access files outside the site root.


To be exploited, the flaw, fixed in this release, requires a
malicious or naive site administrator pulling from a malicious
repository.



\item\relax 
Serve symlinks if they point inside the tree.



\item\relax 
New option to toggle the display of latest entries on special pages




\end{itemize}
\section{2.514 (2021-05-23)}


\begin{itemize}
\item\relax 
Fix bug with links which URI doesn't understand (reported by
\texttt{anelki} on the \texttt{\#amusewiki} channel)




\end{itemize}
\section{2.513 (2021-05-21)}


\begin{itemize}
\item\relax 
Do not rely on Freenode for the webchat. Instead, make the iframe
url editable. Nothing by default. The iframe with the webchat
didn't seem to work anyway. At some point it stopped working. If
you set a webchat url, the link to the page with the embedded
iframe will always appear in the dropdown menu. On the other hand,
the default with the \texttt{\#amusewiki} channel has been removed. Site
admins need to find and set one.



\item\relax 
Update i18n strings



\item\relax 
AMW-Meta: Implement OPDS




\end{itemize}
\section{2.512 (2021-04-25)}


\begin{itemize}
\item\relax 
Update i18n: el



\item\relax 
Refresh the shared repo's hook when the site is reconfigured




\end{itemize}
\section{2.511 (2021-04-11)}


\begin{itemize}
\item\relax 
Add Greek I18N



\item\relax 
Do not trigger Xapian suggestions if not enabled (\href{https://github.com/melmothx/amusewiki/issues/366}{GH\#366})




\end{itemize}
\section{2.510 (2021-04-05)}


\begin{itemize}
\item\relax 
Add support for images in the API



\item\relax 
Add option to keep the layout always fluid



\item\relax 
Update I18N: RU (thanks to @link2xt)



\item\relax 
Carry on ETag and X-Robots-Tag when serving static files from nginx




\end{itemize}
\section{2.509 (2021-02-27)}


\begin{itemize}
\item\relax 
Return 410 when the text is deleted without a redirection.



\item\relax 
Add \Slash{}remote\Slash{}edit\Slash{}library\Slash{}xxx and \Slash{}remote\Slash{}edit\Slash{}special\Slash{}xxx
to API




\end{itemize}
\section{2.508 (2021-02-14)}


\begin{itemize}
\item\relax 
Support \texttt{sc} and \texttt{sf} inline tags via new \texttt{Text::Amuse}




\end{itemize}
\section{2.507 (2021-01-14)}


\begin{itemize}
\item\relax 
Store and display isbn, publisher, series info, copyright info if
provided by the muse document. These fields are documented and
display in the generated formats, but were not in the web app.




\end{itemize}
\section{2.506 (2021-01-06)}


\begin{itemize}
\item\relax 
Save instructions to compile a format into the site repo under \texttt{bin}



\item\relax 
Add function to check mailing



\item\relax 
Add new imposition schema \texttt{duplex2up} (\texttt{2up} variant)



\item\relax 
Make \texttt{Authen::SASL} a requirement (for SMTP)




\end{itemize}
\section{2.505 (2020-12-15)}


\begin{itemize}
\item\relax 
Fix an old bug with the amusewiki restart command not killing the
children.



\item\relax 
Improve logging for the \texttt{/git} route



\item\relax 
Improve sorting for revisions page



\item\relax 
Add pagination to OPDS category routes (and added custom categories)



\item\relax 
Cache \texttt{/opds/crawlable} which was too slow



\item\relax 
Updated I18N: PL




\end{itemize}
\section{2.504 (2020-11-05)}


\begin{itemize}
\item\relax 
Updated i18n: BG




\end{itemize}
\section{2.503 (2020-11-05)}


\begin{itemize}
\item\relax 
Fix support for BG.




\end{itemize}
\section{2.502 (2020-11-05)}


\begin{itemize}
\item\relax 
Updated i18n (added BG)




\end{itemize}
\section{2.501 (2020-10-29)}


\begin{itemize}
\item\relax 
Fix access permissions to whitelisted IPs to \texttt{/git} and \texttt{/mirror}




\end{itemize}
\section{2.500 (2020-10-28)}


\begin{itemize}
\item\relax 
Support file inclusion \href{https://github.com/melmothx/amusewiki/issues/53}{GH\#53})




\end{itemize}








% begin final page

\clearpage



% new page for the colophon

\thispagestyle{empty}

\begin{center}





\bigskip
\includegraphics[width=0.25\textwidth]{logo-amw.pdf}
\bigskip

\end{center}

\strut

\vfill

\begin{center}




Version 2.5






\bigskip



   

       

       

       

       

       

       

   



\bigskip
\textbf{amusewiki.org}


\end{center}

% end final page with colophon


% end closing pages



\end{document}


% No format ID passed.



