Bump to version 0.2.1; update Changelog and Docs

kaushalmodi · Sep 28, 2017 · a0a1bb9 · a0a1bb9
1 parent 5e1fac9
commit a0a1bb9
Show file tree

Hide file tree

Showing 9 changed files with 115 additions and 56 deletions.
diff --git a/README.org b/README.org
@@ -19,6 +19,7 @@ many other tweaks. =ox-hugo= backend extends from this.
 - [[#usage][Usage]]
   - [[#before-you-export][Before you export]]
   - [[#export-bindings][Export bindings]]
+- [[#changelog][Changelog]]
 - [[#thanks][Thanks]]
 
 * Screenshots
@@ -122,6 +123,46 @@ The common =ox-hugo= export bindings are:
 |---------------+-------------------------------------------------------------------------------------|
 | =C-c C-e H h= | Export the whole Org file to a single post                                          |
 |---------------+-------------------------------------------------------------------------------------|
+* Changelog
+** 0.2.1 <2017-09-28 Thu>
+*** Fixes
+- Single column tables now export correctly [[[https://github.com/kaushalmodi/ox-hugo/issues/84][84]]].
+- Ignore =HUGO_WEIGHT= set to =auto= for /per-file/ exports
+  [[[https://github.com/kaushalmodi/ox-hugo/issues/83][83]]].
+** 0.2 <2017-09-27 Wed>
+*** Features
+- Add support for all Hugo =figure= shortcode parameters
+  [[[https://github.com/kaushalmodi/ox-hugo/issues/79][79]]].
+- New option =org-hugo-delete-trailing-ws= defaults to =t=; now Hugo
+  deletes trailing white-spaces by default.
+- New options =org-hugo-default-static-subdirectory-for-externals= and
+  =org-hugo-external-file-extensions-allowed-for-copying= (related to
+  [[[https://github.com/kaushalmodi/ox-hugo/issues/69][69]]]).
+*** Fixes
+- Remove =HUGO_STATIC_IMAGE= option; fix attachment re-write
+  [[[https://github.com/kaushalmodi/ox-hugo/issues/69][69]]].
+- Fix incorrectly inserted hard line-breaks [[[https://github.com/kaushalmodi/ox-hugo/issues/72][72]]]. Added a
+  new option =HUGO_PRESERVE_FILLING=.
+- Fix error happening when a post title was set to an empty string
+  [[[https://github.com/kaushalmodi/ox-hugo/commit/ba9e8365f6ee42f030ed806bf5ec42d6acce4c76][ba9e8365]]].
+*** Backward-incompatible changes
+- Switch the default value of =org-hugo-use-code-for-kbd= option to
+  =nil= [[[https://github.com/kaushalmodi/ox-hugo/commit/88ba15ae9bc809b0983315446c88fecfda3534e5][88ba15ae]]].
+** 0.1.3 <2017-09-13 Wed>
+- Now a HUGO key value set to ="nil"=, like =#+HUGO_CODE_FENCE: nil=,
+  will evaluate as /nil/ instead of /t/, as now
+  =org-hugo--plist-get-true-p= is used to parse boolean keys instead
+  of =plist-get=.
+** 0.1.2 <2017-09-12 Tue>
+- Make DateTime matching better; new internal variable
+  =org-hugo--date-time-regexp=. Earlier time zones ahead of UTC (with
+  =+= sign) were not detected as dates in =org-hugo--quote-string= and
+  thus were unnecessarily quoted.
+** 0.1.1 <2017-09-11 Mon>
+- Use CLOSED log drawer info if available to set the date in
+  front-matter [[[https://github.com/kaushalmodi/ox-hugo/issues/68][68]]].
+- Code optimization: Use of =org-entry-get= at places instead of
+  maintaining global variables.
 * Thanks
 - Matt Price ([[https://github.com/titaniumbones][@titaniumbones]])
 - Puneeth Chaganti ([[https://github.com/punchagan][@punchagan]])

diff --git a/doc/content/_index.md b/doc/content/_index.md
@@ -130,11 +130,11 @@ Before you export check that these properties are set as you need:
 
 The common `ox-hugo` export bindings are:
 
-Binding       | Description
---------------|--------------------------------------------------------------------------------------
-`C-c C-e H H` | Export only the current _valid_ subtree (has the `EXPORT_FILE_NAME` property set)
-`C-c C-e H A` | Export **all** _valid_ subtrees (those that have the `EXPORT_FILE_NAME` property set)
-`C-c C-e H h` | Export the whole Org file to a single post
+| Binding       | Description                                                                           |
+|---------------|---------------------------------------------------------------------------------------|
+| `C-c C-e H H` | Export only the current _valid_ subtree (has the `EXPORT_FILE_NAME` property set)     |
+| `C-c C-e H A` | Export **all** _valid_ subtrees (those that have the `EXPORT_FILE_NAME` property set) |
+| `C-c C-e H h` | Export the whole Org file to a single post                                            |
 
 
 ## Thanks {#thanks}

diff --git a/doc/content/doc/changelog.md b/doc/content/doc/changelog.md
@@ -6,6 +6,16 @@ draft = false
   identifier = "changelog"
 +++
 
+## 0.2.1 <span class="timestamp-wrapper"><span class="timestamp">&lt;2017-09-28 Thu&gt;</span></span> {#0-dot-2-dot-1-span-class-timestamp-wrapper-span-class-timestamp-and-lt-2017-09-28-thu-and-gt-span-span}
+
+
+### Fixes {#fixes}
+
+-   Single column tables now export correctly [[84](https://github.com/kaushalmodi/ox-hugo/issues/84)].
+-   Ignore `HUGO_WEIGHT` set to `auto` for _per-file_ exports
+    [[83](https://github.com/kaushalmodi/ox-hugo/issues/83)].
+
+
 ## 0.2 <span class="timestamp-wrapper"><span class="timestamp">&lt;2017-09-27 Wed&gt;</span></span> {#0-dot-2-span-class-timestamp-wrapper-span-class-timestamp-and-lt-2017-09-27-wed-and-gt-span-span}
 
 

diff --git a/doc/content/doc/formatting.md b/doc/content/doc/formatting.md
@@ -12,16 +12,16 @@ the exported `.md` files.
 See the Org source in [`all-posts.org`](https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content-org/all-posts.org) under _Formatting_ -> _General_
 heading and how it exports to Markdown in [`general-formatting.md`](https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content/posts/general-formatting.md).
 
-Org                | Markdown
--------------------|---------------------------------------------------------------------
-`*bold*`           | `**bold**`
-`/italics/`        | `_italics_`
-`=monospace=`      | `` `monospace` ``
-`~key-binding~`    | `` `key-binding` ``
-                   | - if `org-hugo-use-code-for-kbd` is nil [default]
-`~key-binding~`    | `<kbd>key-binding</kbd>`
-                   | - if `org-hugo-use-code-for-kbd` is non-nil
-                   | - Requires **CSS** to render the `<kbd>` tag as something special.
-`+strike-through+` | `~~strike-through~~`
-`_underline_`      | `<span class = "underline">underline</span>`
-                   | - Requires **CSS** to render this `underline` class as an underline.
+| Org                | Markdown                                                             |
+|--------------------|----------------------------------------------------------------------|
+| `*bold*`           | `**bold**`                                                           |
+| `/italics/`        | `_italics_`                                                          |
+| `=monospace=`      | `` `monospace` ``                                                    |
+| `~key-binding~`    | `` `key-binding` ``                                                  |
+|                    | - if `org-hugo-use-code-for-kbd` is nil [default]                    |
+| `~key-binding~`    | `<kbd>key-binding</kbd>`                                             |
+|                    | - if `org-hugo-use-code-for-kbd` is non-nil                          |
+|                    | - Requires **CSS** to render the `<kbd>` tag as something special.   |
+| `+strike-through+` | `~~strike-through~~`                                                 |
+| `_underline_`      | `<span class = "underline">underline</span>`                         |
+|                    | - Requires **CSS** to render this `underline` class as an underline. |
diff --git a/doc/content/doc/image-links.md b/doc/content/doc/image-links.md
@@ -76,12 +76,12 @@ created inside the /static_ directory to preserve the structure./
 Example translations between outside `static` directory paths to the
 copied location inside `static`:
 
-File location outside `static`   | Copied-to location inside `static`        | Explanation
----------------------------------|-------------------------------------------|-----------------------------------------------------------------------------------------------------------
-`~/temp/static/images/foo.png`   | `<HUGO_BASE_DIR>/static/images/foo.png`   | If the **outside** path has `/static/` in it, the directory structure after that is preserved when copied.
-`~/temp/static/img/foo.png`      | `<HUGO_BASE_DIR>/static/img/foo.png`      | (same as above)
-`~/temp/static/foo.png`          | `<HUGO_BASE_DIR>/static/foo.png`          | (same as above)
-`~/temp/static/articles/zoo.pdf` | `<HUGO_BASE_DIR>/static/articles/zoo.pdf` | (same as above)
+| File location outside `static`   | Copied-to location inside `static`        | Explanation                                                                                                |
+|----------------------------------|-------------------------------------------|------------------------------------------------------------------------------------------------------------|
+| `~/temp/static/images/foo.png`   | `<HUGO_BASE_DIR>/static/images/foo.png`   | If the **outside** path has `/static/` in it, the directory structure after that is preserved when copied. |
+| `~/temp/static/img/foo.png`      | `<HUGO_BASE_DIR>/static/img/foo.png`      | (same as above)                                                                                            |
+| `~/temp/static/foo.png`          | `<HUGO_BASE_DIR>/static/foo.png`          | (same as above)                                                                                            |
+| `~/temp/static/articles/zoo.pdf` | `<HUGO_BASE_DIR>/static/articles/zoo.pdf` | (same as above)                                                                                            |
 
 See the [Usage → Before you export](/doc/usage#before-you-export) section to learn how to set the
 **HUGO\_BASE\_DIR**.
@@ -100,9 +100,9 @@ In that case, that file is copied to the
 `org-hugo-default-static-subdirectory-for-externals` sub-directory
 (`ox-hugo/` by default) within the Hugo static directory.
 
-Outside `static`         | Copied-to location inside `static`       | Explanation
--------------------------|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------
-`~/temp/bar/baz/foo.png` | `<HUGO_BASE_DIR>/static/ox-hugo/foo.png` | Here, as the **outside** path does not have `/static/` in it, the file is copied to the `ox-hugo/` dir in Hugo `static/` dir.
+| Outside `static`         | Copied-to location inside `static`       | Explanation                                                                                                                   |
+|--------------------------|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
+| `~/temp/bar/baz/foo.png` | `<HUGO_BASE_DIR>/static/ox-hugo/foo.png` | Here, as the **outside** path does not have `/static/` in it, the file is copied to the `ox-hugo/` dir in Hugo `static/` dir. |
 
 -   **Note:** This auto-copying behavior can be disabled by setting
     `org-hugo-external-file-extensions-allowed-for-copying` to

diff --git a/doc/content/doc/org-meta-data-to-hugo-front-matter.md b/doc/content/doc/org-meta-data-to-hugo-front-matter.md
@@ -16,19 +16,19 @@ Below, where _subtree_ is mentioned, it implies a **valid Hugo-post
 subtree** i.e. an Org subtree that has the `EXPORT_FILE_NAME` property
 set.
 
-Hugo front-matter (TOML)           | Org                                | Org description
------------------------------------|------------------------------------|--------------------------------------------------------------------------
-`title = "foo"`                    | `* foo`                            | Subtree heading
-`date = 2017-09-11T14:32:00-04:00` | `CLOSED: [2017-09-11 Mon 14:32]`   | Auto-inserted `CLOSED` subtree property when switch to Org **DONE** state
-`date = 2017-07-24`                | `:EXPORT_DATE: 2017-07-24`         | Subtree property
-`lastmod = <current date>`         | `:EXPORT_HUGO_AUTO_SET_LASTMOD: t` | Subtree property
-`lastmod = <current date>`         | `#+HUGO_AUTO_SET_LASTMOD: t`       | Org keyword
-`tags = ["abc", "def"]`            | `* foo :abc:def:`                  | Subtree heading tags
-`categories = ["x", "y"]`          | `* foo :@x:@y:`                    | Subtree heading tags with `@` prefix
-`draft = true`                     | `* TODO foo`                       | Subtree heading Org Todo state set to `TODO` (or `DRAFT`)
-`draft = false`                    | `* foo`                            | Subtree heading Org Todo state **not** set to `TODO` (or `DRAFT`)
-`weight = 123`                     | `:EXPORT_HUGO_WEIGHT: auto`        | When set to `auto`, weight is auto-calculated
-`weight = 123` (in `[menu.foo]`)   | `:EXPORT_HUGO_MENU: :menu foo`     | Menu weight is auto-calculated unless specified
+| Hugo front-matter (TOML)           | Org                                | Org description                                                           |
+|------------------------------------|------------------------------------|---------------------------------------------------------------------------|
+| `title = "foo"`                    | `* foo`                            | Subtree heading                                                           |
+| `date = 2017-09-11T14:32:00-04:00` | `CLOSED: [2017-09-11 Mon 14:32]`   | Auto-inserted `CLOSED` subtree property when switch to Org **DONE** state |
+| `date = 2017-07-24`                | `:EXPORT_DATE: 2017-07-24`         | Subtree property                                                          |
+| `lastmod = <current date>`         | `:EXPORT_HUGO_AUTO_SET_LASTMOD: t` | Subtree property                                                          |
+| `lastmod = <current date>`         | `#+HUGO_AUTO_SET_LASTMOD: t`       | Org keyword                                                               |
+| `tags = ["abc", "def"]`            | `* foo :abc:def:`                  | Subtree heading tags                                                      |
+| `categories = ["x", "y"]`          | `* foo :@x:@y:`                    | Subtree heading tags with `@` prefix                                      |
+| `draft = true`                     | `* TODO foo`                       | Subtree heading Org Todo state set to `TODO` (or `DRAFT`)                 |
+| `draft = false`                    | `* foo`                            | Subtree heading Org Todo state **not** set to `TODO` (or `DRAFT`)         |
+| `weight = 123`                     | `:EXPORT_HUGO_WEIGHT: auto`        | When set to `auto`, weight is auto-calculated                             |
+| `weight = 123` (in `[menu.foo]`)   | `:EXPORT_HUGO_MENU: :menu foo`     | Menu weight is auto-calculated unless specified                           |
 
 
 ### Notes {#notes}
@@ -39,17 +39,17 @@ Hugo front-matter (TOML)           | Org                                | Org de
 
 ## For complete-file exports (`C-c C-e H h`) {#for-complete-file-exports--c-c-c-e-h-h}
 
-Hugo front-matter (TOML)         | Org
----------------------------------|-------------------------------------
-`title = "foo"`                  | `#+TITLE: foo`
-`date = 2017-07-24`              | `#+DATE: 2017-07-24`
-`lastmod = <current date>`       | `#+HUGO_AUTO_SET_LASTMOD: t`
-`tags = ["abc", "def"]`          | `#+HUGO_TAGS: abc def`
-`categories = ["x", "y"]`        | `#+HUGO_CATEGORIES: x y`
-`draft = true`                   | `#+HUGO_DRAFT: true`
-`draft = false`                  | `#+HUGO_DRAFT: false` (default)
-`weight = 123`                   | `#+HUGO_WEIGHT: 123`
-`weight = 123` (in `[menu.foo]`) | `#+HUGO_MENU: :menu foo :weight 123`
+| Hugo front-matter (TOML)         | Org                                  |
+|----------------------------------|--------------------------------------|
+| `title = "foo"`                  | `#+TITLE: foo`                       |
+| `date = 2017-07-24`              | `#+DATE: 2017-07-24`                 |
+| `lastmod = <current date>`       | `#+HUGO_AUTO_SET_LASTMOD: t`         |
+| `tags = ["abc", "def"]`          | `#+HUGO_TAGS: abc def`               |
+| `categories = ["x", "y"]`        | `#+HUGO_CATEGORIES: x y`             |
+| `draft = true`                   | `#+HUGO_DRAFT: true`                 |
+| `draft = false`                  | `#+HUGO_DRAFT: false` (default)      |
+| `weight = 123`                   | `#+HUGO_WEIGHT: 123`                 |
+| `weight = 123` (in `[menu.foo]`) | `#+HUGO_MENU: :menu foo :weight 123` |
 
 
 ### Notes {#notes}

diff --git a/doc/content/doc/usage.md b/doc/content/doc/usage.md
@@ -56,8 +56,8 @@ Before you export check that these properties are set as you need:
 
 The common `ox-hugo` export bindings are:
 
-Binding       | Description
---------------|--------------------------------------------------------------------------------------
-`C-c C-e H H` | Export only the current _valid_ subtree (has the `EXPORT_FILE_NAME` property set)
-`C-c C-e H A` | Export **all** _valid_ subtrees (those that have the `EXPORT_FILE_NAME` property set)
-`C-c C-e H h` | Export the whole Org file to a single post
+| Binding       | Description                                                                           |
+|---------------|---------------------------------------------------------------------------------------|
+| `C-c C-e H H` | Export only the current _valid_ subtree (has the `EXPORT_FILE_NAME` property set)     |
+| `C-c C-e H A` | Export **all** _valid_ subtrees (those that have the `EXPORT_FILE_NAME` property set) |
+| `C-c C-e H h` | Export the whole Org file to a single post                                            |
diff --git a/doc/github-files.org b/doc/github-files.org
@@ -1,6 +1,7 @@
 #+TITLE: GitHub Ancillary Files
 #+AUTHOR: Kaushal Modi
 
+#+MACRO: issue [[[https://github.com/kaushalmodi/ox-hugo/issues/$1][$1]]]
 #+MACRO: imageclick [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/doc/static/images/$1][https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/doc/static/images/$1]]
 #+MACRO: travis [[https://travis-ci.org/kaushalmodi/ox-hugo][https://travis-ci.org/kaushalmodi/ox-hugo.svg?branch=master]]
 #+MACRO: melpa [[https://melpa.org/#/ox-hugo][file:https://melpa.org/packages/ox-hugo-badge.svg]]
@@ -42,6 +43,8 @@ https://ox-hugo.netlify.com/
 #+INCLUDE: "./ox-hugo-manual.org::#installation" :only-contents t
 ** Usage
 #+INCLUDE: "./ox-hugo-manual.org::#usage" :only-contents t
+** Changelog                                                     :noexport_1:
+#+INCLUDE: "./ox-hugo-manual.org::#changelog" :only-contents t
 ** Thanks
 #+INCLUDE: "./ox-hugo-manual.org::#thanks" :only-contents t
 * Contributing                                                 :contributing:

diff --git a/doc/ox-hugo-manual.org b/doc/ox-hugo-manual.org
@@ -11,6 +11,11 @@
 :PROPERTIES:
 :CUSTOM_ID: changelog
 :END:
+** 0.2.1 <2017-09-28 Thu>
+*** Fixes
+- Single column tables now export correctly {{{issue(84)}}}.
+- Ignore =HUGO_WEIGHT= set to =auto= for /per-file/ exports
+  {{{issue(83)}}}.
 ** 0.2 <2017-09-27 Wed>
 *** Features
 - Add support for all Hugo =figure= shortcode parameters