From 875f29aa6901378a64819851f42bc93b2b7647bc Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Fri, 22 Jan 2016 18:00:05 +0100 Subject: [PATCH] doc: i18n HTML templates Issue #25907: Use {% trans %} tags in HTML templates to ease the translation of the documentation. The tag comes from Jinja templating system, used by Sphinx. Patch written by Julien Palard. --- Doc/tools/templates/indexcontent.html | 78 +++++++++++++-------------- Doc/tools/templates/indexsidebar.html | 22 ++++---- Doc/tools/templates/layout.html | 18 +++---- 3 files changed, 59 insertions(+), 59 deletions(-) diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html index 969099a0069..1076c1f51b7 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -1,59 +1,59 @@ {% extends "defindex.html" %} {% block tables %} -

Parts of the documentation:

+

{% trans %}Parts of the documentation:{% endtrans %}

-

What's new in Python {{ version }}?
- or all "What's new" documents since 2.0

-

Tutorial
- start here

-

Library Reference
- keep this under your pillow

-

Language Reference
- describes syntax and language elements

-

Python Setup and Usage
- how to use Python on different platforms

-

Python HOWTOs
- in-depth documents on specific topics

+

{% trans %}What's new in Python {{ version }}?{% endtrans %}
+ {% trans whatsnew_index=pathto("whatsnew/index") %}or all "What's new" documents since 2.0{% endtrans %}

+

{% trans %}Tutorial{% endtrans %}
+ {% trans %}start here{% endtrans %}

+

{% trans %}Library Reference{% endtrans %}
+ {% trans %}keep this under your pillow{% endtrans %}

+

{% trans %}Language Reference{% endtrans %}
+ {% trans %}describes syntax and language elements{% endtrans %}

+

{% trans %}Python Setup and Usage{% endtrans %}
+ {% trans %}how to use Python on different platforms{% endtrans %}

+

{% trans %}Python HOWTOs{% endtrans %}
+ {% trans %}in-depth documents on specific topics{% endtrans %}

 -

Installing Python Modules
- installing from the Python Package Index & other sources

-

Distributing Python Modules
- publishing modules for installation by others

-

Extending and Embedding
- tutorial for C/C++ programmers

-

Python/C API
- reference for C/C++ programmers

-

FAQs
- frequently asked questions (with answers!)

+

{% trans %}Installing Python Modules{% endtrans %}
+ {% trans %}installing from the Python Package Index & other sources{% endtrans %}

+

{% trans %}Distributing Python Modules{% endtrans %}
+ {% trans %}publishing modules for installation by others{% endtrans %}

+

{% trans %}Extending and Embedding{% endtrans %}
+ {% trans %}tutorial for C/C++ programmers{% endtrans %}

+

{% trans %}Python/C API{% endtrans %}
+ {% trans %}reference for C/C++ programmers{% endtrans %}

+

{% trans %}FAQs{% endtrans %}
+ {% trans %}frequently asked questions (with answers!){% endtrans %}

-

Indices and tables:

+

{% trans %}Indices and tables:{% endtrans %}

-

Global Module Index
- quick access to all modules

-

General Index
- all functions, classes, terms

-

Glossary
- the most important terms explained

+

{% trans %}Global Module Index{% endtrans %}
+ {% trans %}quick access to all modules{% endtrans %}

+

{% trans %}General Index{% endtrans %}
+ {% trans %}all functions, classes, terms{% endtrans %}

+

{% trans %}Glossary{% endtrans %}
+ {% trans %}the most important terms explained{% endtrans %}

 -

Search page
- search this documentation

-

Complete Table of Contents
- lists all sections and subsections

+

{% trans %}Search page{% endtrans %}
+ {% trans %}search this documentation{% endtrans %}

+

{% trans %}Complete Table of Contents{% endtrans %}
+ {% trans %}lists all sections and subsections{% endtrans %}

-

Meta information:

+

{% trans %}Meta information:{% endtrans %}

-

Reporting bugs

-

About the documentation

+

{% trans %}Reporting bugs{% endtrans %}

+

{% trans %}About the documentation{% endtrans %}

 -

History and License of Python

-

Copyright

+

{% trans %}History and License of Python{% endtrans %}

+

{% trans %}Copyright{% endtrans %}

{% endblock %} diff --git a/Doc/tools/templates/indexsidebar.html b/Doc/tools/templates/indexsidebar.html index 78e9c4f99ef..bb449ef1cd3 100644 --- a/Doc/tools/templates/indexsidebar.html +++ b/Doc/tools/templates/indexsidebar.html @@ -1,17 +1,17 @@ -

Download

-

Download these documents

-

Docs for other versions

+

{% trans %}Download{% endtrans %}

+

{% trans %}Download these documents{% endtrans %}

+

{% trans %}Docs for other versions{% endtrans %}

-

Other resources

+

{% trans %}Other resources{% endtrans %}

diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html index 8ae6e23f80d..1887b85b607 100644 --- a/Doc/tools/templates/layout.html +++ b/Doc/tools/templates/layout.html @@ -6,7 +6,7 @@
  • {%- if versionswitcher is defined %} {{ release }} - Documentation{{ reldelim1 }} + {% trans %}Documentation {% endtrans %}{{ reldelim1 }} {%- else %} {{ shorttitle }}{{ reldelim1 }} {%- endif %} @@ -79,24 +79,24 @@ {% endblock %} {% block footer %}
    - © Copyright {{ copyright|e }}. + © {% trans %}Copyright{% endtrans %} {{ copyright|e }}.
    - The Python Software Foundation is a non-profit corporation. - Please donate. + {% trans %}The Python Software Foundation is a non-profit corporation.{% endtrans %} + {% trans %}Please donate.{% endtrans %}
    - Last updated on {{ last_updated|e }}. - Found a bug? + {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} + {% trans pathto_bugs=pathto('bugs') %}Found a bug?{% endtrans %}
    - Created using Sphinx {{ sphinx_version|e }}. + {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %}
    {% endblock %} {% block sidebarsourcelink %} {%- if show_source and has_source and sourcename %}

    {{ _('This Page') }}

    {%- endif %} {% endblock %}