-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhereapplies-doc.lyx
1131 lines (854 loc) · 16 KB
/
hereapplies-doc.lyx
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
\origin unavailable
\textclass article
\begin_preamble
\usepackage{doc}
\usepackage{upquote}
\AtBeginDocument{%
% LyX should add automatically `\usepackage{listings}` to the preamble...
\lstset{%
language=TeX,
basicstyle=\footnotesize,
numbers=left,
stepnumber=1,
showstringspaces=false,
tabsize=1,
breaklines=true,
breakatwhitespace=false,
}%
}
\end_preamble
\use_default_options false
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding ascii
\fontencoding global
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype true
\use_dash_ligatures true
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\spacing onehalf
\use_hyperref true
\pdf_title "The \\textquotedblleft{}Here Applies\\textquotedblright{} LaTeX Package"
\pdf_author "madmurphy"
\pdf_subject "Package documentation"
\pdf_keywords "Glossary, Index, LaTeX, LaTeX hyperref, LaTeX labels, LaTeX package, LyX, LyX module, TOC"
\pdf_bookmarks true
\pdf_bookmarksnumbered false
\pdf_bookmarksopen false
\pdf_bookmarksopenlevel 1
\pdf_breaklinks false
\pdf_pdfborder false
\pdf_colorlinks false
\pdf_backref false
\pdf_pdfusetitle false
\papersize a4paper
\use_geometry true
\use_package amsmath 1
\use_package amssymb 0
\use_package cancel 0
\use_package esint 1
\use_package mathdots 0
\use_package mathtools 0
\use_package mhchem 0
\use_package stackrel 0
\use_package stmaryrd 0
\use_package undertilde 0
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 0
\use_minted 0
\index Index
\shortcut idx
\color #008000
\end_index
\leftmargin 3.25cm
\topmargin 3.25cm
\rightmargin 3.25cm
\bottommargin 3.25cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\is_math_indent 0
\math_numbering_side default
\quotes_style english
\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Title
The
\series bold
Here Applies
\series default
\SpecialChar LaTeX
Package
\end_layout
\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Abstract
A \SpecialChar LaTeX
package for referencing groups of pages that share something in common.
\end_layout
\begin_layout Standard
\begin_inset VSpace 2cm
\end_inset
\end_layout
\begin_layout Section
Overview
\end_layout
\begin_layout Standard
\series bold
Here Applies
\series default
is a \SpecialChar LaTeX
package that allows to collect groups of labels and reference them
altogether.
It can be used for creating informal glossaries that cross-link concepts
to their applications, or simply mentioning multiple pages that share something
in common.
\end_layout
\begin_layout Standard
The package offers two commands:
\family typewriter
\backslash
hereapplies
\family default
and
\family typewriter
\backslash
whereapplies
\family default
(plus their
\begin_inset Quotes eld
\end_inset
starred
\begin_inset Quotes erd
\end_inset
versions
\family typewriter
\backslash
hereapplies*
\family default
and
\family typewriter
\backslash
whereapplies*
\family default
).
In both cases an identifier is passed as argument, and this can be any
string invented in the moment (
\family typewriter
\backslash
hereapplies
\family default
additionally supports more than one identifier in the form of a comma-separated
list).
\end_layout
\begin_layout Standard
Every time
\family typewriter
\backslash
hereapplies
\family default
is invoked with known identifiers, the document is made aware that the
place shares some kind of connection with other places in which the same
identifiers were used.
And so, every time the
\family typewriter
\backslash
whereapplies
\family default
command is invoked with a known identifier, all occurrences of the latter
within the entire document will be printed in the form of a linkable page
list (e.g.
\begin_inset Quotes eld
\end_inset
pp.
\begin_inset space \space{}
\end_inset
1, 5, 8–9, 14–20…
\begin_inset Quotes erd
\end_inset
).
\end_layout
\begin_layout Standard
As
\family typewriter
\backslash
hereapplies
\family default
is designed to be invoked in the middle of a chapter or a section and that
location must be made linkable, the
\family typewriter
\backslash
phantomsection
\family default
directive is invoked by default before a label is added.
To avoid calling
\family typewriter
\backslash
phantomsection
\family default
, the
\begin_inset Quotes eld
\end_inset
starred
\begin_inset Quotes erd
\end_inset
command
\family typewriter
\backslash
hereapplies*
\family default
is available.
\end_layout
\begin_layout Standard
Finally, like
\family typewriter
\backslash
whereapplies
\family default
resembles a pluralizable version of
\family typewriter
\backslash
pageref
\family default
, its
\begin_inset Quotes eld
\end_inset
starred
\begin_inset Quotes erd
\end_inset
version
\family typewriter
\backslash
whereapplies*
\family default
will resemble a pluralizable version of
\family typewriter
\backslash
pageref*
\family default
.
\end_layout
\begin_layout Standard
If you use LyX, the package ships a LyX module as well (please check the
\family typewriter
lyx-module
\family default
subdirectory).
\end_layout
\begin_layout Standard
\begin_inset Newpage pagebreak
\end_inset
\end_layout
\begin_layout Section
Example usage
\end_layout
\begin_layout Standard
The following \SpecialChar LaTeX
manuscript
\end_layout
\begin_layout Standard
\begin_inset VSpace 3ex
\end_inset
\end_layout
\begin_layout Standard
\begin_inset CommandInset include
LatexCommand lstinputlisting
filename "hereapplies-example.tex"
lstparams "language=TeX"
\end_inset
\end_layout
\begin_layout Standard
\begin_inset VSpace 3ex
\end_inset
\end_layout
\begin_layout Standard
\noindent
will generate the
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
hereapplies-example.pdf
\end_layout
\end_inset
document attached.
\end_layout
\begin_layout Section
A minimal tutorial
\end_layout
\begin_layout Standard
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
\backslash
begin{macro}{
\backslash
hereapplies}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Syntax:
\end_layout
\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
\family typewriter
\backslash
hereapplies
\begin_inset space \enskip{}
\end_inset
[
\begin_inset Formula $\langle$
\end_inset
\shape italic
label
\shape default
\begin_inset Formula $\rangle$
\end_inset
]
\begin_inset space \enskip{}
\end_inset
{
\begin_inset Formula $\langle$
\end_inset
\shape italic
identifiers
\shape default
\begin_inset Formula $\rangle$
\end_inset
}
\end_layout
\begin_layout Standard
\family typewriter
\backslash
hereapplies*
\begin_inset space \enskip{}
\end_inset
[
\begin_inset Formula $\langle$
\end_inset
\shape italic
label
\shape default
\begin_inset Formula $\rangle$
\end_inset
]
\begin_inset space \enskip{}
\end_inset
{
\begin_inset Formula $\langle$
\end_inset
\shape italic
identifiers
\shape default
\begin_inset Formula $\rangle$
\end_inset
}
\end_layout
\begin_layout Standard
\noindent
\begin_inset VSpace smallskip
\end_inset
\end_layout
\begin_layout Standard
\noindent
The
\family typewriter
\backslash
hereapplies
\family default
command notifies the document that one or more identifiers apply to a particula
r point and adds a label to it.
\end_layout
\begin_layout Standard
If the optional argument is passed the label created will be named accordingly,
otherwise an opaque name will be chosen for it.
This argument may contain only what is legal for
\family typewriter
\backslash
pageref
\family default
.
\end_layout
\begin_layout Standard
The
\family typewriter
\shape italic
identifiers
\family default
\shape default
argument must be a comma-separated list of identifiers (leading and trailing
spaces around each member will be ignored).
Each of these strings will remain confined within the internal scope of
the package and will not create conflicts with possible macros or labels
of the same names.
\end_layout
\begin_layout Standard
After storing some internal values,
\family typewriter
\backslash
hereapplies
\family default
will expand exactly to
\end_layout
\begin_layout Standard
\begin_inset VSpace smallskip
\end_inset
\end_layout
\begin_layout Standard
\begin_inset listings
lstparams "language=TeX,numbers=none"
inline false
status open
\begin_layout Plain Layout
\backslash
phantomsection
\backslash
label{...}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset VSpace smallskip
\end_inset
\end_layout
\begin_layout Standard
Its
\begin_inset Quotes eld
\end_inset
starred
\begin_inset Quotes erd
\end_inset
version (
\family typewriter
\backslash
hereapplies*
\family default
) will not invoke the
\family typewriter
\backslash
phantomsection
\family default
directive.
\end_layout
\begin_layout Standard
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
\backslash
end{macro}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset VSpace smallskip
\end_inset
\end_layout
\begin_layout Standard
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
\backslash
begin{macro}{
\backslash
whereapplies}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Syntax:
\end_layout
\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
\family typewriter
\backslash
whereapplies
\begin_inset space \enskip{}
\end_inset
{
\begin_inset Formula $\langle$
\end_inset
\shape italic
identifier
\shape default
\begin_inset Formula $\rangle$
\end_inset
}
\end_layout
\begin_layout Standard
\family typewriter
\backslash
whereapplies*
\begin_inset space \enskip{}
\end_inset
{
\begin_inset Formula $\langle$
\end_inset
\shape italic
identifier
\shape default
\begin_inset Formula $\rangle$
\end_inset
}
\end_layout
\begin_layout Standard
\noindent
\begin_inset VSpace smallskip
\end_inset
\end_layout
\begin_layout Standard
\noindent
The
\family typewriter
\backslash
whereapplies
\family default
command prints all the occurrences of an identifier, in the form
\begin_inset Quotes eld
\end_inset
p.
\begin_inset space \space{}
\end_inset
…
\begin_inset Quotes erd
\end_inset
or
\begin_inset Quotes eld
\end_inset
pp.
\begin_inset space \space{}
\end_inset
…
\begin_inset Quotes erd
\end_inset
(with page range support).
\end_layout
\begin_layout Standard
The
\family typewriter
\shape italic
identifier
\family default
\shape default
argument will remain confined within the internal scope of the package
and will not create conflicts with possible commands or labels of the same
name.
Leading and trailing spaces around this string will be ignored.
\end_layout
\begin_layout Standard
If the same
\family typewriter
\shape italic
identifier
\family default
\shape default
is not passed to
\family typewriter
\backslash
hereapplies
\family default
at least once throughout the document,
\family typewriter
\backslash
whereapplies
\family default
will print
\begin_inset Quotes eld
\end_inset
\series bold
??
\series default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Standard
The
\begin_inset Quotes eld
\end_inset
starred
\begin_inset Quotes erd
\end_inset
version of this command (
\family typewriter
\backslash
whereapplies*
\family default
) will use
\family typewriter
\backslash
pageref*
\family default
instead of
\family typewriter
\backslash
pageref
\family default
for generating the page list.
\end_layout
\begin_layout Standard
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
\backslash
end{macro}
\end_layout
\end_inset
\end_layout
\begin_layout Section
Internationalization
\end_layout
\begin_layout Standard
Currently the localization of
\series bold
Here Applies
\series default
is not automatic.
It is possible however to control the strings generated by overwriting
the four macros
\family typewriter
\backslash
hapage
\family default
,
\family typewriter
\backslash
hapages
\family default
,
\family typewriter
\backslash
hadelimiter
\family default
and
\family typewriter
\backslash
halastdelimiter
\family default
.
For example, writing at the beginning of a document
\end_layout
\begin_layout Standard
\begin_inset VSpace 3ex
\end_inset
\end_layout
\begin_layout Standard
\begin_inset listings
lstparams "language=TeX"
inline false
status open
\begin_layout Plain Layout
% German translation of **Here Applies**
\end_layout
\begin_layout Plain Layout
% English: "p.
\backslash
"
\end_layout
\begin_layout Plain Layout
\backslash
gdef
\backslash
hapage{S.
\backslash
}
\end_layout
\begin_layout Plain Layout
% English: "pp.
\backslash
"
\end_layout
\begin_layout Plain Layout
\backslash
gdef
\backslash
hapages{S.
\backslash
}
\end_layout
\begin_layout Plain Layout
% English: "
\backslash
and
\backslash
"
\end_layout
\begin_layout Plain Layout
\backslash
gdef
\backslash
halastdelimiter{
\backslash
und
\backslash
}
\end_layout
\begin_layout Plain Layout
% English: ",
\backslash
" (exactly like in German -- leave it)
\end_layout
\begin_layout Plain Layout
%
\backslash
gdef
\backslash
hadelimiter{,
\backslash
}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset VSpace 3ex
\end_inset
\end_layout
\begin_layout Standard
\noindent
will translate
\begin_inset Quotes eld
\end_inset
pp.
\begin_inset space \space{}
\end_inset
2, 4 and 6
\begin_inset Quotes erd
\end_inset