Merken

Writing multi-language documentation using Sphinx

Zitierlink des Filmsegments
Embed Code

Automatisierte Medienanalyse

Beta
Erkannte Entitäten
Sprachtranskript
OK again welcome to this kind of looks session in 1 this when with us this Marcus suffered when the when the vector from the multi jungle community in Germany and he will tell us something about what the language to conditions and things you the morning everyone them at up optimum you yeah take I guess all my field came to give the talk of can you tell you something you know and your guests
Father already introduced on all member of the German general community and the use of the developments in small nearly 15 years so I started with all doing some PHP in almost everything price and jungle staff and also involved with the open data community in Germany and I also do a lot of training was people physically jingle training and then have a company called strands coat and at the bottom of the German association so that if you have anything about change Germany can also talk to me and you can find a minute on a community or cunning on Twitter yeah so some basic
sermon 1st chart church offspring so who earn is already using these things here and the room OK so we half the people of his introduction of good guesses full swing sets a price and documentation generator which means it is written in Python is not only for points and you can use things for any project that you want to do so in any language you want you can even the commands of which has nothing to do with programming but all if you want and the mother language is called reStructuredText which is something which was the firing correctly was invented by the price and community it is something comparable to mark on which many people don't know already under the interesting thing is that you have a lot of our performance so you like it was structured text documents and you can create a level of performance as you can see here like HTML and loutish and of course pdf proper checks in from a new pages plain text so you also have the opportunity to display and your documentation probably on different devices and the switch can be found on things that proper or also the thing segmentation you and of course there is the title of the talk says I'm talking about initialization so and it's often referred to as as white region and so because it has a Jeanetta's and force that is all I wanted this and so this is often the abbreviation for international relations especially if you look at molecules names in programming and the idea about aging and as that you know can translate the strings inside the software without having to changes of all the time but because I mean if you if you have yourself inside all the different all texts and the different languages and you always have to switch between 1 right your regular code so really be mass and course you see the data like a transparent system to exchange some of these messages on the language of messages that people see that users soft under the most people will best the best known to for for that is that and get text which is open source software and this is also used in strings to create the got translations so and then simple get examples like that wasn't missing the left side the and that's not critical and so it is simply that you create a of translation a couple of objects from this example the covenant called example and it's in a directory called location and I a full but through simply the system true the changing the way of exception you get if it's not the existence of other important at the moment and so what what is missing here on the left side of the screen is that there is an underscore there's all kind of calling wants to get text this is usually done everywhere so underscore is used as a 8 years for the gettext functions already have wide left a code for the International vision many considers print statement always look on the bright side of life and the and you can see that the strange that is inside the print statements from function call it is again inside this function call which uses this from the school which is in new areas of the context and this way you and collect the string for translation so you source language will be English and this case and you would have been used as a source of translations and then you can vary in size is located directory different example catalogs for each language with translation is the English thing something else so this is how gettext basically works you collect the sole strings and then in the end you translate them into your blood type which of course was happening is happening behind the scenes swings doing for you so you don't have to do anything like that if you want to translate the recommendation just for for the estimation of thinking about 1 um yeah but but why use
gettext for translated augmentation why not simply copying fights to a new directory like from the and to your and simply translating all the text commence again with documentation again and have written the documentation in different language yeah so 1st problem is that if the documentation is updated in the regular language so these of additional updated and you have a hard time on finding which staff has been changed because you can't easily differ between them because all content is different because you quantities and language especially if you have you have a language like Japanese which has all the different characters like Latin languages 2nd problem then is if you leave something out because maybe you don't have the manpower human-translated the time all you don't know what is the proper translation for for this thing up and it's simply gone all you have to copy and paste this paragraph to you augmentation in English and remember again so that the translator that use gettext text would replace all strings that haven't been translated automatically with the people which is now strain so if you don't translate a single strain will progress and you build your transcend the plantation you will still see he was explaining the another thing or advantage is that the market is not affected because if you think of a document with any mark up like this sort of checksum whatever its demand and a copy of this all documents and the translated you copy of the market with it and that the market is also changed because argumentation evolves and now the way it is displayed is also changed with the next release of radiation you have to use the word in your translation but you only want preservation and lots you get have another problem and and the problem of yeah using tools like text is that you exclude people but because for this usually you have to use tools like the make you will which have to be
at best understand how all this works maybe progress then somewhere to give Europe translation merged in and so forth and so sometimes people do translations from what from what was is enough to get them involved in this process and so if you can use professional translation tools but it is much more easier for the translators to translate something for your project and this for official translation tools also offer you opportunities you normally don't have a regular text it it was like the schools can for example show you and it seems like that this program has been presented before and have a text which is 90 % same the translation mind since same like was similar to the text that has ever been before so you can simply then get these 90 % similar translation from registration cash put it in a simply change you words so also your translation of already existing and evolving documentation as fast OK yes so how does it
all works swings will explained
and this is an illustration from the string segmentation of the other and this shows how the Committee for International based augmentation is but links so you see on the following the of the forest which vowel and then build into beautiful minds which follows on the template so people always the extension for the source words of the text and beauty is in template for that supports the source language and then you translate beauty finance here to like Putin is mentioned but there are also other tools to your file and the purified is them up again and transferred into the compiled into a MO find and them file is in the binary version of your appeal file which is fast and excess so you can can get all these translations and fast and in the end then there was the point taken again to WMO finds and then the all the regions things are replaced with the strings and you have a translated documentation the if you want to do this and you have to do um you think all 1st thing is that if you haven't done this in Europe so you usually you have a doctorate degree instead of so if you have a constant 5 violent swings hold works under 1st we have to do you have to say which is my source language languages like the main language of medical annotation in this case in English and you have to to say look at well all my online arm translations go like the other catalogs with the different other languages and in this case it's the directory located and then there's also a all fairly new configuration of value get its convex and in set is the true and a documentation has several some of those all documents in a sub global are collected into a single catalog because of you get a couple of for each flight so because if you have a documentation which consists of 50 different fights in fact often folders you may also want to have 5 academics z of 50 because it makes transition easier so we have different opportunities here
so to do that need um translation in easier way there recent any the extensions or plugin for costing strings and yelled out and here can use all those by from sold that is available in addition to strings itself and this will then due to deal with all the translation for because it is possible to use strings themselves and some gettext tools to to create the the pure forms and animal forwards and almost after but this is a very nasty ways and also complicated way of doing this and things I and he also makes us all easier so um yeah of strings lanterns installed 1st thing you do is make a texts which are the be called the but strings command to create all these uh PUT faults so it extracts all the strings from the ROC plots and put them into use these catalogs and then and you say of strings until update minus knowledge of the language so the new language I want like Germany well if you will work well on my own located of well I mean people purity fights like this located directory so they make it explores the members like 3 and so these things I until update command would stretch all these duty forest naked text created and create new Germany catalogs for that of course it will be empty the because this command only like copying them and them so you can insert the German translations thinks so the next thing you have to do is translated documentation but I will talk multiple and useful that on menu after you translated everything you can say things idea built and then that would create all these and more fired that had been shown the image before and then in the end can again same mn HTML which creates for example the HTML but augmentation you can also make laughter something else to keep up on what was things also from in many now options you can say that the language should be something different so you all right the language and become firefighter created Germany it should now instead of an English 1 because images language and we want something different so the system the focal commands need to be on the equator catalogs and then translate them and build very different from the contagion language so what you can use for
translation 1 2 of course there are also others what is very hopefully these domain as friends
so trend Transifex as a web service so so basically you download is more likely website use and and it's free forms also projects on but if you
use commercial project you have to pay the costs because that they also need to have some income from and trans we looks like a professional translation to like which features I said like show me some of strings I had before and all false things and is also very nice school because you can collaborate with many other people on the same translation and people come together translate on stuff online the pairs constructs
as they also a command line tool transfixed flying through the principle of you city extended and system username and password that you can that the trends fixed-line on talk the platform and then you can
use things INTO together with friends affects the calls so inside house forensic support on as you can see by you 1st uh run this update teachers to teach the abbreviation for transfixed update conflict resources which yeah prepares and Transifex so that it can be used together with your swing segmentation you have to do a lot of steps you manually and strings ideas that we have thing for you here and then you can say teak push finds s and that's the little similar to like the mercurial so you push you started from the 6 months that means sources so I push my English catalogs Transifex so that other people then can create translations and translated to German Spanish Japanese whatever the from places and have been translated from the text I can put them again was to full and they can explicitly say which engages along for example here again I want to put the German translation some people created on 26 and then then can say OK like forced inside of those things make HTML for German and now I have my the like Germany for translation and cancer missing in German yeah so this was like
yeah that works so you've use and to use I'm already working with those things citing and I discovered using that are helpful in the other what was the international this mutation of
so if you use code inside the documentation using snippet of typical for example but you should be part of it should be careful and always use English inside this code example because otherwise the focal something is german here and something which is that it's Japanese the Japanese people would have a hard time understanding what the kind of and that really is about and they have really press From these things may but you also translate code but this hasn't been decided on how to deal with that and if this is possible because at the moment only like the the the written text is extracted from these things the human and not the cold calls another thing is that
different ways to handle you are an artist you can use the the students involved which put you are directly into the text and you can use the standards below where ideas as used and with the use of the idea of urgent and you and it's lost because it is not longer part of the capital and especially if this sentence is translated the name Tyson sources would be translated to prices for a cold or something similar in another language and so the name of the reference is lost and the you accounting and search so always put the URL inside your documentation so that translators well and can translate this properly yeah 1
thing you often want to refer to external euros and all these was all refer to referring to documentation which is what and like he's he's referring to doing that augmentation of 1 . 5 and if you then of such a documentation to refer to which and 1 . 6 you may want to don't want to go to all of you the plantation and change it and especially not all the translators want to go of all of their translators simply update version and they can use the feature of things so that thing about the dictionary next links something from the streets configuration of a defined these and then as you can see below in your text you can simply use these values as prefixes for and the rest of the year and so you like many early can construct these you and only have a single point redefined the prefix on the left side and
yet and how to handle special cases but there is a if conflict construction in the things we always can check against the current language and so you can have and every documentation like special cases for example here's a link to the German community and of course you want to have this part of the documentation only in the German language and not on the other languages so you can always have like some kind of special part of the documentation only for a specific language what
last this how to run the checks of folks over there is a link to a target and also linked to target and many other targets except these language which and then checks simply goes of order documentation and checks the world's also and of course you want to check you of of language and so this is also possible with all the different languages yeah so what's the missing from for example a translation setting is missing so that you can build small translation with 1 command at the moment you have to execute all the steps for every single language and if you have a documentation of 5 from the languages a lot of what you have to do some sort of course you want translation settings like the language of your written language and translations for other languages and you can simply but all of them together on the another thing that is missing is a landing page for the HTML version because yeah do you need something like page where refer to all the different languages that someone come see webpage rearrangement of imitation of another optimization could be you to use critics complex to greater using a couple of and sort of many catalogs almost all rest of that important I think we use most
of the time for at least a few questions before time up so synchronous link and responses to questions OK
should just 1 might from all of them yeah I thank god talk about so if you have several source files and the conditions in house it is to have several catalog 5 but then you have to a small words that that's occurring in every file translated every catalog file for other share within 1 of the things and I was sort of maybe excluding examples like well I should always kind of tools like so and we should do this and so and with swings of the the always before paragraph is expected so you every paragraph assessing the message so you never have seen the words that can be translated this is only true for the next so and things you can have an index of keywords where you've been in which is in the end of the book which and link them to different parts of the conditions and these individuals are translated separately but all the other stuff symptoms have of this was a Christian you will OK yeah any other questions and so I'm available all the data you and on here to Saturday and on the screen and said they will also have a spin on spring so if you have any ideas on how to optimize staff people I don't know the answer questions you can always come to us on Saturday and talk to us the about improving things would be happy to hear from you yeah OK thank you very much and have
Schreiben <Datenverarbeitung>
Multiplikation
Multiplikation
Datenfeld
Formale Sprache
Konditionszahl
Formale Sprache
Vorlesung/Konferenz
Vektorraum
Offene Menge
Punkt
Momentenproblem
Datensichtgerät
Formale Sprache
Hochdruck
Information
Computeranimation
Übergang
Homepage
Code
Minimum
Translation <Mathematik>
Strebe
Maschinelles Sehen
Lineares Funktional
Befehl <Informatik>
Softwareentwickler
Güte der Anpassung
Systemaufruf
Ruhmasse
Dichte <Stochastik>
Ausnahmebehandlung
Zeiger <Informatik>
Kontextbezogenes System
Software
Funktion <Mathematik>
Forcing
Twitter <Softwareplattform>
Auszeichnungssprache
Translation <Mathematik>
Projektive Ebene
URL
Verzeichnisdienst
Message-Passing
Zeichenkette
Subtraktion
Wellenpaket
Gerichteter Graph
Beschreibungssprache
Stab
Mathematisierung
Online-Katalog
Code
Prädikatenlogik erster Stufe
Homepage
Demoszene <Programmierung>
Software
Datentyp
Optimierung
Touchscreen
Schätzwert
Videospiel
Open Source
Relativitätstheorie
Physikalisches System
Objekt <Kategorie>
Assoziativgesetz
Whiteboard
Flächeninhalt
Offene Menge
ICC-Gruppe
Eigentliche Abbildung
Parametersystem
Subtraktion
Prozess <Physik>
Beschreibungssprache
Stab
sinc-Funktion
Formale Sprache
Ähnlichkeitsgeometrie
Reguläre Sprache
Quick-Sort
Computeranimation
Zeichenkette
Open Source
Temperaturstrahlung
Erweiterte Realität <Informatik>
Arithmetische Folge
Formale Sprache
Registrierung <Bildverarbeitung>
Translation <Mathematik>
Translation <Mathematik>
Projektive Ebene
Wort <Informatik>
Lateinisches Quadrat
Inhalt <Mathematik>
Optimierung
Zeichenkette
Subtraktion
Punkt
Gruppenoperation
Konvexer Körper
Formale Sprache
Versionsverwaltung
Online-Katalog
Computeranimation
Open Source
Translation <Mathematik>
Maßerweiterung
Konfigurationsraum
Wald <Graphentheorie>
Open Source
Template
Konfigurationsraum
Elektronische Publikation
Dialekt
Erweiterte Realität <Informatik>
Minimalgrad
Menge
Formale Sprache
Mehrrechnersystem
Wort <Informatik>
Hilfesystem
Versionsverwaltung
Verzeichnisdienst
Zeichenkette
Addition
Subtraktion
Wald <Graphentheorie>
Installation <Informatik>
Formale Sprache
Gebäude <Mathematik>
Plug in
Gleichungssystem
Plot <Graphische Darstellung>
Online-Katalog
Physikalisches System
Computeranimation
Konfiguration <Informatik>
Domain-Name
Bildschirmmaske
Erweiterte Realität <Informatik>
Translation <Mathematik>
Maßerweiterung
Verzeichnisdienst
Bildgebendes Verfahren
Zeichenkette
Konstruktor <Informatik>
Web Site
URN
NP-hartes Problem
Computeranimation
Bildschirmmaske
Web Services
Twitter <Softwareplattform>
COM
Translation <Mathematik>
Projektive Ebene
Zeichenkette
Internationalisierung <Programmierung>
Installation <Informatik>
Open Source
Versionsverwaltung
Systemaufruf
Gebäude <Mathematik>
Online-Katalog
Physikalisches System
Systemplattform
Computeranimation
Twitter <Softwareplattform>
Formale Sprache
Wärmeübergang
Client
Translation <Mathematik>
Passwort
Passwort
Computerforensik
Innerer Punkt
Zeichenkette
Momentenproblem
Mereologie
Systemaufruf
p-Block
Code
Computeranimation
Punkt
Open Source
Datenmodell
t-Test
Versionsverwaltung
Varianz
Web Site
Ähnlichkeitsgeometrie
Zeiger <Informatik>
Binder <Informatik>
Computeranimation
Data Dictionary
W3C-Standard
Metropolitan area network
Hypermedia
Open Source
Erweiterte Realität <Informatik>
Zustandsdichte
Mereologie
Translation <Mathematik>
Case-Modding
Konfigurationsraum
URL
Standardabweichung
Subtraktion
Momentenproblem
Minimierung
Formale Sprache
Versionsverwaltung
Online-Katalog
Web-Seite
Template
Computeranimation
Homepage
Online-Katalog
Translation <Mathematik>
Landing Page
Konstruktor <Informatik>
Elektronische Publikation
URN
Indexberechnung
Binder <Informatik>
Quick-Sort
Ranking
Einfache Genauigkeit
Warteschlange
Landing Page
Menge
Formale Sprache
Verschlingung
Mereologie
Ordnung <Mathematik>
Summand
Quelle <Physik>
Schreiben <Datenverarbeitung>
Gemeinsamer Speicher
Minimierung
Stab
Online-Katalog
Quellcode
Binder <Informatik>
Elektronische Publikation
Quick-Sort
Synchronisierung
Computeranimation
Automatische Indexierung
Konditionszahl
Grundsätze ordnungsmäßiger Datenverarbeitung
Endogene Variable
Mereologie
Ablöseblase
Vorlesung/Konferenz
Wort <Informatik>
Message-Passing
Touchscreen

