gtmpl

package module
Version: v0.0.0-...-db0e14d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2020 License: Unlicense Imports: 4 Imported by: 0

README

================================
Go Template With Gettext Support
================================

.. image:: https://img.shields.io/badge/Language-Go-blue.svg
   :target: https://golang.org/

.. image:: https://godoc.org/github.com/siongui/gtmpl?status.svg
   :target: https://godoc.org/github.com/siongui/gtmpl

.. image:: https://api.travis-ci.org/siongui/gotm.svg?branch=master
   :target: https://travis-ci.org/siongui/gotm

.. image:: https://goreportcard.com/badge/github.com/siongui/gtmpl
   :target: https://goreportcard.com/report/github.com/siongui/gtmpl

.. image:: https://img.shields.io/badge/license-Unlicense-blue.svg
   :target: https://github.com/siongui/gtmpl/blob/master/UNLICENSE

.. image:: https://img.shields.io/badge/Status-Beta-brightgreen.svg

Go_ `html/template`_ with gettext_ support.

Development Environment:

  - `Ubuntu 20.04`_
  - `Go 1.14.4`_


Install
+++++++

.. code-block:: bash

  go get -u github.com/siongui/gtmpl


Usage
+++++

The gettext_ feature is provided by `chai2010/gettext-go`_, which is pure Go
solution for gettext_.

Follow `gettext workflow`_ to prepare PO files, we need to mark translatable
strings from input files. In our cases here, the translatable string
``Pāḷi Dictionary`` is marked as ``{{gettext "Pāḷi Dictionary"}}`` (see
`theme/template-i18n/index.html <theme/template-i18n/index.html>`_). If we
run xgettext_ directly on the Go template, we get nothing [7]_. We can use sed_
to convert the marked strings in Go template to the extractable syntax as
follows:

.. code-block:: bash

  $ sed "s/{{gettext \(".*"\)}}/{{gettext(\1)}}/g" theme/template-i18n/index.html | xgettext --no-wrap --language=c --from-code=UTF-8 --output=locale/messages.pot -

Then we follow the normal workflow again to finish the translation and get the
PO files to be used by `chai2010/gettext-go`_ package.

See `parse_test.go <parse_test.go>`_ for how to create HTML files.


UNLICENSE
+++++++++

Released in public domain. See UNLICENSE_.


References
++++++++++

.. [1] `Golang Template Inheritance (Python Jinja2 extends & include) <https://siongui.github.io/2017/02/05/go-template-inheritance-jinja2-extends-include/>`_

.. [2] `GitHub - chai2010/gettext-go: GNU gettext for Go <https://github.com/chai2010/gettext-go>`_
       (`godoc <https://godoc.org/github.com/chai2010/gettext-go/gettext>`__)

.. [3] `io writer to string golang - Google search <https://www.google.com/search?q=io+writer+to+string+golang>`_

.. [4] | `godoc code - Google search <https://www.google.com/search?q=godoc+code>`_
       | `godoctricks - GoDoc <https://godoc.org/github.com/fluhus/godoc-tricks>`_

.. [5] | render_ and grender_
       | `grender: stdlib templates with additional "extends" support : golang <https://www.reddit.com/r/golang/comments/61hcfg/grender_stdlib_templates_with_additional_extends/>`_
       | `GitHub - dannyvankooten/grender: Go package for easily rendering JSON/XML data and HTML templates <https://github.com/dannyvankooten/grender>`_
       | `GitHub - unrolled/render: Go package for easily rendering JSON, XML, binary data, and HTML templates responses. <https://github.com/unrolled/render>`_

.. [6] | `Go template rendering or Node.js template rendering? : golang <https://www.reddit.com/r/golang/comments/68i04t/go_template_rendering_or_nodejs_template_rendering/>`_
       | `GitHub - titpetric/egon: An ERB-style templating language for Go. <https://github.com/titpetric/egon>`_
       | `books/12fa-docker-golang/chapter7 at master · titpetric/books · GitHub <https://github.com/titpetric/books/tree/master/12fa-docker-golang/chapter7>`_

.. [7] `xgettext Extract Translatable Strings From Golang html/template <https://siongui.github.io/2016/01/19/xgettext-extract-translatable-string-from-go-html-template/>`_

.. _Go: https://golang.org/
.. _html/template: https://golang.org/pkg/html/template/
.. _gettext: https://www.google.com/search?q=gettext
.. _Ubuntu 20.04: https://releases.ubuntu.com/20.04/
.. _Go 1.14.4: https://golang.org/dl/
.. _chai2010/gettext-go: https://github.com/chai2010/gettext-go
.. _gettext workflow: https://www.google.com/search?q=gettext+workflow
.. _xgettext: https://www.google.com/search?q=xgettext
.. _sed: https://www.google.com/search?q=sed
.. _grender: https://github.com/dannyvankooten/grender
.. _render: https://github.com/unrolled/render
.. _UNLICENSE: https://unlicense.org/

Documentation

Overview

Package gtmpl adds gettext support to Go standard html/template package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ParseDirectoryTree

func ParseDirectoryTree(domain, localeDir, dir string) (t *template.Template, err error)

ParseDirectoryTree will find all files in directory tree (including sub-directories) and pass filenames to ParseFiles.

func ParseFiles

func ParseFiles(domain, localeDir string, filenames ...string) (*template.Template, error)

ParseFiles is the same as ParseFiles except gettext function is installed via Funcs method provided by Go standard html/template package. the installed gettext function will use the data given by domain and localeDir arguments to translate the strings in the template.

func SetLanguage

func SetLanguage(locale string) string

SetLanguage sets the locale to be used to render the template.

see https://godoc.org/github.com/chai2010/gettext-go#SetLanguage for more details.

func Translate

func Translate(msgid string) string

Translate returns gettext.PGettext("", msgid)

see https://godoc.org/github.com/chai2010/gettext-go#PGettext for more details.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL