\documentclass{ltxdoc}
\usepackage[utf8]{inputenc}
\usepackage[french]{babel}
\usepackage[T1]{fontenc}
\usepackage{bibleref-french}
\usepackage{csquotes}
\usepackage[citestyle=verbose]{biblatex}
\renewcommand{\newunitpunct}{\addcomma\addspace}
\renewcommand{\subtitlepunct}{\addspace\addcolon\addspace}
\bibliography{inclus/bible.bib}
\usepackage[breaklinks=true,unicode=true]{hyperref}
\usepackage{longtable}

\begin{document}

\shorthandoff{:}
\title{Le package \textsf{bibleref-french}\thanks{Version \BRFfileversion}}
\author{Ma\"ieul Rouquette \\ \& \\ Rapha\"el Pinson \\ \texttt{raphink@gmail.com}}

\maketitle
\begin{abstract}
Le  package \textsf{bibleref-french} fournit une traduction français du package \textsf{bibleref}.
\end{abstract}

\tableofcontents
\section{Utilisation}

Ce package hérite des commandes du package \textsf{bibleref}. Voir la documentation du package \textsf{bibleref} pour l'usage général.

\subsection{Styles additionnels}

\textsf{bibleref-french} ajoute des styles ou en surcharge du package \textsf{bibleref} (comme par exemples les styles \textsf{default}, \textsf{jerusalem} et \textsf{text}.).

Les styles sont notés dans le tableau~\ref{tab:styles}.

\begin{table}[tbh]
\caption{Styles de citation bibliques  (peuvent être utilisés comme options de  packages ou comme argument de  \cs{biblerefstyle})}
\label{tab:styles}
\vspace{10pt}
\begin{center}
\input{inclus/styles}
\end{center}
\end{table}

Les styles qui utilisent des formes abrégées possèdent chacun une variante du même nom suffixée par \textsf{fullindex}. Cette variante permet d'utiliser les formes abrégées dans le corps du texte, mais les formes étendues dans l'index.

\subsection{Noms catholique ou protestant des livres}

Un livre de l'Ancien Testament s'appelle Isaïe chez les catholiques et Ésaïe chez les protestants.
Pour cette raison ce package fournit deux options supplémentaires :  \textsf{catholic} (ou \textsf{catholique}) et \textsf{protestant}.

L'option \textsf{catholic} ne fait habituellement rien, puisque c'est l'option par défaut. Cependant, appeler  \verb!\brfullname@catholic! fournira un résumé de tous les noms catholiques de livres.

Tant \verb|\brfullname@catholic| que \verb|\brfullname@protestant| peuvent être utilisés en remplacement à  \verb|brefullname| dans les définitions de styles pour forcer à utiliser l'un ou l'autre des schémas de nommage.

Notez que le style \verb|TOB| utilise les noms catholiques, sauf pour le libre d'Ésaïe qui est surchargé.

Au moment du chargement, le schéma de nommage peut être surchargé pour un style donné. Par exemple le style \verb|jerusalem| utilise \verb|\brfullname@catholic| mais vous pouvez utiliser \verb|\usepackage[jerusalem,protestant]{bibleref-french}| pour avoir le style \verb|jerusalem| avec les livres de la Bible Protestante.

Il en est de même pour \verb|brabbrvname| et les commandes dérivées.

\subsection{Liste des livres}

\def\abreviation{Abréviation}
\def\livre{Livre}
Voici la liste des livres avec leurs abréviations :

\input{inclus/livres}

\subsection{Espaces insécables}

Le manuel de l'\emph{Imprimerie Nationale} expose que les nombres ne devraient pas être séparés des textes avec lesquelles ils vont. Pour cette raison, ce package utilise des espaces insécables dans les cas suivants :
\begin{itemize}
\item Entre le nombre et le nom quand le nom d'un livre contient un nombre (par ex. 2 Corinthiens) ;
\item Entre le nom du livre et le numéro de chapitre ;
\item Après un tiret demi-cadratin (--) dans un intervalle de versets.

\end{itemize}

Bien que cela soit généralement mieux, cela peut produire des lignes dépassantes en longueur quand une longue référence biblique termine une ligne.
Pour cette raison le package fournit une commande \cs{BRallowhypbch} pour autoriser les fins de ligne entre le nom du livre et le numéro de chapitre dans une référence biblique.
La commande \cs{BRforbidhypbch} restaure les espaces insécables entre le nom du livre et le numéro de chapitre.

Si vous avez besoin de résoudre un dépassement d'une ligne finissante avec un long verset biblique et qu'il n'y a pas d'autres possibilités que d'autoriser la séparation entre le nom du livre et le numéro de chapitre, il est recommandé d'utiliser \cs{BRallowhypbch} dans un environnement qui contient le paragraphe problématique.

\section{Tri dans l'index}
Le package \verb|bibleref| autorise à choisir l'ordre des livres pour générer un index des références bibliques.

Cependant il utilise le nom complet des livres pour les trier, ce qui est problématique en français à cause des accents dans les noms.

Pour résoudre cela, ce package modifie \verb|bibleref| pour utiliser les abréviations à la place des noms complets.

En conséquence, \cs{biblerefmap} doit être utilisé avec les \emph{exactes} chaînes de caractères utilisés dans les commandes \cs{ibibleref}. Par exemple, si vous utilisez \verb|\ibibleref{Jn}(3:16)|, vous devrez déclarer \verb|\biblerefmap{Jn}{43}| à la place de \verb|\biblerefmap{Jean}{43}|


 Si vous utilisez la commande \cs{ibibleref}, vous pouvez constater que l'ordre de tri dans l'index n'est par défaut pas très bon. Par exemple, livres numérotés sont classés à la lettre `i'.

Le package fournit des options pour un meilleur tri\footcite[Pour l'Ancien Testament les protestants suivent le canon juif pour son contenu mais utilisent l'ordre du canon catholique, voir][]{canons}. Au chargement du package, vous pouvez choisir l'une de ces options :
 \begin{description}
 \item[indexalphac]les livres sont triés par ordre alphabétique, suivant les noms catholiques.
\item[indexalphap]les livres sont triés par ordre alphabétique, suivant les noms protestants.
\item[indexLXX]les livres sont triés dans l'ordre des bibles chrétiennes classiques, pour l'Ancien Testament  selon la Septante. Ancien et Nouveau Testaments ne sont pas séparés.
\item[indextestamentsL]les livres sont triés dans l'ordre des bibles chrétiennes classiques, pour l'Ancien Testament  selon la Septante. Ancien et Nouveau Testaments forment deux sections.
\item[indexTOB]les livres sont triés dans l'ordre de la \emph{Traduction Œcuméniques de la Bible}, pour l'Ancien Testament  selon la Bible Hébraïque, suivie des deutérocanoniques. Ancien et Nouveau Testaments ne sont pas séparés.
\item[indextestamentsT]les livres sont triés dans l'ordre de la \emph{Traduction Œcuméniques de la Bible}, pour l'Ancien Testament  selon la Bible Hébraïque, suivie des deutérocanoniques. Ancien et Nouveau Testaments forment deux sections.
\item[indexBHS]les livres de la Bible Hébraïque sont triés selon les bibles hébraïques classiques. La Torah, les Nebiim et les Ketouvim sont dans la même section. Les deutérocanoniques et les Livres du Nouveau Testament ne sont pas triés.
\item[indexTanak]les livres de la Bible Hébraïque sont triés selon les bibles hébraïques classiques. La Torah, les Nebiim et les Ketouvim sont dans trois sections distinctes. Les deutérocanoniques et les Livres du Nouveau Testament ne sont pas triés.
\end{description}

Pour les options \verb|indexTOB| et \verb|indextestamentsT|, le livre d'Esther est considéré dans sa version hébraïque, et est donc rangé parmi les  écrits.
\subsection{Nom des parties de la Bible}
Il est possible de renommer le nom des parties de la Bible. Par exemple \enquote{Torah} en \enquote{Loi}.
Pour ce faire, vous devez redéfinir, avec  \cs{renewcommand} l'une ou plus de ces commandes :
 \begin{itemize}
 \item \cs{Torah} ;
 \item \cs{Nebiim} ;
 \item \cs{Ketouvim} ;
 \item \cs{AT};
 \item \cs{NT}.
\end{itemize}

\end{document}
