Version v1.13.0 Release Note

Bissetii version v1.13.0 has a number of changes worth mentioning in its (this) release note. There are notable changes, migrations notes, deprecation notes and etc. It's good to read it through before use.

What’s New

Here are some of the key changes happening in this release.

Backward Compatible Changes

Here are some of seamless upgardes:

  1. Updated logo and thumbnails to Bissetii 13.
  2. Added nav-toc Component in Issue 106.
  3. Added 480x480 png default thumbnails for social messaging.
  4. Added nav-catalog Component in Issue 109.
  5. Added translate Shortcode in Issue 113

Non-Backward Compatible Changes

Here are some of the breaking changes:

  1. Removed redundant redirect.md default archetype.
  2. Refactored link shortcode to be RFC3986 compliant in Issue 110.
  3. Removed 5th Parameter (URL) for SVG/ShieldTag Shortcode.

Deprecation Notice

Here are the list of deprecation notices. Please migrate before its deadline!

  1. Support for form shortcode AMP form extension modules in page front-matter version v1.12.5 and below will be rescinded starting from June 30, 2021. More info at Issue 105.
  2. Support for SVG/ShieldTag shortcode 5th parameter (URL) will be rescinded starting from June 30, 2021. More info at: Issue 112.

Important Migrations Notice

Here are some important notices for moving up to this version from its immediate past version:

Form’s Page Front-Matter Extended Module Migration

Version v1.13.0 now uses the modules.extensions convention to unify all common components together. Previously, it was specific to AMP modules. Hence, you need to manually update ALL page front-matter that are using AMP form module into the latest version. Example, from this:

1
2
3
4
5
6
7
8
9
...

[amp]
modules = [
	# Example: "amp-sidebar",
	"amp-form",
]

...

to this:

1
2
3
4
5
6
7
8
9
...

[modules]
extensions = [
	# Example: "sidebar",
	"form",
]

...

By this version, the link shortcode is refactored to comply with RFC3986 URL grammar definition. This does not introduce any new parameters and neither altering their respective positions. However, all input data do change.

The highly notable changes would be the following:

# Get static files from base URL with 'this' language prefix
# CHANGES = now refers to current URL instead of base URL
{{< link "/img/file.png" "this" "url-only" />}}
		โฅฅ (BEFORE)
http://localhost:8080/img/file.png
		โฅฅ (AFTER)
http://localhost:8080/en/img/file.png


# Get static files from base URL without language prefix
{{< link "/img/file.png" "" "url-only" />}}
		โฅฅ (BEFORE)
http://localhost:8080/img/file.png
		โฅฅ (AFTER)
http://localhost:8080/img/file.png


# Relative URL against current language Prefix
# CHANGES: now relative to current URL directory
{{< link "img/file.png" "this" "url-only" />}}
		โฅฅ (BEFORE)
http://localhost:8080/en/img/file.png
		โฅฅ (AFTER)
http://localhost:8080/en/current/path/img/file.png



# Relative URL against current language Prefix
# CHANGES: now relative to current URL directory
{{< link "img/file.png" "" "url-only" />}}
		โฅฅ
http://localhost:8080/en/img/file.png
		โฅฅ
http://localhost:8080/en/current/path/img/file.png

Things that are known affected by this change:

  1. Relative URL in RedirectURL page front matter - now relative to base URL capable to redirect towards static files. If you are using other languages or redirect towards the same language, you need to include language prefix manually.
  2. link partial shortcode now offers GivenLang parameter to specify the language prefix. If empty, the relative URL will be relative to base URL.
  3. Any link shortcode being used with "this" language prefix to generate URL for static files (e.g. image). You need to remove the "this" prefix now.
  4. card, iframe, and others shortcode TOML data file containing relative links. If you rely on relative URL to construct a link relative to current URL, you need to append the language prefix now.

Things that are known not affected by this change:

  1. Default menu links (language prefix was prepended).
  2. Page alternate formats links (used in meta).
  3. Page canonicalization (used in meta).
  4. Page thumbnails (used in meta).
  5. CSS links (used in <head>).
  6. Javascript links (used in <head>).
  7. Resources icon links.

Shortcode Inner Content

Version v1.13.0 implemented the shortcode’s inner content to correct its existing "close" implementation. This affects ALL link shortcodes as it would requires one to change the existing non-inner shortcode type to inner type. Here are some samples:

# URL-ONLY Deployment
# CHANGES = add closing slash '/' at the end of the shortcode
{{< link "/img/file.png" "this" "url-only" >}}
		โฅฅ (UNCHANGED)
Error is raised for correction.
		โฅฅ (AFTER CHANGES)
{{< link "/img/file.png" "this" "url-only" />}}


# Link Construction
# CHANGES = use shortcode close tag over the older `"close"` parameter
{{< link "/img/file.png" "this" "url-only" >}}
	... link content here ...
{{< link "close" >}}
		โฅฅ (AFTER CHANGES)
{{< link "/img/file.png" "this" "url-only" >}}
	... link content here ...
{{< /link >}}


# Close Tag
{{< link "close" >}}
		โฅฅ (UNCHANGED)
Removed. Error is raised for correction.
		โฅฅ (AFTER CHANGES)
{{< /link >}}

Deep in Our Heart

On behalf of the team, we apologise to introduce such non-compatible changes in a drastic measures instead of scheduling a deprecation planning. This is mainly due to security and URL compliance matter and should be done correctly.

Please ensure you update ALL the used shortcode input data in ALL contents during migration before commiting to publication. The link shortcode documentation has already been updated to the latest specification for detailed read-through.

svg/shieldTag Shortcode URL Wrapping

For version 1.13.0, this shortcode’s URL wrapping is removed. If you need to wrap the badge with an URL, use the link shortcode. Here is an example of the transformation:

{{< svg/shieldTag ... "https://example.com" >}}

to

{{< link "https://example.com" ... >}}
        {{< svg/shieldTag ... >}}
{{< /link >}}

Epilogue

That’s all for Bissetii release note version v1.13.0. If you have any questions, please raise your queries in our Issues Section.