Opened 18 years ago

Closed 18 years ago

Last modified 17 years ago

#739 closed task (fixed)

tutorial and docs translations

Reported by: radek <translate@…> Owned by: Jacob
Component: Documentation Version: 1.0
Severity: normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

I believe that next step in i18n is to have and maintain tutorial translations.

I don't know, what are the sources of tutorial texts (website? .txt files?)

But I think that we should provide both forms translated.

In the filesystem we could use locale code therefore I propose following structure in /django/docs:

./en
all current files in english

./cs
some translated files in czech

./de
some translated files in german

...

I am not sure about the djangoproject website yet (so it's up to you), but it would surely prove the framework to be i18n friendly.

Change History (9)

comment:1 by eugene@…, 18 years ago

I think this is a good idea. All documents are part of Django's SVN tree. You can find them here:
http://code.djangoproject.com/browser/django/trunk/docs

Everything related to document processing is in DjangoProject.com SVN:
http://code.djangoproject.com/browser/djangoproject.com/django_website/apps/docs

Documents are in reStructuredText format, which is converted to html at some point. Just take a look at them and you will see it is pretty much self-describing. If you want to learn more about .rst, go there:
http://docutils.sourceforge.net/rst.html

comment:2 by radek, 18 years ago

Thx for pointing me to the source.

So, just to make sure:

If I take eg. http://code.djangoproject.com/browser/django/trunk/docs/tutorial01.txt

and translate it to eg.

http://code.djangoproject.com/browser/django/trunk/docs/cs/tutorial01.txt

would it be OK?

Btw. I definitely suggest using UTF-8

I'll try to prepare something.

Ah, and because Adrian is changing docs quite often, then we will need something in the processing that would mark translations as not up to date. At least on the website.

comment:3 by eugene@…, 18 years ago

My private opinion is if you translate the documents, Adrian or Jacob will find a way to include them. I know for sure that tutorials were translated in several languages. It would be nice to have them in one place either by hosting them, or by linking to them.

comment:4 by Adrian Holovaty, 18 years ago

Yeah, we should totally have translations for the docs -- everything within django/docs in the distribution. The problem, as others have pointed out, is that the docs change often, with us adding improvements and clarifications all the time. So the translators would be expected to keep their translations up to date.

comment:5 by anonymous, 18 years ago

They change often now, where there are lots of changes. But they won't change that much after release. Maybe an idea would be to put in a week's notice for release for translators, so they can do any updates needed? And to only put translations into subversion that where signalled by their translators as "clear"?

comment:6 by radek, 18 years ago

Yep, that would be fine, if translators were notified about 2 weeks before the release.

Anyway, when I think there will be changes introduced in after the release. Therefore I'll note at the end of the translation on which subverion number of english version it is based.

Eg. :Version: based on tutorial01.txt:948

So Adrian will be able to indicate how "far" it is from the actual version of tutorial01.txt.

comment:7 by paolo, 18 years ago

Guys, just an idea: wouldn't be better if we could continue this kind of discussions in a more appropriate place, now that we have the newly created django-I18N group (http://groups.google.com/group/Django-I18N)? IMO ticket system is not the appropriate tool to discuss this kind of topics.

comment:8 by Adrian Holovaty, 18 years ago

Resolution: fixed
Status: newclosed

comment:9 by (none), 17 years ago

milestone: Version 1.0

Milestone Version 1.0 deleted

Note: See TracTickets for help on using tickets.
Back to Top