Translation custom loaders #4166

raulfraile · 2014-08-22T19:24:48Z

Q	A
Doc fix?	no
New docs?	yes
Applies to	all
Fixed tickets	#4156

This PR adds a documentation section for creating custom loaders and dumpers to support other formats.

stof · 2014-08-23T09:52:55Z

components/translation/custom_formats.rst

+new class that implements the
+:class:`Symfony\\Component\\Translation\\Loader\\LoaderInterface` interface,
+which defines a
+:method:`Symfony\\Component\\Translation\\Loader\\LoaderInterface::load`


I don't think listing the methods of the interface is needed in this paragraph. Implementing an inteface involves implementing all its methods.

stof · 2014-08-23T09:56:57Z

the new page should be added to the map.rst.inc in the components folder.

And in the DIC tag reference presenting the translation.loader tag, you should add a link to this page

javiereguiluz · 2014-08-23T09:57:07Z

components/translation/custom_formats.rst

+
+Let's imagine you have a custom format where translation messages are defined
+using one line for each translation and parenthesis to wrap the key and the
+message. A translation file would look like this::


Using :: at the end of this paragraph would make the code listing be interpreted as PHP code. Maybe its better to create a proper code listing:

[...] message. A translation file would look like this: .. code-block:: text (welcome)(Bienvenido) (goodbye)(Adios) (hello)(Hola)

javiereguiluz · 2014-08-23T10:01:48Z

@raulfraile thanks for completing the documentation of the translator component. I really like it!

xabbuh · 2014-08-23T10:09:23Z

Does it make sense to have this in the components part? What about moving this to the cookbook?

raulfraile · 2014-08-23T20:23:34Z

@stof @javiereguiluz just pushed some changes based on your comments, but I am not sure about linking it from the translation.loader DIC tag. Should we remove the small introduction about custom loaders from there and just link here?

xabbuh · 2014-08-23T20:45:27Z

@raulfraile I would remove everything after the first sentence there and add a link to your new article instead. So, it would then look something like this:

translation.loader
------------------

**Purpose**: To register a custom service that loads translations

By default, translations are loaded from the filesystem in a variety of different
formats (YAML, XLIFF, PHP, etc).

.. seealso::

    Learn how to :doc:`load custom formats </components/translation/custom_format>`
    in the components section.

But let's wait what the others think.

xabbuh · 2014-08-23T20:46:10Z

components/translation/introduction.rst

-Loader too. The default loaders are:
+The component comes with some default loaders and you can
+:doc:`create your own Loader too </components/translation/custom_formats>`. The
+default loaders are:


I would not mention the custom loaders here, but add a sentence after the list of default loaders instead.

xabbuh · 2014-08-23T21:03:09Z

@raulfraile I didn't meant to shock you. The things I commented on are mainly minor issues. I basically really like the work you did. 👍

ggam · 2014-08-23T21:40:06Z

components/translation/custom_formats.rst

+.. code-block:: text
+
+    (welcome)(Bienvenido)
+    (goodbye)(Adios)


Little type: adiós ;)

raulfraile · 2014-08-24T06:24:00Z

@xabbuh thank you for the suggestions! I fixed all the issues (except the DIC tag docs, waiting what others think).

xabbuh · 2014-08-24T06:51:51Z

We also have a translation.dumper tag which can also be linked the same way like translation.loader.

wouterj · 2014-08-24T12:44:29Z

+1 for keeping this in the component section: It is related to the component, not the framework.

wouterj · 2014-08-24T12:44:56Z

components/translation/custom_formats.rst

+
+Sometimes, you need to deal with custom formats for translation files. The
+Translation component is flexible enough to support this. Just create a
+loader (to load translations) and, optionally, a dumper (to dump translations).


and what about an extractor?

totally unrelated. The extractor does not care about the format of your translation files. It relies on the loader and dumper for it (it would be great to add a cookbook about adding extractors though)

wouterj · 2014-08-24T12:50:55Z

