diff --git a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml index e7c5c2303f..fc68b35cd3 100644 --- a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml @@ -33,13 +33,14 @@ Translations - This is the FAQ for people translating the FreeBSD documentation - (FAQ, Handbook, tutorials, manual pages, and others) to different - languages. - - It is very heavily based on the translation FAQ - from the FreeBSD German Documentation Project, originally written by Frank - Gründer elwood@mc5sys.in-berlin.de and translated back to + This is the FAQ for people translating the FreeBSD + documentation (FAQ, Handbook, tutorials, manual pages, and others) + to different languages. + + It is very heavily based on the + translation FAQ from the FreeBSD German Documentation Project, + originally written by Frank Gründer + elwood@mc5sys.in-berlin.de and translated back to English by Bernd Warken bwarken@mayn.de. The FAQ is maintained by the &a.doceng;. @@ -51,10 +52,11 @@ - More and more people are approaching the freebsd-doc mailing - list and volunteering to translate FreeBSD documentation to other - languages. This FAQ aims to answer their questions so they can start - translating documentation as quickly as possible. + More and more people are approaching the freebsd-doc + mailing list and volunteering to translate FreeBSD + documentation to other languages. This FAQ aims to answer + their questions so they can start translating documentation + as quickly as possible. @@ -63,17 +65,17 @@ What do i18n and l10n mean? - + i18n means - internationalization and l10n - means localization. They are just a convenient - shorthand. + internationalization and + l10n means localization. + They are just a convenient shorthand. - i18n can be read as i followed by - 18 letters, followed by n. Similarly, - l10n is l followed by 10 letters, - followed by n. + i18n can be read as i + followed by 18 letters, followed by n. + Similarly, l10n is l + followed by 10 letters, followed by n. @@ -83,10 +85,12 @@ - Yes. Different translation groups have their own mailing - lists. The list - of translation projects has more information about the - mailing lists and web sites run by each translation project. + Yes. Different translation groups have their own + mailing lists. The list + of translation projects has more information about + the mailing lists and web sites run by each translation + project. @@ -96,12 +100,13 @@ - Yes. The more people work on translation the faster it gets - done, and the faster changes to the English documentation are - mirrored in the translated documents. + Yes. The more people work on translation the faster it + gets done, and the faster changes to the English + documentation are mirrored in the translated + documents. - You do not have to be a professional translator to be able to - help. + You do not have to be a professional translator to be + able to help. @@ -111,139 +116,151 @@ - Ideally, you will have a good knowledge of written English, and - obviously you will need to be fluent in the language you are - translating to. + Ideally, you will have a good knowledge of written + English, and obviously you will need to be fluent in the + language you are translating to. - English is not strictly necessary. For example, you could do a - Hungarian translation of the FAQ from the Spanish + English is not strictly necessary. For example, you + could do a Hungarian translation of the FAQ from the Spanish translation. - + What software do I need to know? - It is strongly recommended that you maintain a local copy of the - FreeBSD CVS repository (at least the documentation part) either - using CTM or - CVSup. The "Staying current with FreeBSD" - chapter in the Handbook explains how to use these + It is strongly recommended that you maintain a local + copy of the FreeBSD CVS repository (at least the + documentation part) either using + CTM or + CVSup. The "Staying current with + FreeBSD" chapter in the Handbook explains how to use these applications. - You should be comfortable using CVS. - This will allow you to see what has changed between different - versions of the files that make up the documentation. + You should be comfortable using + CVS. This will allow you to see + what has changed between different versions of the files + that make up the documentation. - [XXX To Do -- write a tutorial that shows how to use CVSup to - get just the documentation, check it out, and see what has changed - between two arbitrary revisions] + [XXX To Do -- write a tutorial that shows how to use + CVSup to get just the documentation, check it out, and see + what has changed between two arbitrary revisions] - How do I find out who else might be translating to the same - language? + How do I find out who else might be translating to the + same language? The Documentation - Project translations page lists the translation efforts - that are currently known about. If others are already working - on translating documentation to your language, please do not - duplicate their efforts. Instead, contact them to see how you can - help. + Project translations page lists the translation + efforts that are currently known about. If others are + already working on translating documentation to your + language, please do not duplicate their efforts. Instead, + contact them to see how you can help. If no one is listed on that page as translating for your - language, then send a message to the &a.doc; in case someone else - is thinking of doing a translation, but has not announced it yet. - + language, then send a message to the &a.doc; in case someone + else is thinking of doing a translation, but has not + announced it yet. - + - No one else is translating to my language. What do I do? + No one else is translating to my language. What do I + do? - Congratulations, you have just started the FreeBSD - your-language-here Documentation - Translation Project. Welcome aboard. + Congratulations, you have just started the + FreeBSD your-language-here + Documentation Translation Project. Welcome + aboard. - First, decide whether or not you have got the time to spare. Since - you are the only person working on your language at the moment it is - going to be your responsibility to publicize your work and - coordinate any volunteers that might want to help you. + First, decide whether or not you have got the time to + spare. Since you are the only person working on your + language at the moment it is going to be your responsibility + to publicize your work and coordinate any volunteers that + might want to help you. - Write an email to the Documentation Project mailing list, - announcing that you are going to translate the documentation, so the - Documentation Project translations page can be maintained. + Write an email to the Documentation Project mailing + list, announcing that you are going to translate the + documentation, so the Documentation Project translations + page can be maintained. - If there is already someone in your country providing FreeBSD - mirroring services you should contact them and ask if you can - have some webspace for your project, and possibly an email - address or mailing list services. - - Then pick a document and start translating. It is best to start - with something fairly small—either the FAQ, or one of the - tutorials. + If there is already someone in your country providing + FreeBSD mirroring services you should contact them and ask + if you can have some webspace for your project, and possibly + an email address or mailing list services. + + Then pick a document and start translating. It is best + to start with something fairly small—either the FAQ, + or one of the tutorials. - I have translated some documentation, where do I send it? + I have translated some documentation, where do I send + it? - That depends. If you are already working with a translation team - (such as the Japanese team, or the German team) then they will have - their own procedures for handling submitted documentation, and these - will be outlined on their web pages. + That depends. If you are already working with a + translation team (such as the Japanese team, or the German + team) then they will have their own procedures for handling + submitted documentation, and these will be outlined on their + web pages. - If you are the only person working on a particular language (or - you are responsible for a translation project and want to submit - your changes back to the FreeBSD project) then you should send your - translation to the FreeBSD project (see the next question). + If you are the only person working on a particular + language (or you are responsible for a translation project + and want to submit your changes back to the FreeBSD project) + then you should send your translation to the FreeBSD project + (see the next question). - I am the only person working on translating to this language, how - do I submit my translation? + I am the only person working on translating to this + language, how do I submit my translation? or - We are a translation team, and want to submit documentation that - our members have translated for us? + We are a translation team, and want to submit + documentation that our members have translated for + us? - First, make sure your translation is organized properly. This - means that it should drop into the existing documentation tree and - build straight away. + First, make sure your translation is organized properly. + This means that it should drop into the existing + documentation tree and build straight away. - Currently, the FreeBSD documentation is stored in a top level - directory called doc/. Directories below this - are named according to the language code they are written in, as - defined in ISO639 (/usr/share/misc/iso639 on a - version of FreeBSD newer than 20th January 1999). + Currently, the FreeBSD documentation is stored in a top + level directory called doc/. + Directories below this are named according to the language + code they are written in, as defined in ISO639 + (/usr/share/misc/iso639 on a version of + FreeBSD newer than 20th January 1999). - If your language can be encoded in different ways (for example, - Chinese) then there should be directories below this, one for each - encoding format you have provided. + If your language can be encoded in different ways (for + example, Chinese) then there should be directories below + this, one for each encoding format you have provided. - Finally, you should have directories for each document. + Finally, you should have directories for each + document. - For example, a hypothetical Swedish translation might look - like: + For example, a hypothetical Swedish translation might + look like: doc/ sv_SE.ISO8859-1/ @@ -256,8 +273,8 @@ sv_SE.ISO8859-1 is the name of the translation, in lang.encoding - form. Note the - two Makefiles, which will be used to build the documentation. + form. Note the two Makefiles, which will be used to build + the documentation. Use &man.tar.1; and &man.gzip.1; to compress up your documentation, and send it to the project. @@ -266,41 +283,47 @@ &prompt.user; tar cf swedish-docs.tar sv_SE.ISO8859-1 &prompt.user; gzip -9 swedish-docs.tar - Put swedish-docs.tar.gz somewhere. If you - do not have access to your own webspace (perhaps your ISP does not - let you have any) then you can email &a.doceng;, and arrange to email - the files when it is convenient. + Put swedish-docs.tar.gz somewhere. + If you do not have access to your own webspace (perhaps your + ISP does not let you have any) then you can email + &a.doceng;, and arrange to email the files when it is + convenient. - Either way, you should use &man.send-pr.1; to submit a report - indicating that you have submitted the documentation. It would be - very helpful if you could get other people to look over your - translation and double check it first, since it is unlikely that the - person committing it will be fluent in the language. + Either way, you should use &man.send-pr.1; to submit a + report indicating that you have submitted the documentation. + It would be very helpful if you could get other people to + look over your translation and double check it first, since + it is unlikely that the person committing it will be fluent + in the language. - Someone (probably the Documentation Project Manager, currently - &a.doceng;) will then take your translation and confirm that it builds. - In particular, the following things will be looked at: + Someone (probably the Documentation Project Manager, + currently &a.doceng;) will then take your translation and + confirm that it builds. In particular, the following things + will be looked at: - Do all your files use RCS strings (such as "ID")? + Do all your files use RCS strings (such as + "ID")? Does make all in the - sv_SE.ISO8859-1 directory work correctly? + sv_SE.ISO8859-1 directory work + correctly? - + - Does make install work correctly? + Does make install work + correctly? - - + + If there are any problems then whoever is looking at the submission will get back to you to work them out. - If there are no problems your translation will be committed - as soon as possible. + If there are no problems your translation will be + committed as soon as possible. @@ -313,21 +336,22 @@ We would prefer that you did not. - For example, suppose that you are translating the Handbook to - Korean, and want to include a section about retailers in Korea in - your Handbook. + For example, suppose that you are translating the + Handbook to Korean, and want to include a section about + retailers in Korea in your Handbook. - There is no real reason why that information should not be in the - English (or German, or Spanish, or Japanese, or …) versions - as well. It is feasible that an English speaker in Korea might try - to pick up a copy of FreeBSD whilst over there. It also helps - increase FreeBSD's perceived presence around the globe, which is not - a bad thing. + There is no real reason why that information should not + be in the English (or German, or Spanish, or Japanese, or + …) versions as well. It is feasible that an English + speaker in Korea might try to pick up a copy of FreeBSD + whilst over there. It also helps increase FreeBSD's + perceived presence around the globe, which is not a bad + thing. - If you have country specific information, please submit it as a - change to the English Handbook (using &man.send-pr.1;) and then - translate the change back to your language in the translated - Handbook. + If you have country specific information, please submit + it as a change to the English Handbook (using + &man.send-pr.1;) and then translate the change back to your + language in the translated Handbook. Thanks. @@ -335,27 +359,29 @@ - How should language specific characters be included? + How should language specific characters be + included? - Non-ASCII characters in the documentation should be included - using SGML entities. + Non-ASCII characters in the documentation should be + included using SGML entities. - Briefly, these look like an ampersand (&), the name of the - entity, and a semi-colon (;). + Briefly, these look like an ampersand (&), the name + of the entity, and a semi-colon (;). - The entity names are defined in ISO8879, which is in the ports - tree as textproc/iso8879. + The entity names are defined in ISO8879, which is in the + ports tree as textproc/iso8879. A few examples include: - Entity + Entity - Appearance + Appearance - Description + Description &eacute; @@ -377,8 +403,8 @@ After you have installed the iso8879 port, the files in - /usr/local/share/sgml/iso8879 contain the - complete list. + /usr/local/share/sgml/iso8879 contain + the complete list. @@ -389,12 +415,13 @@ In the English documents, the reader is addressed as - you, there is no formal/informal distinction as there - is in some languages. + you, there is no formal/informal distinction + as there is in some languages. - If you are translating to a language which does distinguish, use - whichever form is typically used in other technical documentation in - your language. If in doubt, use a mildly polite form. + If you are translating to a language which does + distinguish, use whichever form is typically used in other + technical documentation in your language. If in doubt, use + a mildly polite form. @@ -407,8 +434,8 @@ Yes. - The header of the English version of each document will look - something like this: + The header of the English version of each document will + look something like this: <!-- The FreeBSD Documentation Project @@ -416,12 +443,13 @@ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.5 2000/07/07 18:38:38 dannyboy Exp $ --> - The exact boilerplate may change, but it will always include a - $FreeBSD$ line and the phrase The FreeBSD Documentation - Project. - Note that the $FreeBSD part is expanded automatically by - CVS, so it should be empty (just - $FreeBSD$) for new files. + The exact boilerplate may change, but it will always + include a $FreeBSD$ line and the phrase + The FreeBSD Documentation Project. + Note that the $FreeBSD part is expanded automatically + by CVS, so it should be empty (just + $FreeBSD$) for new + files. Your translated documents should include their own $FreeBSD$ line, and change the @@ -429,9 +457,9 @@ The FreeBSD language Documentation Project. - In addition, you should add a third line which indicates which - revision of the English text this is based on. - + In addition, you should add a third line which indicates + which revision of the English text this is based on. + So, the Spanish version of this file might start: <!--