diff options
author | Norbert Preining <norbert@preining.info> | 2019-12-31 03:00:32 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-12-31 03:00:32 +0000 |
commit | 1f9ab71f8ea4751f440072e9e4da3314edbbcf2e (patch) | |
tree | 1ac9f67dd95b7e3072b7951e6cb1590fda73ffb9 /macros/latex/contrib/apa7/apa7.dtx | |
parent | 0af8a1a375250bdab8576ca414baae91122ea6a3 (diff) |
CTAN sync 201912310300
Diffstat (limited to 'macros/latex/contrib/apa7/apa7.dtx')
-rw-r--r-- | macros/latex/contrib/apa7/apa7.dtx | 211 |
1 files changed, 110 insertions, 101 deletions
diff --git a/macros/latex/contrib/apa7/apa7.dtx b/macros/latex/contrib/apa7/apa7.dtx index 303a2064f9..4641281267 100644 --- a/macros/latex/contrib/apa7/apa7.dtx +++ b/macros/latex/contrib/apa7/apa7.dtx @@ -4,11 +4,11 @@ % % % CHANGE THESE VALUES WITH EACH NEW RELEASE: % % % -%<class>\ProvidesClass{apa7}[2019/12/29 v1.01 APA formatting (7th edition)] +%<class>\ProvidesClass{apa7}[2019/12/30 v1.04 APA formatting (7th edition)] % % %<*internal> % -\def\apaSevenVersionDate{2019/12/29} -\def\apaSevenVersionNumber{1.01} +\def\apaSevenVersionDate{2019/12/30} +\def\apaSevenVersionNumber{1.04} % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -105,18 +105,16 @@ and the derived files apa7.ins, apa7.cls, apa7.pdf, README, - APAamerican.txt, - APAbritish.txt, - APAdutch.txt, - APAenglish.txt, - APAgerman.txt, - APAngerman.txt, - APAgreek.txt, - APAczech.txt, - APAturkish.txt, - APAendfloat.cfg, - apa7.ptex, - TeX2WordForapa7.bas, + APA7american.txt, + APA7british.txt, + APA7dutch.txt, + APA7english.txt, + APA7german.txt, + APA7ngerman.txt, + APA7greek.txt, + APA7czech.txt, + APA7turkish.txt, + APA7endfloat.cfg, Figure1.pdf, shortsample.tex, longsample.tex, and @@ -129,16 +127,16 @@ and the derived files apa7.ins, } \usedir{tex/latex/apa7/config} \generate{ - \file{./config/APAamerican.txt}{\from{\jobname.dtx}{american}} - \file{./config/APAbritish.txt}{\from{\jobname.dtx}{british}} - \file{./config/APAdutch.txt}{\from{\jobname.dtx}{dutch}} - \file{./config/APAenglish.txt}{\from{\jobname.dtx}{english}} - \file{./config/APAgerman.txt}{\from{\jobname.dtx}{german}} - \file{./config/APAngerman.txt}{\from{\jobname.dtx}{ngerman}} - \file{./config/APAgreek.txt}{\from{\jobname.dtx}{greek}} - \file{./config/APAczech.txt}{\from{\jobname.dtx}{czech}} - \file{./config/APAturkish.txt}{\from{\jobname.dtx}{turkish}} - \file{./config/APAendfloat.cfg}{\from{\jobname.dtx}{APAendfloat}} + \file{./config/APA7american.txt}{\from{\jobname.dtx}{american}} + \file{./config/APA7british.txt}{\from{\jobname.dtx}{british}} + \file{./config/APA7dutch.txt}{\from{\jobname.dtx}{dutch}} + \file{./config/APA7english.txt}{\from{\jobname.dtx}{english}} + \file{./config/APA7german.txt}{\from{\jobname.dtx}{german}} + \file{./config/APA7ngerman.txt}{\from{\jobname.dtx}{ngerman}} + \file{./config/APA7greek.txt}{\from{\jobname.dtx}{greek}} + \file{./config/APA7czech.txt}{\from{\jobname.dtx}{czech}} + \file{./config/APA7turkish.txt}{\from{\jobname.dtx}{turkish}} + \file{./config/APA7endfloat.cfg}{\from{\jobname.dtx}{APAendfloat}} } \usedir{tex/latex/apa7/samples} \generate{ @@ -187,6 +185,16 @@ and the derived files apa7.ins, }{|}}} https://orcid.org/#2}} \usepackage{hyperref} +\hypersetup{% + colorlinks, + linkcolor=blue, + citecolor=blue, + urlcolor=black, + pdfauthor = {Daniel A. Weiss <daniel.weiss.led@gmail.com>}, + pdftitle = {The apa7 class}, + pdfsubject = {Documentation of LaTeX class apa7}, + pdfkeywords = {LaTeX, APA} +} \usepackage{graphicx} \usepackage{booktabs} \usepackage{verbatimbox} @@ -206,14 +214,6 @@ and the derived files apa7.ins, %\DoNotIndex{\closeout,\day,\def,\edef,\else,\empty,\endgroup} %\DoNotIndex{\newcommand,\renewcommand} % -% \ifpdf -% \hypersetup{% -% pdfauthor = {Daniel A. Weiss <daniel.weiss.led@gmail.com>}, -% pdftitle = {The apa7 class}, -% pdfsubject = {Documentation of LaTeX class apa7}, -% pdfkeywords = {LaTeX, APA} -% }% -% \fi % % \title{^^A % Formatting documents in APA style (7th Edition)\\^^A @@ -231,6 +231,13 @@ and the derived files apa7.ins, % \changes{v1.01}{2019/12/29}{Corrected figure caption styles for doc format.} % \changes{v1.01}{2019/12/29}{Clarified that apacite and natbib are in 6th edition style.} % +% \changes{v1.02}{2019/12/29}{Fixed filename issue with language localization files.} +% +% \changes{v1.03}{2019/12/29}{Updated class to detect babel package in document and localize accordingly.} +% +% \changes{v1.04}{2019/12/30}{Added table of contents.} +% \changes{v1.04}{2019/12/30}{Updated documentation and added correct license statement to cls for apa6 package.} +% % \begin{abstract} % The \textit{Publication Manual} of the American Psychological % Association is widely used in the social sciences. The most @@ -240,6 +247,8 @@ and the derived files apa7.ins, % \textsf{apa6} class. The student manuscript type has been added. % \end{abstract} % +% \tableofcontents +% % \section{Background} % Most journals in the social sciences require manuscripts to be % formatted in compliance with the American Psychological @@ -268,7 +277,7 @@ and the derived files apa7.ins, % available. % % \vspace{1em} -% \textbf{Document mode:} Three choices are available. +% \textbf{Document mode:} Four choices are available. % \begin{itemize} % \item \DescribeMacro{jou}|jou| (default): Formats the document with an % appearance resembling a printed APA journal (e.g., \textit{Journal @@ -327,10 +336,10 @@ and the derived files apa7.ins, % it may not work in all contexts). Do \textbf{\textit{not}} load % \textsf{longtable} yourself because of precedence requirements % with the \textsf{endfloat} package. Copy the file -% |APAendfloat.cfg| from the ``config'' folder of your \textsf{apa} +% |APA7endfloat.cfg| from the ``config'' folder of your \textsf{apa} % installation to the working folder of your document (not in your % |texmf| tree), and rename it to |endfloat.cfg| so that endfloat -% will recognize it. The supplied |APAendfloat.cfg| file will also +% will recognize it. The supplied |APA7endfloat.cfg| file will also % be necessary in conjunction with the \textsf{rotating} package % (and its |\sideways| command) to produce rotated tables; this % works for |man| and |stu| mode only. For rotated tables in |jou| or |doc| @@ -414,7 +423,7 @@ and the derived files apa7.ins, % \item \DescribeMacro{\authornote}|\authornote|\marg{author-note}: % The Author Note, containing contact information, acknowledgements, % etc. -% \item \DescribeMacro{\addORCIDlink}|\addORCIDlink|\marg{author-name}\marg{ORCID}: Use this within the author note to generate the ORCID link. \\ +% \item \DescribeMacro{\addORCIDlink}|\addORCIDlink|\marg{author-name}\marg{ORCID}: Optionally, use this within the author note to generate the ORCID link. \\ % For example % \begin{verbatim} \addORCIDlink{First M. Last}{0000-0000-0000-0000} \end{verbatim} \\ % generates \\ \\ @@ -587,39 +596,17 @@ and the derived files apa7.ins, % utilizes code (with permission) from the \textsf{apa6} class to % comply with all of these specifications. % -% \subsection{Float Placement} -% The 7th Edition requires -% that tables and figures (in that order) be placed after the -% references but before the appendices. This creates a bit of a -% conundrum as to what should happen with tables or figures that are -% ultimately typeset within an appendix. The choices we are left with -% are to place appendix floats (a) along with the floats from the main -% part of the manuscript, which would mean that appendix floats appear -% prior to the point at which they are mentioned; (b) within the -% appendices themselves, which is not consistent with how floats in -% the main part of the manuscript are handled; or (c) in a separate -% float section that follows the appendices, which results in two -% float sections. Obviously none of these choices is satisfactory, so -% I posed the question to APA's Style Expert. He responded that at -% least for APA's journals ``it doesn't matter whether appendix tables -% are submitted with text tables or separately, as long as they are -% numbered correctly (e.g., Table A1, Table B1, etc.)'' (J.\ -% Hume-Pratuch, personal communication, June 15, 2011). Therefore, -% \textsf{apa7} takes the most straightforward approach and includes -% all appendix floats within the body of the relevant appendix. This -% also has the advantage of making appendices more readable. -% % Because the 7th Edition requires figure captions to be printed on % the same page as their respective figures, there are no more Figure % Captions pages. % % \subsection{Author Note} -% According to 7th Edition guidelines, Author Notes are placed on the -% title page of manuscripts. +% According to 7th Edition guidelines, Author Notes are now placed "in the bottom half of the title page" on the +% title page of manuscripts per the style guide. % % \section{Features} -% In addition to providing compatibility with the 7th Edition of the -% \textit{Manual}, several features have been implemented. +% The featured implemented in the |apa6| have been included in the |apa7| class for the 7th Edition of the +% \textit{Manual}. % % \subsection{Masked References} % \label{sec:masking} @@ -692,7 +679,7 @@ and the derived files apa7.ins, % \DescribeMacro{floatsintext}|floatsintext| option (specified in the % |\documentclass| line) will integrate tables and figures % approximately where they are mentioned in the text. This is -% available only with the |man| option, of course, because the other +% available only with the |man| and |stu| options, of course, because the other % formats already have floats integrated with the text. % % \subsection{User-defined Font Size} @@ -715,7 +702,7 @@ and the derived files apa7.ins, % \subsection{Flexible Bibliographies} % The \textsf{apa7} class supports three bibliography packages: % \textsf{biblatex}, \textsf{apacite}, and \textsf{natbib}. \\ \\ -% At this time, only biblatex is updated to support the 7th edition of APA style for citations and references. +% At this time, only \textsf{biblatex} is updated to support the 7th edition of APA style for citations and references. % % \subsubsection{\textsf{biblatex}} % \label{sec:biblatexinfo} @@ -758,6 +745,28 @@ and the derived files apa7.ins, % label can be localized by modifying the appropriate configuration % file (in the `config' folder of the \textsf{apa7} installation). % +% \subsection{Float Placement} +% The 7th Edition (as did the 6th Edition) requires +% that tables and figures (in that order) be placed after the +% references but before the appendices. This creates a bit of a +% conundrum as to what should happen with tables or figures that are +% ultimately typeset within an appendix. The choices we are left with +% are to place appendix floats (a) along with the floats from the main +% part of the manuscript, which would mean that appendix floats appear +% prior to the point at which they are mentioned; (b) within the +% appendices themselves, which is not consistent with how floats in +% the main part of the manuscript are handled; or (c) in a separate +% float section that follows the appendices, which results in two +% float sections. Obviously none of these choices is satisfactory, so +% Brian Beitzel (author of |apa6| package) posed the question to APA's Style Expert. The style expert responded that at +% least for APA's journals ``it doesn't matter whether appendix tables +% are submitted with text tables or separately, as long as they are +% numbered correctly (e.g., Table A1, Table B1, etc.)'' (J.\ +% Hume-Pratuch, personal communication, June 15, 2011). Therefore, +% \textsf{apa7} takes the same approach as \textsf{apa6}: the most straightforward approach that includes +% all appendix floats within the body of the relevant appendix. This +% also has the advantage of making appendices more readable. +% % \section{Dependencies} % \textsf{apa7} automatically loads the following packages. If these % packages are not already installed, producing the first @@ -836,7 +845,7 @@ and the derived files apa7.ins, \author{Daniel A. Weiss} \affiliation{A University Somewhere} - \leftheader{Beitzel} + \leftheader{Weiss} \abstract{This demonstration paper uses the \textsf{apa7} \LaTeX\ class to format the document in compliance with the 7th Edition of @@ -951,25 +960,25 @@ and the derived files apa7.ins, % % apa7 class was built % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % -% apa.cls version 1.3.4 +% apa6 version 2.33 % -% NOTE CHANGE IN VERSION NUMBERING : 1.21--1.28 should have been 1.2.1--1.2.8 +% apa6 - A LaTeX class for formatting documents in compliance with the +% American Psychological Association's Publication Manual, 6th edition % -% Athanassios Protopapas, December 2008 -% protopap@ilsp.gr +% Copyright (C) 2011-2017 by Brian D. Beitzel <brian at beitzel.com> % -% This package may be distributed under the terms of the LaTeX Project Public -% License, as described in lppl.txt in the base LaTeX distribution. Either -% version 1.0 or, at your option, any later version. +% This work may be distributed and/or modified under the +% conditions of the LaTeX Project Public License (LPPL), either +% version 1.3c of this license or (at your option) any later +% version. The latest version of this license is in the file: % -% The term "package", in the above license statement, applies to all files -% included with apa.cls (language files, examples, configuration, -% instructions etc.) -- they may be all distributed under LPPL. +% http://www.latex-project.org/lppl.txt % -% Use with LaTeX2e, \documentclass[man|jou|doc]{apa} -% Default mode is doc. Conforms to the APA manual 5th ed. +% Users may freely modify these files without permission, as long as the +% copyright line and this statement are maintained intact. % -% ** Read apacls.txt and examples.txt carefully before using ** +% This work is not endorsed by, affiliated with, or probably even known +% by, the American Psychological Association. % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -1387,9 +1396,9 @@ and the derived files apa7.ins, % last in the definition list, whether or not the babel % package is loaded by the current document - \@ifundefined{def@babel}% this is defined only if the user requested loading babel - {\def\@apaSeven@langfile{config/APAamerican.txt}} - {\def\@apaSeven@langfile{config/APA\languagename.txt}} +\@ifpackageloaded{babel}% this is defined only if the user requested loading babel + {\def\@apaSeven@langfile{config/APA7\languagename.txt}} + {\def\@apaSeven@langfile{config/APA7american.txt}} \InputIfFileExists{\@apaSeven@langfile}{}{% \ClassInfo{apa7}{Language definition file \@apaSeven@langfile\space not found} }% @@ -3733,10 +3742,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % % %%%%%%%%%%% CONFIGURATION FILES %%%%%%%%%%%% % -%\begin{macro}{APAamerican.txt} +%\begin{macro}{APA7american.txt} % \begin{macrocode} %<*american> -\ProvidesFile{APAamerican.txt}[2012/02/23 v1.25 apa7 configuration for American English] +\ProvidesFile{APA7american.txt}[2019/12/29 v1.00 apa7 configuration for American English] \renewcommand{\acksname}{Author Note} \renewcommand{\keywordname}{Keywords} @@ -3748,10 +3757,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] %\end{macro} % % -%\begin{macro}{APAbritish.txt} +%\begin{macro}{APA7british.txt} % \begin{macrocode} %<*british> -\ProvidesFile{APAbritish.txt}[2012/02/23 v1.25 apa7 configuration for British English] +\ProvidesFile{APA7british.txt}[2019/12/29 v1.00 apa7 configuration for British English] \renewcommand{\acksname}{Author Note} \renewcommand{\keywordname}{Keywords} @@ -3763,10 +3772,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] %\end{macro} % % -%\begin{macro}{APAenglish.txt} +%\begin{macro}{APA7english.txt} % \begin{macrocode} %<*english> -\ProvidesFile{APAenglish.txt}[2012/02/23 v1.25 apa7 configuration for non-American English] +\ProvidesFile{APA7english.txt}[2019/12/29 v1.00 apa7 configuration for non-American English] \renewcommand{\acksname}{Author Note} \renewcommand{\keywordname}{Keywords} @@ -3776,10 +3785,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % \end{macrocode} %\end{macro} % -%\begin{macro}{APAdutch.txt} +%\begin{macro}{APA7dutch.txt} % \begin{macrocode} %<*dutch> -\ProvidesFile{APAdutch.txt}[2012/02/23 v1.25 apa7 configuration for Dutch] +\ProvidesFile{APA7dutch.txt}[2019/12/29 v1.00 apa7 configuration for Dutch] \renewcommand{\acksname}{Auteursnoot}% Author Note \renewcommand{\keywordname}{Trefwoorden}% Keywords @@ -3789,10 +3798,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % \end{macrocode} %\end{macro} % -%\begin{macro}{APAgerman.txt} +%\begin{macro}{APA7german.txt} % \begin{macrocode} %<*german> -\ProvidesFile{APAgerman.txt}[2012/02/23 v1.25 apa7 configuration for German] +\ProvidesFile{APA7german.txt}[2019/12/29 v1.00 apa7 configuration for German] \renewcommand{\acksname}{Autorenhinweis}% Author Note \renewcommand{\keywordname}{Schl\"usselw\"orter}% Keywords @@ -3802,10 +3811,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % \end{macrocode} %\end{macro} % -%\begin{macro}{APAngerman.txt} +%\begin{macro}{APA7ngerman.txt} % \begin{macrocode} %<*ngerman> -\ProvidesFile{APAgerman.txt}[2012/02/23 v1.25 apa7 configuration for "new" German] +\ProvidesFile{APA7german.txt}[2019/12/29 v1.00 apa7 configuration for "new" German] \renewcommand{\acksname}{Autorenhinweis}% Author Note \renewcommand{\keywordname}{Schl\"usselw\"orter}% Keywords @@ -3815,10 +3824,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % \end{macrocode} %\end{macro} % -%\begin{macro}{APAgreek.txt} +%\begin{macro}{APA7greek.txt} % \begin{macrocode} %<*greek> -\ProvidesFile{APAgreek.txt}[2012/02/23 v1.25 apa7 configuration for Greek] +\ProvidesFile{APA7greek.txt}[2019/12/29 v1.00 apa7 configuration for Greek] \renewcommand{\acksname}{Shmei'wseis tou suggraf'ea}% Author Note \renewcommand{\keywordname}{L'exeis kleidi'a}% Keywords @@ -3828,10 +3837,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % \end{macrocode} %\end{macro} % -%\begin{macro}{APAczech.txt} +%\begin{macro}{APA7czech.txt} % \begin{macrocode} %<*czech> -\ProvidesFile{APAczech.txt}[2012/02/23 v1.25 apa7 configuration for Czech] +\ProvidesFile{APA7czech.txt}[2019/12/29 v1.00 apa7 configuration for Czech] \renewcommand{\acksname}{Poznámka~autora}% Author Note \renewcommand{\keywordname}{Klícová~1slova}% Keywords @@ -3841,10 +3850,10 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % \end{macrocode} %\end{macro} % -%\begin{macro}{APAturkish.txt} +%\begin{macro}{APA7turkish.txt} % \begin{macrocode} %<*turkish> -\ProvidesFile{APAturkish.txt}[2016/05/26 v2.2 apa7 configuration for Turkish] +\ProvidesFile{APA7turkish.txt}[2019/12/29 v1.00 apa7 configuration for Turkish] \renewcommand{\acksname}{Yazar Notu}% Author Note \renewcommand{\keywordname}{Anahtar Kelimeler}% Keywords @@ -3854,7 +3863,7 @@ The detailed results are shown in Table~\ref{tab:DeckedTable}. \lipsum[22] % \end{macrocode} %\end{macro} % -%\begin{macro}{APAendfloat.cfg} +%\begin{macro}{APA7endfloat.cfg} % \begin{macrocode} %<*APAendfloat> %% |