Foreign languages and documentation

Foreign languages and documentation


At the developers conference this year, held in Sorrento, Italy, I was fortunate enough to meet and have dinner with some Italian MySQL users—some of whom had travelled from Rome to be with us that evening at a lovely traditional Italian restaurant just off one of the main squares.

I know it’s going to sound stupid, and this is obviously an Anglo Saxon trait, but I really had never given much consideration to users of software in other languages. Okay, I’m obviously aware that other countries and nationalities use computers—I answer many reader queries on my books and articles from non-English speakers from as near as Europe and as far as Japan and China—but the internet is very much driven by the English speakers of the world.

Talking to our Italian guests it hit me how little English they really knew, and from that, how difficult it must be to read a manual in a language other than your own. How would you cope, for example, trying to read a manual using the small amount of French that you were taught in your teens? Services like Babelfish are great, but anything beyond the ordinary and it starts to miss out words and even entire phrases.

Hopefully the people we met in Italy will help us at MySQL to produce Italian versions of our documentation—if anybody else wants to help, please get in touch—until then, the closest we can get to an Italian version of the manual is the new Spanish manual. That manual is based on the 5.0 reference manual, and so it is a mere 1500 pages.

Of course, such a manual wont just be useful to those people over the Mediterranean, but the many Spanish speakers around the world, including North and South America.

As with most of our translations, this is a result of work with a partner (this time in Barcelona) and with the Spanish speaking community. If you have any questions, comments, or improvements, then please contact me or better still, use the email address at the head of the manual.

If you want to get involved, I’ll show you a quick trick so that you can see how to compare the Spanish and English manuals, or indeed any other combinations. All sections of the MySQL manual have a unique section ID, and this is the same, even across different versions of the manual. It is also retained in English even in the foreign manuals. So the Replication chapter, which has different numbers in different versions of the manual, always has the same base ID (replication). The introduction for the Replication chapter has an ID of “replication-intro”.

To see that in the English manual, use the base URL of http://dev.mysql.com/doc/refman/5.0/en/. The “5.0” in this URL indicates the reference manual (and ergo, MySQL) version number, and the “en” the language (English). To get to the Replication intro, add “replication-intro.html” to the end to make http://dev.mysql.com/doc/refman/5.0/en/replication-intro.html.. Replace the “5.0” with “5.1” and you’ll get the Replication chapter that applies to the 5.1 version of the MySQL server and reference manual.

Similarly, for the Spanish manual, replace the “en” with “es” (for España), so the base URL becomes http://dev.mysql.com/doc/refman/5.0/es/. The Replication Introduction in Spanish therefore becomes http://dev.mysql.com/doc/refman/5.0/es/replication-intro.html.

Easy, right?

The same basic process can be used for all the translations. You can get to the French equivalent by using “fr” (for Français): http://dev.mysql.com/doc/refman/5.0/fr/replication-intro.html.

Now you can compare French, Spanish and English versions of the manual side by side. Remember, we work on the free software and community philosophy; if you have a comment or want to make a contribution, get in touch!

Category: 

Comments

stenone's picture
Submitted by stenone on

I come from a damn small language area (Denmark) so I might be biased, but why not keep documentation, manuals and program-GUI's in English?

Programmers have to know English anyhow. And people that work with the programmes are usually skilled in English too.

Keeping documentation, manuals and program GUI's in English will make program production/support costs at a lower level.

I an not (completely) stupid and ignorant and forgetting that some things like dates and numbers names and other localized data can't be written in English all over the world. But that would be only the exceptions and not the rule.

P.S. This comment is meant as a starting point for a discussion - not to start a flame war. I know that a lot of people will disagree with me, so speak out...

Author information

Martin Brown's picture

Biography

Martin “MC” Brown is a member of the documentation team at MySQL and freelance writer. He has worked with Microsoft as an Subject Matter Expert (SME), is a featured blogger for ComputerWorld, a founding member of AnswerSquad.com, Technical Director of Foodware.net and, and has written books on topics as diverse as Microsoft Certification, iMacs, and free software programming.

Most forwarded

Interview with Dave Mohyla, of DTIDATA

Dave Mohyla is the president and founder of dtidata.com, a hard drive recovery facility based in Tampa, Florida.

TM: Where are you based? What does your company do?
DTI Data recovery is based in South Pasadena, Florida which is a suburb of Tampa. We have been here for over 10 years. We operate a bio-metrically secured class 100 clean room where we perform hard drive recovery on all types of hard disks, from laptop hard drives to multi drive RAID systems.

Anybody up to writing good directory software?

Since the very beginning, directories (of any kind) have had a very central role in the internet. (I have recently grown fond of Free Web Directory. Even Slashdot can be considered a directory: a collection of great news and invaluable user-generated comments. As far as software is concerned, doing a quick search on Google about software directories will return the free (as in freedom) software directories like Savannah, SourceForge, Freshmeat and so on, followed by shareware and freeware sites such as FileBuzz, PCWin Download Center and All Freeware (great if you're looking for shareware and freeware, but definitely less comprehensive than their free-as-in-freedom counterparts).

Interview with Mark Shuttleworth

Mark Shuttleworth is the founder of Thawte, the first Certification Authority to sell public SSL certificates. After selling Thawte to Verisign, Mark moved on to training as an astronaut in Russia and visiting space. Once he got back he founded Ubuntu, the leading GNU/Linux distribution. He agreed on releasing a quick interview to Free Software Magazine.

Is better education the key to finding better software?

I read David Jonathon's article Anybody Up To Writing Good Directory Software? the other day, which got me thinking about software directories in general. As David mentioned, many of the software directories one finds when doing a quick google search are free as in beer, not as in freedom. But what interests me is the software directories that already exist, providing a combination of both free as in beer software, and open source software. Sites such as Freeware Downloads and Shareware Download don't advertise themselves as providing free as in liberty software, but each of them have a good selection of open source software available... if you know where to look.

Most emailed

Free Open Document label templates

If you’ve ever spent hours at work doing mailings, cursed your printer for printing outside the lines on your labels, or moaned “There has got to be a better way to do this,” here’s the solution you’ve been looking for. Working smarter, not harder! Worldlabel.com, a manufacture of labels offers Open Office / Libre Office labels templates for downloading in ODF format which will save you time, effort, and (if you want) make really cool-looking labels

Creating a user-centric site in Drupal

A little while ago, while talking in the #drupal mailing list, I showed my latest creation to one of the core developers there. His reaction was "Wow, I am always surprised what people use Drupal for". His surprise is somehow justified: I did create a site for a bunch of entertainers in Perth, a company set to use Drupal to take over the world with Entertainers.Biz.

Update: since writing this article, I have updated the system so that the whole booking process happens online. I will update the article accordingly!

So, why, why do people and companies develop free software?

More and more people are discovering free software. Many people only do so after weeks, or even months, of using it. I wonder, for example, how many Firefox users actually know how free Firefox really is—many of them realise that you can get it for free, but find it hard to believe that anybody can modify it and even redistribute it legally.

When the discovery is made, the first instinct is to ask: why do they do it? Programming is hard work. Even though most (if not all) programmers are driven by their higher-than-normal IQs and their amazing passion for solving problems, it’s still hard to understand why so many of them would donate so much of their time to creating something that they can’t really show off to anybody but their colleagues or geek friends.

Sure, anybody can buy laptops, and just program. No need to get a full-on lab or spend thousands of dollars in equipment. But... is that the full story?

Fun articles

Santa Claus - the most successful open source project

It dawned on me the other day, as I was shopping for the dozens of gifts it seems I have to buy every December, that Santa Claus is the most successful open source project in history. (Bridget @ Illiterarty would agree with that). Santa Claus is essentially a marketing development that is embodied by everyone who stuffs a sock, gives a gift, hosts a dinner or wishes Merry Christmas over the holiday season.

Most emailed

Editorial

When I first started thinking about Free Software Magazine, I was feeling enthusiastic about the dream. I had Dave, Gianluca, and Alan willing to help me, I had established members of the free software community willing to help me out, I had writers volunteering their time and energy for free, and I had a generous offer from OpenHosting for servers, all before I'd proved myself. There was a sense of excitement in the air, and I thought maybe, just maybe, I could make this work.

Free Software Magazine uses Apollo project management software and CRM for its everyday activities!