Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support reference to page numbers of an element tag #242

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions scribble-lib/scribble/base.rkt
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,9 @@
(#:underline? any/c)
#:rest (listof pre-content?)
element?)]
[pageref (->* ((or/c taglet? generated-tag?))
(#:underline? any/c)
element?)]
[secref (->* (string?)
(#:doc (or/c #f module-path?)
#:tag-prefixes (or/c #f (listof string?))
Expand Down Expand Up @@ -590,6 +593,9 @@
(define (elemref #:underline? [u? #t] t . body)
(make-link-element (if u? #f "plainlink") (decode-content body) `(elem ,t)))

(define (pageref t #:underline? [u? #t])
(make-link-element (if u? #f "plainlink") null `(page ,t)))

(define (secref s #:underline? [u? #t] #:doc [doc #f] #:tag-prefixes [prefix #f]
#:link-render-style [link-style #f])
(make-link-element (let ([name (if u? #f "plainlink")])
Expand Down
19 changes: 14 additions & 5 deletions scribble-lib/scribble/core.rkt
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,15 @@
(resolve-get/ext-id* part ri key #f))

(define (resolve-get/ext-id* part ri key search-key)
(let-values ([(v ext-id) (resolve-get/where part ri key)])
(when ext-id
(hash-set! (resolve-info-undef ri) (tag-key key ri)
(if v 'found search-key)))
(values v ext-id)))
(let ((real-key
(if (pageref-tag? key)
(cons 'elem (cdr key))
key)))
(let-values ([(v ext-id) (resolve-get/where part ri real-key)])
(when ext-id
(hash-set! (resolve-info-undef ri) (tag-key real-key ri)
(if v 'found search-key)))
(values v ext-id))))

(define (resolve-get part ri key)
(resolve-get* part ri key #f))
Expand Down Expand Up @@ -108,6 +112,11 @@
(serializable? (cadr s))))
(null? (cddr s))))

(provide pageref-tag?)
(define (pageref-tag? x)
(and (tag? x)
(equal? (car x) 'page)))

(provide block?)
(define (block? p)
(or (paragraph? p)
Expand Down
20 changes: 15 additions & 5 deletions scribble-lib/scribble/latex-render.rkt
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@
(parameterize ([done-link-page-numbers (or (done-link-page-numbers)
(link-element? e))])
(when (target-element? e)
(printf "\\label{t:~a}"
(printf "\\phantomsection\\label{t:~a}"
(t-encode (add-current-tag-prefix (tag-key (target-element-tag e) ri)))))
(when part-label?
(define-values (dest ext?) (resolve-get/ext? part ri (link-element-tag e)))
Expand Down Expand Up @@ -393,8 +393,15 @@
(style-name es)
es)]
[style (and (style? es) es)]
[pageref? (and (not part-label?)
(link-element? e)
(pageref-tag? (link-element-tag e))
(not (disable-hyperref))
(let-values ([(dest ext?) (resolve-get/ext? part ri (cons 'elem (cdr (link-element-tag e))))])
(and dest (not ext?))))]
[hyperref? (and (not part-label?)
(link-element? e)
(not (pageref-tag? (link-element-tag e)))
(not (disable-hyperref))
(let-values ([(dest ext?) (resolve-get/ext? part ri (link-element-tag e))])
(and dest (not ext?))))]
Expand Down Expand Up @@ -537,15 +544,18 @@
(wrap e style-name 'exact)]
[else
(core-render e tt?)]))
(when pageref?
(printf "\\PageRef{\\pageref{t:~a}}"
(t-encode (cons 'elem (cdr (link-element-tag e))))))
(when hyperref?
(printf "\\hyperref[t:~a]{"
(t-encode (link-element-tag e))))
(let loop ([l (if style (style-properties style) null)] [tt? #f])
(if (null? l)
(if hyperref?
(parameterize ([disable-hyperref #t])
(finish tt?))
(finish tt?))
(cond [pageref? (void)]
[hyperref? (parameterize ([disable-hyperref #t])
(finish tt?))]
[else (finish tt?)])
(let ([v (car l)])
(cond
[(target-url? v)
Expand Down
3 changes: 3 additions & 0 deletions scribble-lib/scribble/scribble.tex
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
\newcommand{\preDoc}{}
\newcommand{\postDoc}{}

% Generated by `pageref'; first arg is a page number
\newcommand{\PageRef}[1]{page~#1}

% Generated by `secref'; first arg is section number, second is section title:
\newcommand{\BookRef}[2]{\emph{#2}}
\newcommand{\ChapRef}[2]{\SecRef{#1}{#2}}
Expand Down