apart from some minor comments, it looks good.

Thank you for submitting!

raulfraile · 2014-08-26T18:46:00Z

@wouterj I pushed some changes based on your comments, except for the extractor, as I would need to do some additional research. Can we leave it for another PR?

xabbuh · 2014-08-26T19:40:02Z

@raulfraile As @stof mentioned here, the extractor is not really related to this article and I agree with him in that.

@wouterj What do you think about the proposed change in the reference (I think something like that should be added for the translation.dumper tag too)?

weaverryan · 2014-09-16T00:56:44Z

components/translation/custom_formats.rst

+Creating a Custom Loader
+------------------------
+
+To define a custom loader that is able to read this kind of files, you must create a


... these kind of files ...

weaverryan · 2014-09-16T00:59:54Z

Hey Raul! I've decided to merge this because it's very nice! There is one little type that I just commented on and will fix myself. @xabbuh, if you'd like to create the note on the DI tags page, that would be great - I agree that it's a good idea. Thanks everyone!

This PR was merged into the 2.3 branch. Discussion ---------- Translation custom loaders | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | #4156 This PR adds a documentation section for creating custom loaders and dumpers to support other formats. Commits ------- 69491ae Improved custom formats article based on comments c0f3b0a Fixed wrong indentation 629a008 Extra improvements based on comments bfd78b3 Improvements based on comments 105a168 Cleanups e2fd5fa Small fixes dee7fb2 Link from introduction section 8b6c584 Added custom format page to translation component

@stof