Metadaten

Formale Metadaten

Titel Writing multi-language documentation using Sphinx
Serientitel EuroPython 2014
Teil 42
Anzahl der Teile 120
Autor Zapke-Gründemann, Markus
Lizenz CC-Namensnennung 3.0 Unported:
Sie dürfen das Werk bzw. den Inhalt zu jedem legalen Zweck nutzen, verändern und in unveränderter oder veränderter Form vervielfältigen, verbreiten und öffentlich zugänglich machen, sofern Sie den Namen des Autors/Rechteinhabers in der von ihm festgelegten Weise nennen.
DOI 10.5446/20001
Herausgeber EuroPython
Erscheinungsjahr 2014
Sprache Englisch
Produktionsort Berlin

Inhaltliche Metadaten

Fachgebiet Informatik
Abstract Markus Zapke-Gründemann - Writing multi-language documentation using Sphinx [EuroPython 2014] [23 July 2014] How to write multi-language documentation? What tools can you use? What mistakes should you avoid? This talk is based on the experiences I gathered while working on several multi-language documentation projects using Sphinx. ----- Internationalized documentation is a fairly new topic. And there are different approaches to do this. I will talk about how Sphinx internationalization support works, which tools and services I use and how to organize the translation workflow in an Open Source project. Finally I will have a look at what the future of internationalization in Sphinx might bring.
Schlagwörter EuroPython Conference
EP 2014
EuroPython 2014

Ähnliche Filme

Loading...