Compare Revisions

Practice article for SUMO localizers (localize this)

Revision 95775:

Revision 95775 by vesper on

Revision 278303:

Revision 278303 by AliceWyman on

Keywords:

practice article sumo l10n localize these words
practice article sumo l10n localize these words

Search results summary:

This article is meant for new localizers to practice how different elements of a KB page work during localization. (localize this)
This article is meant for new localizers to practice how different elements of a KB page work during localization. (localize this)

Content:

<!-- Hello! This (hopefully green) text is an HTML comment. It is visible only if you look at the source of the page or at the editor view. Users can't see it otherwise. We use it to leave comments and useful information for editors of KB text. It's important that you use the opening and closing symbols to make sure the text does not show to users. You don't have to localize such comments! --> <!-- Please read all the text in the comments, it will help you understand what's going on here :-) --> <!-- Below is a paragraph text without any formatting --> Welcome to the practice l10n article for SUMO! Here you can see how the elements in Knowledge Base articles in SUMO work together to allow for many combinations of content on one page. It can look quite complex at first, so pay attention - but it's also a very easy to use and powerful tool! This article can be localized by anyone with a SUMO account, and the localized version should be deleted after the localizer feels confident with working in the KB, to make it possible for new contributors to practice. To get started with the practice, please click the "Translate article" link on the side. Things will look a bit differently, but you will see instructions in the "Content" field, so don't worry! <!-- Below is a Table of Contents. It is automatically generated based on the headers used in the text, so just use the same element in your localized version --> __TOC__ <!-- Below is an H1 heading. Remember to keep the formatting in your localized version! --> = Let's get practicing! = <!-- Below is an H2 heading. Remember to keep the formatting in your localized version! --> == First, let's take a look at basic formatting == <!-- Below are some examples of the basic formatting. Keep it the same in your version - it's important to highlight and order the content the same way for all users. As you can see, there are also regular HTML elements like <br>. Our wiki is HTML friendly! --> This text should be normal.<br> '''This text should be bold.'''<br> ''This text should be italicized.''<br> '''''This text should be bold AND italicized.'''''<br> <!-- There's a non-breaking-space hiding in the line below! Can you see it? --> * This should be a bullet point&nbsp;for the top list. ** This should be a sub-bullet point. *** This should be a sub-sub-bullet point. * This should be another bullet point for the top list. # This should be a numbered list element for the top list. ## This should be a numbered list sub-element. ## This should be the next numbered list sub-element. ### This should be a numbered list sub-sub-element. ### This should be the next numbered list sub-sub-element. # This should be the next numbered list element for the top list. <!-- Here come some cool visual highlight --> {note}This should be a note. You should localize everything between the starting and ending element of this note, but not the starting/ending element!{/note} {warning}This should be a more visible note, that we like to call a "warning". You should localize everything between the starting and ending element of this warning, but not the starting/ending element!{/warning} Very often, an article will contain references to the user interface of the software it describes. We use a bunch of different formatting options for that, too!<br> <!-- In the two example below, do NOT translate the "button" and "menu" words. DO translate the other text in the bracket --> {button This is a button highlight}, and {menu This should be a menu option highlight}. == Now, let's practice ''for'' statements == <!-- Below is an example of a direct link to another KB article. Do not localize it, just use the same English title in your localized version. It will be automatically changed to your language when you localize the article it refers to. Wikimagic! --> You can find all the information on how to use ''for'' statements (including very intricate combinations ;D) when you read [[How to use For]]. <!-- Below are a few examples of "for" statements in the text. They will not appear to all the users, but they will appear to all localizers! So, whenever you localize, you localize for all the versions, not just the one you see in the preview --> {for not fx30}This will not appear for Firefox version 30.{/for} {for fx38}This will appear only for Firefox version 38.{/for} {for linux}This will appear only for Linux. <!--Below is an image element. Do not change the text inside [[those brackets]], unless you have a localized or updated version of the image ready and uploaded.--> [[Image:linux logo]] {/for} {for win}This will appear only for Windows. <!--Below is an image element. Do not change the text inside [[those brackets]], unless you have a localized or updated version of the image ready and uploaded.--> [[Image:Windows]]{/for} {for mac}This will appear only for Mac OS. <!--Below is an image element. Do not change the text inside [[those brackets]], unless you have a localized or updated version of the image ready and uploaded.--> [[Image:macos logo]]{/for} <!-- Below is an H3 heading. Remember to keep the formatting in your localized version! --> === Where do I find more help? === <!-- Below is a link to a target page (in this case, in the KB). If you want to link to something, you have to use [] brackets, and put the URL first - and the words used as the link text after that, with one space break. The link below should highlight "this article" on the page. Please note that we are linking to a KB article without the language parameter in the URL! This way, whoever clicks that link goes to their language version (if it's available) or to the English version (a default if the other language is not available). When you use the "insert a link" option in the interface, this type of link is the "external link". --> To learn how to upload and use images in the KB, read the information in [https://support.mozilla.org/kb/adding-screenshots this article]. == What about Templates? == {warning}Warning, incoming template!{/warning} <!-- Below is an example template. It will show you text on the page when you look at it as a user - but when you localize, it only shows you the [[Template:templatenamehere]] element. So, you should not change, localize or edit this element in any way while localizing - just use it the way it is. If you want to localize templates, you have to go to them through the appropriate section in the Localization dashboard. --> [[Template:aboutconfig]] === I want to know more about Templates! === <!-- OK, let's get back to normal text ;-) --> If you want to learn more about templates, please read [[How to use Templates]]. = OK, I get all the formatting, what to do next? = # Make sure you read the rest of the l10n documentation: [[Translating an article]]. # Get in touch with other localizers in your language! [https://support.mozilla.org/en-US/forums/l10n-forum/711081 you can find the languages here]. # Ready to start localizing? Great! [https://support.mozilla.org/localization Head over to your dashboard] and get cracking :-) # Remember, that if you have problems or questions, you can <!-- Finally, this is a slightly different URL format - here, we assume that the base of the URL is http://support.mozilla.org AND put only the URL elements after that into the link - it still works! --> [/forums/l10n-forum/ head over to our forums and ask there!]
<!-- Hello! This (hopefully green) text is an HTML comment. It is visible only if you look at the source of the page or at the editor view. Users can't see it otherwise. We use it to leave comments and useful information for editors of KB text. It's important that you use the opening and closing symbols to make sure the text does not show to users. You don't have to localize such comments! --> <!-- Please read all the text in the comments, it will help you understand what's going on here :-) --> <!-- Below is a paragraph text without any formatting --> Welcome to the practice l10n article for SUMO! Here you can see how the elements in Knowledge Base articles in SUMO work together to allow for many combinations of content on one page. It can look quite complex at first, so pay attention - but it's also a very easy to use and powerful tool! This article can be localized by anyone with a SUMO account, and the localized version should be deleted after the localizer feels confident with working in the KB, to make it possible for new contributors to practice. To get started with the practice, please click the "Translate article" link on the side. Things will look a bit differently, but you will see instructions in the "Content" field, so don't worry! <!-- Below is a Table of Contents. It is automatically generated based on the headers used in the text, so just use the same element in your localized version --> __TOC__ <!-- Below is an H1 heading. Remember to keep the formatting in your localized version! --> = Let's get practicing! = <!-- Below is an H2 heading. Remember to keep the formatting in your localized version! --> == First, let's take a look at basic formatting == <!-- Below are some examples of the basic formatting. Keep it the same in your version - it's important to highlight and order the content the same way for all users. As you can see, there are also regular HTML elements like <br>. Our wiki is HTML friendly! --> This text should be normal.<br> '''This text should be bold.'''<br> ''This text should be italicized.''<br> '''''This text should be bold AND italicized.'''''<br> <!-- There's a non-breaking-space hiding in the line below! Can you see it? --> * This should be a bullet point&nbsp;for the top list. ** This should be a sub-bullet point. *** This should be a sub-sub-bullet point. * This should be another bullet point for the top list. # This should be a numbered list element for the top list. ## This should be a numbered list sub-element. ## This should be the next numbered list sub-element. ### This should be a numbered list sub-sub-element. ### This should be the next numbered list sub-sub-element. # This should be the next numbered list element for the top list. <!-- Here come some cool visual highlight --> {note}This should be a note. You should localize everything between the starting and ending element of this note, but not the starting/ending element!{/note} {warning}This should be a more visible note, that we like to call a "warning". You should localize everything between the starting and ending element of this warning, but not the starting/ending element!{/warning} Very often, an article will contain references to the user interface of the software it describes. We use a bunch of different formatting options for that, too!<br> <!-- In the two example below, do NOT translate the "button" and "menu" words. DO translate the other text in the bracket --> {button This is a button highlight}, and {menu This should be a menu option highlight}. == Now, let's practice ''for'' statements == <!-- Below is an example of a direct link to another KB article. Do not localize it, just use the same English title in your localized version. It will be automatically changed to your language when you localize the article it refers to. Wikimagic! --> You can find all the information on how to use ''for'' statements (including very intricate combinations ;D) when you read [[How to use "For" tags]]. <!-- Below are a few examples of "for" statements in the text. They will not appear to all the users, but they will appear to all localizers! So, whenever you localize, you localize for all the versions, not just the one you see in the preview --> {for not fx30}This will not appear for Firefox version 30.{/for} {for fx38}This will appear only for Firefox version 38.{/for} {for linux}This will appear only for Linux. <!--Below is an image element. Do not change the text inside [[those brackets]], unless you have a localized or updated version of the image ready and uploaded.--> [[Image:linux logo]] {/for} {for win}This will appear only for Windows. <!--Below is an image element. Do not change the text inside [[those brackets]], unless you have a localized or updated version of the image ready and uploaded.--> [[Image:Windows]]{/for} {for mac}This will appear only for Mac OS. <!--Below is an image element. Do not change the text inside [[those brackets]], unless you have a localized or updated version of the image ready and uploaded.--> [[Image:macos logo]]{/for} <!-- Below is an H3 heading. Remember to keep the formatting in your localized version! --> === Where do I find more help? === <!-- Below is a link to a target page (in this case, in the KB). If you want to link to something, you have to use [] brackets, and put the URL first - and the words used as the link text after that, with one space break. The link below should highlight "this article" on the page. Please note that we are linking to a KB article without the language parameter in the URL! This way, whoever clicks that link goes to their language version (if it's available) or to the English version (a default if the other language is not available). When you use the "insert a link" option in the interface, this type of link is the "external link". --> To learn how to upload and use images in the KB, read the information in [https://support.mozilla.org/kb/adding-screenshots this article]. == What about Templates? == {warning}Warning, incoming template!{/warning} <!-- Below is an example template. It will show you text on the page when you look at it as a user - but when you localize, it only shows you the [[Template:templatenamehere]] element. So, you should not change, localize or edit this element in any way while localizing - just use it the way it is. If you want to localize templates, you have to go to them through the appropriate section in the Localization dashboard. --> [[Template:aboutconfig]] === I want to know more about Templates! === <!-- OK, let's get back to normal text ;-) --> If you want to learn more about templates, please read [[How to use Templates]]. = OK, I get all the formatting, what to do next? = # Make sure you read the rest of the l10n documentation: [[Translating an article]]. # Get in touch with other localizers in your language! [https://support.mozilla.org/en-US/forums/l10n-forum/711081 you can find the languages here]. # Ready to start localizing? Great! [https://support.mozilla.org/localization Head over to your dashboard] and get cracking :-) # Remember, that if you have problems or questions, you can <!-- Finally, this is a slightly different URL format - here, we assume that the base of the URL is http://support.mozilla.org AND put only the URL elements after that into the link - it still works! --> [/forums/l10n-forum/ head over to our forums and ask there!]

Back to History