Giter Club home page Giter Club logo

wagtail-localize-git's Introduction

wagtail-localize-git

This plugin enables translating Wagtail content using a PO files in a git repository.

It works by committing source content into the repository then polling it for updates. When the PO files are translated, this will automatically create translated pages in Wagtail.

This is useful for when you are using external translation tools for translating your Wagtail content. Currently, this plugin supports Mozilla's Pontoon, but PRs are welcome for other translation tools!

Installation

This plugin requires Wagtail 2.11 with internationalisation enabled and Wagtail Localize.

Install both wagtail-localize and wagtail-localize-git, then add the following to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'wagtail_localize',
    'wagtail_localize.locales',  # Replaces 'wagtail.locales'
    'wagtail_localize_git',
    ...
]

Then set the following settings:

WAGTAILLOCALIZE_GIT_URL - This is a URL to an empty git repository that wagtail-localize-git will push source strings to and fetch translations from. WAGTAILLOCALIZE_GIT_CLONE_DIR - The local directory where the git repository will be checked out.

Synchronisation

Once this is configured, you can use the sync_git management command to push/pull changes. This management command should be set up in your server's crontab to run often (preferably, every 10 minutes).

How it works

This plugin uses wagtail-localize to convert pages into segments and build new pages from translated segments. wagtail-localize provides a web interface for translating these segments in Wagtail itself and this plugin plays nicely with that (translations can be made from the Wagtail side too).

Pages/snippets are submitted to the git repo when they are submitted for translation from the default locale. Pages authored in other locales are not supported yet.

wagtail-localize-git's People

Contributors

kaedroho avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.