* 2.3: (29 commits) [#4166] Fixing small typo Fixed all the errors found by Ryan Removed two highlight formats which are "experimental" and not used by end users Reworded the explanation about the limitation of enablin PHP templates Improved the explanation thanks to @stof comments More and more fixes and improvements Added another bunch of fixes suggested by reviewers Added lots of fixes suggested by reviewers Added a note about not using relative internal links in the doc Switched another relative link into an absolute reference lways use absolute links instead of relative for internal doc links Added missing link Revamped the documentation about "Contributing Docs" do not reference services in parameters Fix reference label Add label book-security-roles Add formatting, links, and clarity Added a note about the side effects of enabling both PHP and Twig Caution that roles should start with ROLE_ Added note about exporting SYMFONY_ENV ... Conflicts: components/translation/introduction.rst

@stof

* 2.4: (30 commits) [#4166] Fixing small typo caution on `null` values in Expression constraint Fixed all the errors found by Ryan Removed two highlight formats which are "experimental" and not used by end users Reworded the explanation about the limitation of enablin PHP templates Improved the explanation thanks to @stof comments More and more fixes and improvements Added another bunch of fixes suggested by reviewers Added lots of fixes suggested by reviewers Added a note about not using relative internal links in the doc Switched another relative link into an absolute reference lways use absolute links instead of relative for internal doc links Added missing link Revamped the documentation about "Contributing Docs" do not reference services in parameters Fix reference label Add label book-security-roles Add formatting, links, and clarity Added a note about the side effects of enabling both PHP and Twig Caution that roles should start with ROLE_ ...

@stof

* 2.5: (30 commits) [#4166] Fixing small typo caution on `null` values in Expression constraint Fixed all the errors found by Ryan Removed two highlight formats which are "experimental" and not used by end users Reworded the explanation about the limitation of enablin PHP templates Improved the explanation thanks to @stof comments More and more fixes and improvements Added another bunch of fixes suggested by reviewers Added lots of fixes suggested by reviewers Added a note about not using relative internal links in the doc Switched another relative link into an absolute reference lways use absolute links instead of relative for internal doc links Added missing link Revamped the documentation about "Contributing Docs" do not reference services in parameters Fix reference label Add label book-security-roles Add formatting, links, and clarity Added a note about the side effects of enabling both PHP and Twig Caution that roles should start with ROLE_ ...

…on (xabbuh) This PR was merged into the 2.3 branch. Discussion ---------- [Reference] link translation DIC tags to components section | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | The `translation.loader` and `translation.dumper` DIC tags link to the respective sections in the Translation component documentation (in addition to the changes done in #4166). Commits ------- 9790975 link translation DIC tags to components section

raulfraile added 4 commits August 22, 2014 21:11

Added custom format page to translation component

8b6c584

Link from introduction section

dee7fb2

Small fixes

e2fd5fa

Cleanups

105a168

stof reviewed Aug 23, 2014
View reviewed changes

javiereguiluz reviewed Aug 23, 2014
View reviewed changes

Improvements based on comments

bfd78b3

xabbuh reviewed Aug 23, 2014
View reviewed changes

ggam reviewed Aug 23, 2014
View reviewed changes

components/translation/custom_formats.rst

.. code-block:: text

(welcome)(Bienvenido)

(goodbye)(Adios)

Copy link

ggam Aug 23, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Little type: adiós ;)

Extra improvements based on comments

629a008

Fixed wrong indentation

c0f3b0a

wouterj reviewed Aug 24, 2014
View reviewed changes

wouterj added the In progress label Aug 24, 2014

Improved custom formats article based on comments

69491ae

weaverryan reviewed Sep 16, 2014
View reviewed changes

weaverryan merged commit 69491ae into symfony:2.3 Sep 16, 2014

weaverryan added a commit that referenced this pull request Sep 16, 2014

[#4166] Fixing small typo

08639ae

xabbuh mentioned this pull request Sep 17, 2014

[Reference] link translation DIC tags to components section #4247

Merged

daFish pushed a commit to daFish/symfony-docs that referenced this pull request Sep 28, 2014

[symfony#4166] Fixing small typo

edd2f8d

wouterj mentioned this pull request Dec 13, 2014

[Components][Translation] Custom loaders and dumpers #4156

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Translation custom loaders #4166

Translation custom loaders #4166

raulfraile commented Aug 22, 2014

stof Aug 23, 2014

stof commented Aug 23, 2014

javiereguiluz Aug 23, 2014

javiereguiluz commented Aug 23, 2014

xabbuh commented Aug 23, 2014

raulfraile commented Aug 23, 2014

xabbuh commented Aug 23, 2014

xabbuh Aug 23, 2014

xabbuh commented Aug 23, 2014

ggam Aug 23, 2014

raulfraile commented Aug 24, 2014

xabbuh commented Aug 24, 2014

wouterj commented Aug 24, 2014

wouterj Aug 24, 2014

stof Aug 26, 2014

wouterj commented Aug 24, 2014

raulfraile commented Aug 26, 2014

xabbuh commented Aug 26, 2014

weaverryan Sep 16, 2014

weaverryan commented Sep 16, 2014

Translation custom loaders #4166

Translation custom loaders #4166

Conversation

raulfraile commented Aug 22, 2014

stof Aug 23, 2014

Choose a reason for hiding this comment

stof commented Aug 23, 2014

javiereguiluz Aug 23, 2014

Choose a reason for hiding this comment

javiereguiluz commented Aug 23, 2014

xabbuh commented Aug 23, 2014

raulfraile commented Aug 23, 2014

xabbuh commented Aug 23, 2014

xabbuh Aug 23, 2014

Choose a reason for hiding this comment

xabbuh commented Aug 23, 2014

ggam Aug 23, 2014

Choose a reason for hiding this comment

raulfraile commented Aug 24, 2014

xabbuh commented Aug 24, 2014

wouterj commented Aug 24, 2014

wouterj Aug 24, 2014

Choose a reason for hiding this comment

stof Aug 26, 2014

Choose a reason for hiding this comment

wouterj commented Aug 24, 2014

raulfraile commented Aug 26, 2014

xabbuh commented Aug 26, 2014

weaverryan Sep 16, 2014

Choose a reason for hiding this comment

weaverryan commented Sep 16, 2014