summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/semantic-markup/semantic-markup.sty
blob: 9a5223347fd9677da76ded3a9b65561f14fa68f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{semantic-markup}[2020/01/29
  Macros for TEI-like semantic markup]
% Copyright 2020 Andrew A. Cashner, andrewacashner@gmail.com

% This work may be distributed and/or modified under the 
% conditions of the LaTeX Project Public License, either
% version 1.3 of this license or (at your option) any 
% later version.
% The latest version of this license is in 
%    http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions
% of LaTeX version 2005/12/01 or later.
%
% This work has the LPPL maintenance status `maintained'.
% The Current Maintainer of this work is Andrew A. Cashner.
% This work consists of the package file semantic-markup.sty 
% and the documentation file semantic-markup.tex.

% CHANGE LOG
% 2020-01-29 - \musfig uses stackengine now instead of amsmath
% 2018-09-07 - ! and ? removed from autopunct for csquotes
% 2018-05-21 - Use fontspec's definition of `\strong` if it is loaded
%            - Use musicography's definition of `\fl`, `\sh`, `\na` commands if
%              it is loaded
%            - `\wtitle` and `\ptitle` shorthands added 
%            - Customizable commands added for endnotes option
%
% 2016-09-22 - `endnotes' option added
% 2016-09-01 - First version on CTAN

% Option to use csquotes default behavior instead of the 
% US localized punctuation used in this package
\newif\ifdefaultquotes
\defaultquotesfalse 
\DeclareOption{defaultquotes}{\defaultquotestrue}

% Option to convert footnotes to endnotes, include
% Footnote environment
\newif\ifendnotes
\endnotesfalse
\DeclareOption{endnotes}{\endnotestrue}

\ProcessOptions\relax
%**************************

\RequirePackage{xparse}

\RequirePackage{csquotes}
\ifdefaultquotes\else
  % Put end punctuation inside quotation marks 
  % for the specified marks
  \renewcommand{\mktextquote}[6]{#1#2#4#5#3#6}
  \DeclareAutoPunct{.,}
\fi

% NB: fontspec defines its own \strong command, so only define this if fontspec
% not loaded
\@ifpackageloaded{fontspec}{}{%
    \NewDocumentCommand{\strong}{}	
    {\textbf}
}


\NewDocumentCommand{\quoted}{}	
{\textquote}
\NewDocumentCommand{\soCalled}{}
{\textquote}

\NewDocumentCommand{\code}{}	
{\texttt}
\NewDocumentCommand{\term}{}	
{\emph}
\NewDocumentCommand{\mentioned}{}	
{\emph}
\NewDocumentCommand{\foreign}{}
{\emph}

\NewDocumentCommand{\worktitle}{}
{\emph}
\NewDocumentCommand{\parttitle}{}
{\textquote}

% Shorter versions of these frequently used commands
\NewDocumentCommand{\wtitle}{}{\worktitle}
\NewDocumentCommand{\ptitle}{}{\parttitle}

% editorial addition
\NewDocumentCommand{\add}{ m }
{[#1]}
% editorial ellipsis
\NewDocumentCommand{\Dots}{}{\add{\dots}}
% explanatory gloss of technical or foreign term
\NewDocumentCommand{\gloss}{ m m }{%
  \mentioned{#1} (#2)%
}
% explanatory gloss of word in quotation marks
\NewDocumentCommand{\quotedgloss}{ m m }{%
  \quoted{#1} (#2)%
}

%*******************
% Identify problem spot in draft
\NewDocumentCommand{\XXX}{ O{FIX} }{%
    \strong{\add{#1}}%
}
% Indicate citation to be filled in later
% Optional argument for indicating the source
\NewDocumentCommand{\citXXX}{ o }{%
    \footnote{\strong{\add{Citation needed\IfValueTF{#1}{: #1}{}}}}%
}

%*******************
% Footnote as environment
\RequirePackage{environ}
\NewEnviron{Footnote}{\footnote{\BODY}}[]

%******************
% Endnotes, if desired

\ifendnotes
    \RequirePackage{endnotes}

    % Customize these commands with \renewcommand
    \NewDocumentCommand{\DoBeforeEndnotes}{}{\clearpage}
    \NewDocumentCommand{\EndnoteFont}{}{}

    % Optionally remove this (\renewcommand{\MakeEndnotes}{})
    % to avoid conflicts with endnotes or other packages
    \NewDocumentCommand{\SetupEndnotes}{}{%
      \let\footnote=\endnote
      \AtEndDocument{\DoBeforeEndnotes{\EndnoteFont\theendnotes}}%
    }

    \AtBeginDocument{%
        \SetupEndnotes{}%
        % Footnote environment adjusted to fix expansion problem
        \RenewEnviron{Footnote}{\expandafter\footnote\expandafter{\BODY}}[]%
    }%
\fi
%******************

%****************************************
% MUSIC SYMBOLS

% Accidentals using LaTeX symbols
% Use better definitions from musicography if it was loaded first
\@ifpackageloaded{musicography}{}{%
    \NewDocumentCommand{\fl}{}{$\flat$}
    \NewDocumentCommand{\na}{}{$\natural$}
    \NewDocumentCommand{\sh}{}{$\sharp$}
}

% Octave subscripts 
\NewDocumentCommand{\octave}{ }{\textsubscript}

% Music figures
\RequirePackage{stackengine}
\setstackgap{S}{2pt}
\NewDocumentCommand{\musfig}{ m m }{%
    \Shortstack{#1 #2}%
}

% Meter signatures
\NewDocumentCommand{\meter}{}{\musfig}

\endinput