Re: [PATCH -perfbook 2/2] styleguide: Get rid of \VerbatimFootnotes macro

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sun, 29 Nov 2020 08:50:19 -0800, Paul E. McKenney wrote:
> On Sun, Nov 29, 2020 at 11:33:20PM +0900, Akira Yokosawa wrote:
>> >From b04aeebd8cb7d2ec0e5387c98011601cc4e0c270 Mon Sep 17 00:00:00 2001
>> From: Akira Yokosawa <akiyks@xxxxxxxxx>
>> Date: Sun, 29 Nov 2020 17:01:24 +0900
>> Subject: [PATCH -perfbook 2/2] styleguide: Get rid of \VerbatimFootnotes macro
>>
>> It turns out that this macro is not compatible with the
>> "footnotebackref" package, which enables hyperlinks from
>> footnotes to the corresponding footnote symbols in the text.
>> Furthermore, it is wrong to use the macro in the middle
>> of a book.
>> It is supposed to be used next to \begin{document}.
>>
>> \VerbatimFootnote overrides the definition of \footnote{} based
>> on the default code of standard LaTeX classes and breaks customization
>> done by footnotebackref.
>>
>> In perfbook, this affects footnotes in "Answers to Quick Quizzes"
>> and Glossary as well as those in the latter part of Style Guide.
>>
>> As it is not used anywhere else, remove the macro and update the
>> footnote text accordingly.
>>
>> Signed-off-by: Akira Yokosawa <akiyks@xxxxxxxxx>
> 
> These are future-proofing, given no footnotes currently in the glossary
> and beyond, correct?

There is a footnote in the description of "Cache Miss".
Otherwise, I wouldn't have noticed the wrong count.

Looks like back matters are not supposed to have sections or footnotes.

        Thanks, Akira

> 
> Either way, queued and pushed!
> 
> 							Thanx, Paul
> 
>> ---
>>  appendix/styleguide/styleguide.tex | 13 +++++++------
>>  1 file changed, 7 insertions(+), 6 deletions(-)
>>
>> diff --git a/appendix/styleguide/styleguide.tex b/appendix/styleguide/styleguide.tex
>> index b6b343e0..11802a85 100644
>> --- a/appendix/styleguide/styleguide.tex
>> +++ b/appendix/styleguide/styleguide.tex
>> @@ -772,14 +772,15 @@ If they are escaped by a~\qco{\\},
>>  they appear in the end result with the escape character.
>>  The \qco{\\verb} command can be used in running text if you
>>  need to use monospace font for a string which contains
>> -many characters to escape.\VerbatimFootnotes\footnote{
>> -  The \verb|\verb| command is not almighty though.
>> +many characters to escape.\footnote{
>> +  The \co{\\verb} command is not almighty though.
>>    For example, you can't use it within a footnote.
>>    If you do so, you will see a fatal \LaTeX\ error.
>> -  The \qco{fancyvrb} package provides a workaround by
>> -  the name of \verb|\VerbatimFootnotes| macro.
>> -  This footnote is an example which contains a few \verb|\verb|
>> -  commands.}
>> +  A workaround would be a macro named \co{\\VerbatimFootnotes}
>> +  provided by the \co{fancyvrb} package.
>> +  Unfortunately, perfbook can't employ it due to the interference
>> +  with the \co{footnotebackref} package.
>> +  }
>>  
>>  \subsection{Cross-reference}
>>  \label{sec:app:styleguide:Cross-Reference}
>> -- 
>> 2.17.1
>>
>>



[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux