ubuntu-tour team mailing list archive

[Anthony Stewart <madnessred@xxxxxxxxx>]

Hi all.

Firstly, apologies to those who get the email twice, I have blind
carbon-copied everyone who put themself down as an author or editor on the
volunteers page.

Just a quick update on the new language system. Things are going smoothly. I
would like to ask those you who have written tours if you could possibly
migrate them to the new branch.

You can get the branch by running:
bzr branch lp:ubuntu-tour

As always if you need any help, there are usually, hopefully, people on irc.

Anyway, before you copy across your tours, there are a few differences, I'll
list them in order of importance.

1) Only write english tours, provided you set up translations properly, the
tour will then be translated in Launchpad. At the bottom of this tour I will
convert a page from the About Ubuntu tour to the new format which is needed
to show how it should be done.

2) You must put strings to be translated in the __() function, eg
<h1>__(About Ubuntu)</h1>. Only text between __( and ) will be translated.
Now it is possible you may accidentally close the function early. __(You may
do this :), for example). In order to avoid this use a backslash before
brackets. __(You may do this :\), for example). it is worth noting that
matched parenthesis are fine. __(This (or anything similar) would be fine).
If you are unsure, just stick a black slash before all brackets inside the
function. You should also escape opening parenthesis too. __(This (or
anything similar] would caus problems)</p>... ... ...

3) You need to use full html, also, due to margin and styling, please put
all your content in paragraphs <p>__(Content)</p>. By using paragraphs the
text should be spaces nicely and given the correct margins. Alternatively,
you may use lists for numbers items.
<ol>
<li>__(Item 1)</li>
<li>__(Item 2)</li>
</ol>
Use <ol> for a numbered list or <ul> for a bullet point list.

4) There is a small change to the <screenshot> tag. If you put a rel
attirbute in, <screenshot src="..." rel="galery1" /> all screenshot tags in
the tour with that rel attribute will be grouped together, meaning that once
the user has clicked on 1 screenshot, he can browse through the others by
clicking on the arrows

5) You can put more information in the tour.info. There are now options for
you to give the tour a short description, give it a difficulty rating out of
10 and also specify who the main authors and editors are.

6) Also finally please note that translations won't be instant on Launchpad.
Launchpad commits new translations daily to the branch, fairly early in the
morning it seems. The important thing this is that once you have made a
translation in Launchpad it will be up to a day before the changes can be
seen.
Once the translations have been made, they are only pushed to the branch as
.po file. You need to compile them into .mo files.
If you run this from the root folder "sudo ./dev.py compile-lang" the .po
files will be compiles to .mo files and copied to the relevant place in
/usr/share/locale/. I needs to be run as root so it can edit the folder.
Alternatively, sudo ./dev.py update will pull the latest branch and compile
the strings from that.

7) Once you have written a tour, the translatable strings have to be found.
The easiest way of doing this is simply to commit using ./dev.py commit
"DESCRIPTION OF CHANGES".
This will add any files you have created, recreate the language template,
commit you changes and push them to the branch. Basically it does
bzr add
./dev.py create-pot
bzr commit -m "DESCRIPTION OF CHANGES"
bzr push

I have written ./dev.py to make managing the branch easier.

8) Oh yh, there are some pretty animations, though are subject to change
though as we see fit. There will probably also be an option to disable them
coming later.


So about this conversion I promised:
Old style:

> <h1>Ubuntu Tour</h1><div align="center"><screenshot
> src="../../../images/ubuntu-logo.png" width="400" /></div>

If you have prior experience with using Ubuntu, feel free to skip this
> tutorial.

However, if you are interested in finding out what Ubuntu has in store for
> you, then start off your <b>Ubuntu</b> experience with a guided tour.


> If there is an image you would like to see a larger version of, click on it
> to zoom in.


> Click <b>Forward</b> to start.



New style: (comments in green)

> <h1><div align="center">__(Ubuntu Tour)</div></h1><!-- Please keep this
> title as then we get a consistent look.-->

 <!--Since <br /> tags are no longer added you can space the tour out more,
> make it look nice-->


> <p>

<screenshot src="~/images/ubuntu-logo.png" width="400" /><br /><!--Since the
> new tour does not load each tour as a new html page, you need to refer to
> local files differently, ~/ is the current directory of the tour-->



__(If you have prior experience with using Ubuntu, feel free to skip this
> tutorial.)<br /><!-- You need to add you own line breaks now-->

 __(However, if you are interested in finding out what Ubuntu has in store
> for you,) __(then start off your <strong>Ubuntu</strong> experience with a
> guided tour.)<br /><!--Be more verbose with tags, strong and em instead of
> b and i-->



<span class="natty only">__(The new version of Ubuntu comes with a new
> interface, if you have not used this before you are recommended to follow
> this tour)</span><!--Spans are useful now, for those you know css, the
> class only is invisible, the class natty is visible for natty users only, if
> you want to do something interesting, post on the irc and we'll try and find
> you a way of doing it. (You can reference more than one distro by *<span
> class="natty oneiric only"> *-->

  </p>


> <p>__(If there is an image you would like to see a larger version of, click
> on it to zoom in.)</p><!--Line breaks are not needed at the end of
> paragraphs-->


> <p>__(Click <strong>Forward</strong> to start.)</p>



So without comments that would look like:

> <h1><div align="center">__(Ubuntu Tour)</div></h1>



<p><screenshot src="~/images/ubuntu-logo.png" width="400" /><br />

__(If you have prior experience with using Ubuntu, feel free to skip this
> tutorial.)<br />

__(However, if you are interested in finding out what Ubuntu has in store
> for you,) __(then start off your <strong>Ubuntu</strong> experience with a
> guided tour.)</p>


> <p>__(If there is an image you would like to see a larger version of, click
> on it to zoom in.)</p>


> <b>__(Click <strong>Forward</strong> to start.)</b>


Thank you all for you contributions to this project.

On 30 March 2011 14:29, Anthony Stewart <madnessred@xxxxxxxxx> wrote:

> Hi,
>
> I have been playing a bit with gettext....
>