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

Fix source block/table/image reference numbering

Browse Source
master
Kaushal Modi 8 years ago
parent 2e06308200
commit 72f291dafc
5 changed files with 181 additions and 54 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. 15
      ox-hugo.el
  2. 108
      test/site/content-org/all-posts.org
  3. 38
      test/site/content/posts/links-to-images.md
  4. 30
      test/site/content/posts/links-to-source-blocks.md
  5. 44
      test/site/content/posts/links-to-tables.md

15
ox-hugo.el
Unescape View File

@ -25,7 +25,7 @@
;;
;; Commonly used export commands:
;;
;; ** For one-post-per-subtree flow, where a single Org file can have
;; ## For one-post-per-subtree flow, where a single Org file can have
;; multiple Org subtrees which export to individual Hugo posts:
;;
;; - C-c C-e H H -> Export the *current* 'valid Hugo post subtree'
@ -34,7 +34,7 @@
;; - C-c C-e H A -> Export *all* 'valid Hugo post subtrees' to
;; Hugo posts in Markdown.
;;
;; ** For one-post-per-file flow, where a single Org file exports to
;; ## For one-post-per-file flow, where a single Org file exports to
;; only *one* Hugo post:
;;
;; - C-c C-e H h -> Export the Org file to a Hugo post in Markdown.
@ -766,6 +766,12 @@ contents according to the current headline."
toc-items
"\n"))) ;Final newline at the end of TOC
(defalias 'org-hugo--has-caption-p 'org-html--has-caption-p
"Non-nil when ELEMENT has a caption affiliated keyword.
This function is meant to be used as a predicate for
`org-export-get-ordinal'.")
;;; Transcode Functions
@ -1035,11 +1041,14 @@ and rewrite link paths to make blogging more seamless."
(_
(let ((description
(or (org-string-nw-p contents)
(let ((number (org-export-get-ordinal destination info)))
(let ((number (org-export-get-ordinal
destination info
nil #'org-hugo--has-caption-p)))
(cond
((not number) nil)
((atom number) (number-to-string number))
(t (mapconcat #'number-to-string number ".")))))))
;; (message "[ox-hugo-link DBG] link description: %s" description)
(when description
(format "[%s](#%s)"
description

108
test/site/content-org/all-posts.org
Unescape View File

@ -1530,89 +1530,147 @@ refers to, as in the following example
#+END_EXAMPLE
#+END_QUOTE
Also, when targeting a =#+NAME= keyword, *=#+CAPTION= keyword is
mandatory in order to get proper numbering* for _source blocks_,
_images_ and _tables_.
So the below code block:
#+BEGIN_SRC org
,#+CAPTION: Hello
,#+NAME: code__hello
,#+BEGIN_SRC emacs-lisp
(message "Hello")
,#+END_SRC
Here we refer to code snippet [[code__hello]].
,*Here we refer to code snippet [[code__helloagain]].*
,#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
,#+CAPTION: Hello Again
,#+NAME: code__helloagain
,#+BEGIN_SRC emacs-lisp
(message "Hello again")
,#+END_SRC
,*Here we refer to code snippet [[code__hello]].*
#+END_SRC
will output below (/lorem-ipsum/ added to increase page content so
that the link jump is evident):
#+CAPTION: Hello
#+NAME: code__hello
#+BEGIN_SRC emacs-lisp
(message "Hello")
#+END_SRC
/Scroll to the end of the below 'lorem-ipsum' block to find the test
link./
*Here we refer to code snippet [[code__helloagain]].*
#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
#+CAPTION: Hello Again
#+NAME: code__helloagain
#+BEGIN_SRC emacs-lisp
(message "Hello again")
#+END_SRC
*Here we refer to code snippet [[code__hello]].*
*** Links to tables
:PROPERTIES:
:EXPORT_FILE_NAME: links-to-tables
:END:
From [[http://orgmode.org/manual/Images-and-tables.html][(org) Images and tables]],
*Note*: When targeting a =#+NAME= keyword, =#+CAPTION= keyword is
mandatory in order to get proper numbering for images and tables.
*Note*: When targeting a =#+NAME= keyword, *=#+CAPTION= keyword is
mandatory in order to get proper numbering* for _source blocks_,
_images_ and _tables_.
#+BEGIN_SRC org
,#+CAPTION: Simple table
,#+NAME: tab__simple
,#+CAPTION: Simple table 1
,#+NAME: tab__simple1
| a | b |
| c | d |
Here we refer to table [[tab__simple]].
,*Here we refer to table [[tab__simple2]].*
,#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
Here's another table:
,#+CAPTION: Simple table 2
,#+NAME: tab__simple2
| e | f |
| g | h |
,*Here we refer to table [[tab__simple1]].*
#+END_SRC
will output below (/lorem-ipsum/ added to increase page content so
that the link jump is evident):
#+CAPTION: Simple table
#+NAME: tab__simple
#+CAPTION: Simple table 1
#+NAME: tab__simple1
| a | b |
| c | d |
/Scroll to the end of the below 'lorem-ipsum' block to find the test
link./
*Here we refer to table [[tab__simple2]].*
#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
*Here we refer to table [[tab__simple]].*
Here's another table:
#+CAPTION: Simple table 2
#+NAME: tab__simple2
| e | f |
| g | h |
*Here we refer to table [[tab__simple1]].*
-----
Reference: [[http://orgmode.org/manual/Images-and-tables.html][(org) Images and tables]].
*** Links to images
:PROPERTIES:
:EXPORT_FILE_NAME: links-to-images
:END:
From [[http://orgmode.org/manual/Images-and-tables.html][(org) Images and tables]],
*Note*: When targeting a =#+NAME= keyword, =#+CAPTION= keyword is
mandatory in order to get proper numbering for images and images.
*Note*: When targeting a =#+NAME= keyword, *=#+CAPTION= keyword is
mandatory in order to get proper numbering* for _source blocks_,
_images_ and _tables_.
#+BEGIN_SRC org
,#+CAPTION: Org Logo
,#+NAME: img__org_logo
,#+NAME: img__org_logo1
[[/images/org-mode-unicorn-logo.png]]
,*Here we refer to image [[img__org_logo2]].*
,#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
Here's the same image again, but with a different Org link ID:
,#+CAPTION: Same Org Logo
,#+NAME: img__org_logo2
[[/images/org-mode-unicorn-logo.png]]
Here we refer to image [[img__org_logo]].
,*Here we refer to image [[img__org_logo1]].*
#+END_SRC
will output below (/lorem-ipsum/ added to increase page content so
that the link jump is evident):
#+CAPTION: Org Logo
#+NAME: img__org_logo
#+NAME: img__org_logo1
[[/images/org-mode-unicorn-logo.png]]
/Scroll to the end of the below 'lorem-ipsum' block to find the test
link./
*Here we refer to image [[img__org_logo2]].*
#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
*Here we refer to image [[img__org_logo]].*
Here's the same image again, but with a different Org link ID:
#+CAPTION: Same Org Logo
#+NAME: img__org_logo2
[[/images/org-mode-unicorn-logo.png]]
*Here we refer to image [[img__org_logo1]].*
-----
Reference: [[http://orgmode.org/manual/Images-and-tables.html][(org) Images and tables]].
* Equations :equations:
** Inline equations
:PROPERTIES:

38
test/site/content/posts/links-to-images.md
Unescape View File

@ -4,26 +4,35 @@ tags = ["links", "internal-links"]
draft = false
+++
From [(org) Images and tables](http://orgmode.org/manual/Images-and-tables.html),
**Note**: When targeting a `#+NAME` keyword, `#+CAPTION` keyword is
mandatory in order to get proper numbering for images and images.
**Note**: When targeting a `#+NAME` keyword, **`#+CAPTION` keyword is
mandatory in order to get proper numbering** for <span class="underline">source blocks</span>,
<span class="underline">images</span> and <span class="underline">tables</span>.
```org
#+CAPTION: Org Logo
#+NAME: img__org_logo
#+NAME: img__org_logo1
[[/images/org-mode-unicorn-logo.png]]
*Here we refer to image [[img__org_logo2]].*
#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
Here's the same image again, but with a different Org link ID:
#+CAPTION: Same Org Logo
#+NAME: img__org_logo2
[[/images/org-mode-unicorn-logo.png]]
Here we refer to image [[img__org_logo]].
*Here we refer to image [[img__org_logo1]].*
```
will output below (_lorem-ipsum_ added to increase page content so
that the link jump is evident):
<a id="org87e50de"></a>
<a id="org1e79f45"></a>
{{<figure src="/images/org-mode-unicorn-logo.png" caption="Org Logo">}}
_Scroll to the end of the below 'lorem-ipsum' block to find the test
link._
**Here we refer to image [2](#org326a72f).**
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque et
quam metus. Etiam in iaculis mi, sit amet pretium magna. Donec ut dui
@ -77,4 +86,13 @@ suscipit nec nec neque. Suspendisse vitae tincidunt justo, sed
molestie velit. Nullam pellentesque convallis ante, vel posuere libero
blandit in.
**Here we refer to image [4](#org87e50de).**
Here's the same image again, but with a different Org link ID:
<a id="org326a72f"></a>
{{<figure src="/images/org-mode-unicorn-logo.png" caption="Same Org Logo">}}
**Here we refer to image [1](#org1e79f45).**
---
Reference: [(org) Images and tables](http://orgmode.org/manual/Images-and-tables.html).

30
test/site/content/posts/links-to-source-blocks.md
Unescape View File

@ -18,26 +18,41 @@ From [(org) Internal links](http://orgmode.org/manual/Internal-links.html),
> | of | four cells |
> ```
Also, when targeting a `#+NAME` keyword, **`#+CAPTION` keyword is
mandatory in order to get proper numbering** for <span class="underline">source blocks</span>,
<span class="underline">images</span> and <span class="underline">tables</span>.
So the below code block:
````org
#+CAPTION: Hello
#+NAME: code__hello
#+BEGIN_SRC emacs-lisp
(message "Hello")
#+END_SRC
Here we refer to code snippet [[code__hello]].
*Here we refer to code snippet [[code__helloagain]].*
#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
#+CAPTION: Hello Again
#+NAME: code__helloagain
#+BEGIN_SRC emacs-lisp
(message "Hello again")
#+END_SRC
*Here we refer to code snippet [[code__hello]].*
````
will output below (_lorem-ipsum_ added to increase page content so
that the link jump is evident):
<a id="org91a03d3"></a>
<a id="orgb893397"></a>
````emacs-lisp
(message "Hello")
````
_Scroll to the end of the below 'lorem-ipsum' block to find the test
link._
**Here we refer to code snippet [2](#orgd60f488).**
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque et
quam metus. Etiam in iaculis mi, sit amet pretium magna. Donec ut dui
@ -91,4 +106,9 @@ suscipit nec nec neque. Suspendisse vitae tincidunt justo, sed
molestie velit. Nullam pellentesque convallis ante, vel posuere libero
blandit in.
**Here we refer to code snippet [2](#org91a03d3).**
<a id="orgd60f488"></a>
````emacs-lisp
(message "Hello again")
````
**Here we refer to code snippet [1](#orgb893397).**

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

@ -4,30 +4,40 @@ tags = ["links", "internal-links"]
draft = false
+++
From [(org) Images and tables](http://orgmode.org/manual/Images-and-tables.html),
**Note**: When targeting a `#+NAME` keyword, `#+CAPTION` keyword is
mandatory in order to get proper numbering for images and tables.
**Note**: When targeting a `#+NAME` keyword, **`#+CAPTION` keyword is
mandatory in order to get proper numbering** for <span class="underline">source blocks</span>,
<span class="underline">images</span> and <span class="underline">tables</span>.
```org
#+CAPTION: Simple table
#+NAME: tab__simple
#+CAPTION: Simple table 1
#+NAME: tab__simple1
| a | b |
| c | d |
Here we refer to table [[tab__simple]].
*Here we refer to table [[tab__simple2]].*
#+INCLUDE: "./all-posts.org::#lorem-ipsum" :only-contents t
Here's another table:
#+CAPTION: Simple table 2
#+NAME: tab__simple2
| e | f |
| g | h |
*Here we refer to table [[tab__simple1]].*
```
will output below (_lorem-ipsum_ added to increase page content so
that the link jump is evident):
<a id="org53dbdfb"></a>
<a id="org40b5987"></a>
| a | b |
|---|---|
| c | d |
_Scroll to the end of the below 'lorem-ipsum' block to find the test
link._
**Here we refer to table [2](#org8a6806a).**
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque et
quam metus. Etiam in iaculis mi, sit amet pretium magna. Donec ut dui
@ -81,4 +91,16 @@ suscipit nec nec neque. Suspendisse vitae tincidunt justo, sed
molestie velit. Nullam pellentesque convallis ante, vel posuere libero
blandit in.
**Here we refer to table [1](#org53dbdfb).**
Here's another table:
<a id="org8a6806a"></a>
| e | f |
|---|---|
| g | h |
**Here we refer to table [1](#org40b5987).**
---
Reference: [(org) Images and tables](http://orgmode.org/manual/Images-and-tables.html).

Write Preview
Loading…
Cancel
Save