This commit shouldn't change any functionality in
org-hugo--quote-string.. at least for the use-cases that I can think
of. So the tests at least still pass.
If you ended up reading this commit message trying to figure out an
issue with front-matter quoting, open an issue!
This commit reorganizes the former internal function
org-hugo--transform-org-tags into smaller functions and a new
defcustom org-hugo-tag-processing-functions. See its doc-string for
details.
This change is only internal, and the tag processing logic is exact
same as before (If this commit broke something for you, file a bug
report!).
This defcustom now allows users to add their own processing to the
tags e.g. prevent certain tag names (not the posts tagged with those!)
from getting exported, as requested in
https://github.com/kaushalmodi/ox-hugo/issues/142.
This commit now allows doing that using a small snippet like below:
(defun org-hugo--tag-processing-fn-remove-tags-maybe (tags-list info)
"Remove user-specified tags/categories.
See `org-hugo-tag-processing-functions' for more info."
;; Use tag/category string (including @ prefix) exactly as used in Org file.
(let ((tags-categories-to-be-removed '("DONE"))) ;"my_tag" "@my_cat"
(cl-remove-if (lambda (tag_or_cat)
(member tag_or_cat tags-categories-to-be-removed))
tags-list)))
(add-to-list 'org-hugo-tag-processing-functions
#'org-hugo--tag-processing-fn-remove-tags-maybe)
Fixes https://github.com/kaushalmodi/ox-hugo/issues/141
Regular page weight setting is same as before:
Manual:
#+hugo_weight: 100
Auto:
#+hugo_weight: auto
Taxonomy weight setting:
Manual:
#+hugo_weight: :tags 100 :categories 100 :series 100
Auto:
#+hugo_weight: :tags auto :categories auto :series auto
Regular page weight and Taxonomy weights together:
#+hugo_weight: 50 :tags 100 :categories 100 :series 100
or if *not* specifying the page weight in the very beginning, use the
:page keyword:
#+hugo_weight: :tags 100 :categories 100 :page 50 :series 100
https://github.com/kaushalmodi/ox-hugo/issues/139
Remove the requirement to suffix such keys with "{}". This is an
improvement over the previous commit
d0a60c5104.
---
The syntax for specifying nested map values custom front-matter is:
Using property drawer (in subtrees):
:EXPORT_HUGO_CUSTOM_FRONT_MATTER: :PARENT_KEY '((KEY1 . VAL1) (KEY2 . VAL2) (KEY3 . VAL3) ..)
Using keyword:
#+hugo_custom_front_matter: :PARENT_KEY '((KEY1 . VAL1) (KEY2 . VAL2) (KEY3 . VAL3) ..)
Note that the elements in the list *have to be* dotted-pairs
like (KEY1 . VAL1). That is what tells ox-hugo that this is a nested
map.
Only 1 level of nested keys is supported.
The syntax for specifying nested map values custom front-matter is:
Using property drawer (in subtrees):
:EXPORT_HUGO_CUSTOM_FRONT_MATTER: :PARENT_KEY{} '((KEY1 . VAL1) (KEY2 . VAL2) (KEY3 . VAL3) ..)
Using keyword:
#+hugo_custom_front_matter: :PARENT_KEY{} '((KEY1 . VAL1) (KEY2 . VAL2) (KEY3 . VAL3) ..)
The "{}" at the end of the key name is what tells ox-hugo that this is
a nested map.
Only 1 level of nested keys is supported.
Fixes https://github.com/kaushalmodi/ox-hugo/issues/139.
This fixes the earlier generated invalid HTML.
---
Details:
Earlier, a figure with #+name:
#+name: fig__unicorn
[[/images/org-mode-unicorn-logo.png][file:/images/org-mode-unicorn-logo.png]]
would export as:
<a id="org55ede7e"></a>
{{< figure src="/images/org-mode-unicorn-logo.png" link="/images/org-mode-unicorn-logo.png" >}}
In HTML, that would look like:
<p><a id="org55ede7e"></a>
<figure>
<a href="http://localhost:5555/images/org-mode-unicorn-logo.png">
<img src="http://localhost:5555/images/org-mode-unicorn-logo.png" />
</a>
</figure>
</p>
This resulted in invalid HTML as per the HTML5 validator.. because
figure is a block level element, and it cannot be put inside the p
tag.
The fix was to insert a blank line after the a tag so that it would be
in its own <p> element, and the following figure element would live
outside that.
With the fix in this commit,
#+name: fig__unicorn
[[/images/org-mode-unicorn-logo.png][file:/images/org-mode-unicorn-logo.png]]
now exports as:
<a id="org55ede7e"></a>
{{< figure src="/images/org-mode-unicorn-logo.png" link="/images/org-mode-unicorn-logo.png" >}}
In HTML, that now looks like:
<p><a id="org55ede7e"></a></p>
<figure>
<a href="http://localhost:5555/images/org-mode-unicorn-logo.png">
<img src="http://localhost:5555/images/org-mode-unicorn-logo.png" />
</a>
</figure>
.. which now is valid HTML.
If an attachment path contains "/static/", that attachment is copied
to the site's static/ dir *even in page bundles*.
This allows one to have links to files in the static/ dir as well as
within the bundle dir, in the case of page bundles.
If an attachment path is:
/foo/<BUNDLE_NAME>/bar/baz.png
That attachment is copied to:
<HUGO_BASE_DIR>/content/<SECTION>/<BUNDLE_NAME>/bar/baz.png
i.e. the attachment path *after* "/<BUNDLE_NAME>/" is retained.
Use plist-put and plist-get instead of passing the description value
via a global variable.
To my surprise, the plist-put and plist-get works across functions!
This works **only for links TO per-file export flow Org files**.
- The linked files must not have a custom `#+export_file_name` set.
- The linked files should not be page bundles.
This commit implemented very basic cross-linking support as per the
spec in https://github.com/kaushalmodi/ox-hugo/issues/131. So the page
bundle names, section names, export file names, etc set within the Org
file are not resolved.
Add new attribute #+ATTR_SHORTCODE: to specify positional arguments
for the shortcode following ":args".
Example:
#+attr_shortcode: warning
#+begin_alert
This is a warning!
#+end_alert
Above exports as (given HUGO_PAIRED_SHORTCODES is set as "%alert"):
{{% alert warning %}}
This is a warning!
{{% /alert %}}
https://github.com/kaushalmodi/ox-hugo/issues/119
---
This commit is a refinement over
74cb3c2ec8:
- It gets rid of the requirement to use ":args" for positional
arguments.
- Removes unnecessary duplicate syntax (use of :class with
attr_html). If someone wants to have the Org document compatible
with more exporters they should simply *not* use
HUGO_PAIRED_SHORTCODE, and instead rely on the default Special
Blocks behavior (wrapping the text with div or HTML5 tags).
Add new attribute #+ATTR_SHORTCODE: to specify positional arguments
for the shortcode following ":args".
Example:
#+attr_shortcode: :args warning
#+begin_alert
This is a warning!
#+end_alert
Above exports as (given HUGO_PAIRED_SHORTCODES is set as "%alert"):
{{% alert warning %}}
This is a warning!
{{% /alert %}}
For re-usability of Org document with ox-html, below will also result
in the exact same ox-hugo export:
#+attr_html: :class warning
#+begin_alert
This is a warning!
#+end_alert
Simply: #+attr_shortcode -> #+attr_html
:args -> :class
https://github.com/kaushalmodi/ox-hugo/issues/119
Also, now the target and rel attr are once again passed on to the
figure shortcode (a better solution to straightaway discarding those
as done in
e92fcf0037).
Those attributes will still be ineffective as the internal figure
shortcode does not recognize those. But this can be fixed if Hugo adds
the support for those, or if a user simply overrides the internal
shortcode with their custom figure shortcode with that support added.
- [X] Inlined non-hyperlinked images, no meta or only alt -- Use Markdown image syntax
- [X] Inlined hyperlinked images, no meta or only alt -- Use Markdown image syntax
- [X] Inlined non-hyperlinked images, meta other than alt -- Use HTML img
- [X] Inlined hyperlinked images, meta other than alt -- Use HTML img
https://github.com/kaushalmodi/ox-hugo/issues/125
It's conventional to write a shortcode with a space after the starting
"{{<" (or "{{%") characters and a space before the ending pairs.
So do:
{{< SHORTCODE >}}
Not:
{{<SHORTCODE>}}
This commit makes that space insertion consistent for the exported
figure and highlight shortcodes.
The Markdown form [{{< figure .. >}}](some link) results in wrapping
the <figure> in <a> in the final HTML, which is invalid.
- [X] Non-inlined hyperlinked images -- Use link in figure
https://github.com/kaushalmodi/ox-hugo/issues/125
One minor behavior change: Now <a> tag attributes like "target" and
"rel" cannot be applied *only to* the links that images hyperlink
to. The reason is to make the exported Markdown generate valid HTML,
and with how the "figure" shortcode is designed in HTML, those
parameters are not passed onto the <a> element in the generated
<figure> element.
Now if the attachments are in the same dir as the content Org file,
the full directory hierarchy for those attachments is preserved when
copied to the bundle dir in content/, even if the path does not
contain "static/".
Example:
Original path:
<ORG_FILE_DIR>/foo/bar/baz.png
Copied-to path:
<HUGO_BASE_DIR>/content/<SECTION>/<BUNDLE>/foo/bar/baz.png
Fixes https://github.com/kaushalmodi/ox-hugo/issues/124
Remove the logic clutter that tried to preserve "file:" before
links.. "file:" does not make sense for web pages (may be need to
revisit this in future, but for now all existing tests pass).
- Add tests for images linked to images when the linked image needs to
be copied to static.
- Another test similar to above but when the page is a bundle and the
linked image needs to be copied to the bundle dir.
- Also update test site theme
Kaushal Modi
