Bootstrap Translation component documentation

[weaverryan]

Recommended sections:

• Introduction
• Installation
• Usage

[wouterj]

I''ll create a small document about this component soon.

[wouterj]

@weaverryan what should be included in the components articles? Should it be the most complete documentation of all features of the component (as we do in Dependency Injection articles) or should it only be documentation on how to use that component without symfony and describe features in the book and cookbook articles (as I want to do with this component and as we should do with the Templating component)?

And should I document things which are documented elsewhere in the documentation? Or should I add a link to that article in the docs?

[weaverryan]

Hi @wouterj!

This is still something we're deciding as we go :). I think the current most popular thing to do is to document "everything" in the component (like DI). Then, in theory, we might carefully remove some things from the book and replace them with links to the component. I say carefully, because we need the book to continue to be very readable and "complete". In the end, I think that we will have some duplication between the component and book, but we can minimize that as much as possible by taking "big pieces", putting them into a component doc, then linking later from the book.

The current flow right now looks like this:

a) Somehow bootstraps the component docs
b) The community starts adding more things things to that component
c) (optional) Existing cookbooks may be moved into sub-component docs, then the old cookbook contains a link to the new component doc + any other framework-specific details (we do this for stuff in the console)
d) (optional) Remove some things from the book and replace with links back to the component, being sure that we keep the book complete.

And then we'll evolve from here as we learn more :). The "form" component will be the big experiment, were we put both symfony and component docs into one doc with tabs for the code for each. But that's something I'd like to only do in this one spot for now.

Thanks!

[wouterj]

@weaverryan thanks for your long answer!

I was asking this because the Translation Component doesn't really have things that aren't documented in the book/translation article, besides loading message catologues in a Translator. Do you think I need to include things like translating strings, parameters and pluralization?

A related question: The documentation of the Templating Component are far from complete right now, but the missing parts are documented in the cookbook/templating/php article. Should we move those sections into the Templating component and add a link in the cookbook article?