wilderjds
/
ox-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make the table anchors more readable

Browse Source 
- Fixes https://github.com/kaushalmodi/ox-hugo/issues/206.
- Move org-hugo--get-reference from ox-hugo.el to
  org-blackfriday--get-reference in ox-blackfriday.el.
- Minor code cleanup; remove commented out calls to
  org-export-get-reference.
master
Kaushal Modi 8 years ago
parent 717bcdb17a
commit c211999a84
5 changed files with 75 additions and 78 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 56
      ox-blackfriday.el
  2. 51
      ox-hugo.el
  3. 14
      test/site/content/posts/links-to-tables.md
  4. 6
      test/site/content/posts/table-caption.md
  5. 26
      test/site/content/posts/table-styling.md

56
ox-blackfriday.el
Unescape View File

@ -418,6 +418,41 @@ Details: https://github.com/kaushalmodi/ox-hugo/issues/57."
;; It's not visible (because zero width), but it's there.
code))
;;;; Get Reference
(defun org-blackfriday--get-reference (elem info)
"Return a reference for ELEM using its ordinal if available.
INFO is a plist used as a communication channel.
If the ELEM doesn't have its `name' defined, nil is returned.
Else, if the ELEM has its `caption' defined, a reference of the
kind \"org-ELEM-ORDINAL\" is returned.
Else, the random reference generated using
`org-export-get-reference' is returned.
The return value, if non-nil, is a string."
(let ((name-exists (org-element-property :name elem)))
;; Reference cannot be created if #+name does not exist.
(when name-exists
(let ((elem-ordinal (org-export-get-ordinal ;This is nil if a code snippet has no caption
elem info
nil #'org-html--has-caption-p)))
(if elem-ordinal
(let* ((elem-type (org-element-type elem))
(prefix (cond
((eq 'src-block elem-type)
"code-snippet")
((eq 'table elem-type)
"table")
(t
(format "org-%s" (symbol-name elem-type))))))
(format "%s-%d" prefix elem-ordinal))
;; Return the randomly generated Org reference if the
;; element ordinal is nil.
(org-export-get-reference elem info))))))
;;; Transcode Functions
@ -936,16 +971,15 @@ contextual information."
;; (message "[ox-bf-table DBG] In contents: %s" contents)
(let* ((rows (org-element-map table 'table-row 'identity info))
(no-header (= (length rows) 1)) ;No header if table has just 1 row
(label (let ((lbl (and (org-element-property :name table)
(org-export-get-reference table info))))
(if lbl
(format "<a id=\"%s\"></a>\n\n" lbl)
"")))
(table-ref (org-blackfriday--get-reference table info))
(table-anchor (if table-ref
(format "<a id=\"%s\"></a>\n" table-ref)
""))
(caption (org-export-get-caption table))
table-num
(caption-html (if (not caption)
""
(let ((caption-prefix-fmt-str (org-html--translate "Table %d:" info))
(let ((caption-prefix (org-html--translate "Table" info))
(caption-str
(org-html-convert-special-strings ;Interpret em-dash, en-dash, etc.
(org-export-data-with-backend caption 'html info))))
@ -953,10 +987,14 @@ contextual information."
table info
nil #'org-html--has-caption-p))
(format (concat "<div class=\"table-caption\">\n"
" <span class=\"table-number\">%s</span>\n"
" <span class=\"table-number\">%s</span>:\n"
" %s\n"
"</div>\n\n")
(format caption-prefix-fmt-str table-num)
(if table-ref ;Hyperlink the table prefix + number
(format "<a href=\"#%s\">%s %s</a>"
table-ref caption-prefix table-num)
(format "%s %s"
caption-prefix table-num))
caption-str))))
(attr (org-export-read-attribute :attr_html table))
;; At the moment only the `class' attribute is supported in
@ -1011,7 +1049,7 @@ contextual information."
(dummy-header (replace-regexp-in-string "[-:]" " " hrule)))
(setq tbl (concat dummy-header "\n" hrule "\n" row-1))))
;; (message "[ox-bf-table DBG] Tbl:\n%s" tbl)
(concat table-pre label caption-html tbl table-post)))
(concat table-pre table-anchor caption-html tbl table-post)))
;;;; Verse Block
(defun org-blackfriday-verse-block (_verse-block contents info)

51
ox-hugo.el
Unescape View File

@ -1075,9 +1075,7 @@ contents according to the current headline."
(org-export-toc-entry-backend 'hugo)
info)
(or (org-element-property :CUSTOM_ID headline)
(org-hugo-slug title)
;; (org-export-get-reference headline info)
)))
(org-hugo-slug title))))
(tags (and (plist-get info :with-tags)
(not (eq 'not-in-toc (plist-get info :with-tags)))
(let ((tags (org-export-get-tags headline info)))
@ -1567,39 +1565,6 @@ INFO is a plist used as a communication channel."
;; (message "[ox-hugo DBG pandoc-enabled-bool] %S" pandoc-enabled-bool)
pandoc-enabled-bool))
;;;; Get Reference
(defun org-hugo--get-reference (elem info)
"Return a reference for ELEM using its ordinal if available.
INFO is a plist used as a communication channel.
If the ELEM doesn't have its `name' defined, nil is returned.
Else, if the ELEM has its `caption' defined, a reference of the
kind \"org-ELEM-ORDINAL\" is returned.
Else, the random reference generated using
`org-export-get-reference' is returned.
The return value, if non-nil, is a string."
(let ((name-exists (org-element-property :name elem)))
;; Reference cannot be created if #+name does not exist.
(when name-exists
(let ((elem-ordinal (org-export-get-ordinal ;This is nil if a code snippet has no caption
elem info
nil #'org-html--has-caption-p)))
(if elem-ordinal
(let* ((elem-type (org-element-type elem))
(prefix (cond
((eq 'src-block elem-type)
"code-snippet")
(t
(format "org-%s" (symbol-name elem-type))))))
(format "%s-%d" prefix elem-ordinal))
;; Return the randomly generated Org reference if the
;; element ordinal is nil.
(org-export-get-reference elem info))))))
;;; Transcode Functions
@ -1738,9 +1703,7 @@ a communication channel."
(t
(let ((anchor (format "{#%s}" ;https://gohugo.io/extras/crossreferences/
(or (org-element-property :CUSTOM_ID headline)
(org-hugo-slug title)
;; (org-export-get-reference headline info)
)))
(org-hugo-slug title))))
(loffset (string-to-number (plist-get info :hugo-level-offset))) ;"" -> 0, "0" -> 0, "1" -> 1, ..
(todo (when todo
(concat (org-hugo--todo todo info) " "))))
@ -1948,9 +1911,7 @@ and rewrite link paths to make blogging more seamless."
title))
;; Reference
(or (org-element-property :CUSTOM_ID destination)
(org-hugo-slug title)
;; (org-export-get-reference destination info)
))))
(org-hugo-slug title)))))
(_
(let ((description
(or (org-string-nw-p desc)
@ -1968,8 +1929,8 @@ and rewrite link paths to make blogging more seamless."
(when description
(format "[%s](#%s)"
description
(if (eq 'src-block (org-element-type destination))
(org-hugo--get-reference destination info)
(if (memq (org-element-type destination) '(src-block table))
(org-blackfriday--get-reference destination info)
(org-export-get-reference destination info)))))))))
((org-export-inline-image-p link org-html-inline-image-rules)
;; (message "[ox-hugo-link DBG] Inline image: %s" raw-path)
@ -2375,7 +2336,7 @@ channel."
(replace-regexp-in-string "," " " hl-lines)) ;"1,3-4" -> "1 3-4"
((numberp hl-lines)
(number-to-string hl-lines))))
(src-ref (org-hugo--get-reference src-block info))
(src-ref (org-blackfriday--get-reference src-block info))
(src-anchor (if src-ref
(format "<a id=\"%s\"></a>\n" src-ref)
""))

14
test/site/content/posts/links-to-tables.md
Unescape View File

@ -31,10 +31,9 @@ Here's another table:
will output below (_lorem-ipsum_ added to increase page content so
that the link jump is evident):
<a id="orgc7b6804"></a>
<a id="table-1"></a>
<div class="table-caption">
<span class="table-number">Table 1:</span>
<span class="table-number"><a href="#table-1">Table 1</a></span>:
Simple table 1
</div>
@ -42,7 +41,7 @@ that the link jump is evident):
|---|---|
| c | d |
**Here we refer to table [2](#org8cdb51c).**
**Here we refer to table [2](#table-2).**
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque et
quam metus. Etiam in iaculis mi, sit amet pretium magna. Donec ut dui
@ -98,10 +97,9 @@ blandit in.
Here's another table:
<a id="org8cdb51c"></a>
<a id="table-2"></a>
<div class="table-caption">
<span class="table-number">Table 2:</span>
<span class="table-number"><a href="#table-2">Table 2</a></span>:
Simple table 2
</div>
@ -109,7 +107,7 @@ Here's another table:
|---|---|
| g | h |
**Here we refer to table [1](#orgc7b6804).**
**Here we refer to table [1](#table-1).**
---

6
test/site/content/posts/table-caption.md
Unescape View File

@ -8,7 +8,7 @@ The caption can contain be emphasized using the usual markup
characters too.
<div class="table-caption">
<span class="table-number">Table 1:</span>
<span class="table-number">Table 1</span>:
Awesome table
</div>
@ -19,7 +19,7 @@ characters too.
Some text.
<div class="table-caption">
<span class="table-number">Table 2:</span>
<span class="table-number">Table 2</span>:
<i>Another</i> <b>awesome</b> table
</div>
@ -30,7 +30,7 @@ Some text.
Some more text.
<div class="table-caption">
<span class="table-number">Table 3:</span>
<span class="table-number">Table 3</span>:
<span class="underline">Third</span> table &#x2014; Caption with em-dash &#x2013; and &#x2013; en-dash
</div>

26
test/site/content/posts/table-styling.md
Unescape View File

@ -81,7 +81,7 @@ specified CSS attribute is auto-set for `.my-table-2 table`.
<div></div>
<div class="table-caption">
<span class="table-number">Table 1:</span>
<span class="table-number">Table 1</span>:
Table with caption, with left-aligned text
</div>
@ -101,7 +101,7 @@ specified CSS attribute is auto-set for `.table-1 table`.
<div></div>
<div class="table-caption">
<span class="table-number">Table 2:</span>
<span class="table-number">Table 2</span>:
Table with caption, with right-aligned text
</div>
@ -117,7 +117,7 @@ specified CSS attribute is auto-set for `.table-1 table`.
<div></div>
<div class="table-caption">
<span class="table-number">Table 3:</span>
<span class="table-number">Table 3</span>:
Table with caption, with center-aligned text
</div>
@ -136,7 +136,7 @@ specified CSS attribute is auto-set for `.table-1 table`.
<div></div>
<div class="table-caption">
<span class="table-number">Table 4:</span>
<span class="table-number">Table 4</span>:
Table with caption, class and CSS attributes specified
</div>
@ -184,7 +184,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 5:</span>
<span class="table-number">Table 5</span>:
Table with verbatim CSS
</div>
@ -217,7 +217,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 6:</span>
<span class="table-number">Table 6</span>:
Table with uncollapsed borders
</div>
@ -242,7 +242,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 7:</span>
<span class="table-number">Table 7</span>:
Table with collapsed borders
</div>
@ -280,7 +280,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 8:</span>
<span class="table-number">Table 8</span>:
Table with 1st row and 1st column highlighted
</div>
@ -315,7 +315,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 9:</span>
<span class="table-number">Table 9</span>:
Sane Table &#x2014; with minimal styling
</div>
@ -340,7 +340,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 10:</span>
<span class="table-number">Table 10</span>:
Table with zebra striping
</div>
@ -369,7 +369,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 11:</span>
<span class="table-number">Table 11</span>:
Table where the hovered-upon cell highlights
</div>
@ -395,7 +395,7 @@ block.
<div></div>
<div class="table-caption">
<span class="table-number">Table 12:</span>
<span class="table-number">Table 12</span>:
Table where the hovered-upon row highlights
</div>
@ -525,7 +525,7 @@ _Let's-go-ballistic-with-CSS_ Edition :smile:
<div></div>
<div class="table-caption">
<span class="table-number">Table 13:</span>
<span class="table-number">Table 13</span>:
Table where rows except the hovered-upon get blurred
</div>

Write Preview
Loading…
Cancel
Save