GNU MediaGoblin Wiki - User contributions [en]

User:Manolinux

2011-12-07T19:08:31Z

Manolinux: /* Openx support */ more "long term"

== Openx support ==

Here I am going to write all the stuff about a feature proposal.

===Rationale===

I hate ads.

But if we are going to have a server with thousands of users all day uploading pics, we need to have income.

Thinking federated, people who wish to run their web server may wish to do it for money.

===What is OpenX?===

Previously known as openAds, it is a software that manages and serves banners and other kind of ads. It is open source, of course (though there is a proprietary version too).

===How does it work?===

You need to have openx installed somewhere, or use openx hosted, a multiuser site. There, you define Advisers, Campaigns (inside Advisers) and banners (inside Campaigns) on one hand, and on the other hand you define Websites, and Zones in them. Then, you put some banners inside each zone.

Each zone has an invocation code, a piece of HTML you put where you want in your website. The invocation code makes the banner appear, and do the neccesary accounting.

===What do we do?===

====Input====

* OpenX instance address (i.e. http://myserver.com/openx)
* Zone number.
* Where in Media Goblin to put the code.

====Output====

* The HTML code in the desired area.

===Why OpenX?===

Because it is the better free advertising server I know of. If you know of another option, let me know.

===Architecture===

* For sure this must be a plugin. Any work done must be very modular and enough flexible to be adapted to the upcoming plugin infraestructure, whichever form it takes.
* I don't know gmg enough to say, but maybe page areas must be defined. Anyway, page areas will have to exist when a plugin infaestructure arrives.

===Planning===

I would like to take this work, but take it really "long term" (before, I need to learn more about gmg and even Python). I would do it in a separate branch avoiding merge until there is something interesting and useful.

User:Manolinux

2011-12-07T19:04:00Z

Manolinux: /* Openx support */ why openx?

== Openx support ==

Here I am going to write all the stuff about a feature proposal.

===Rationale===

I hate ads.

But if we are going to have a server with thousands of users all day uploading pics, we need to have income.

Thinking federated, people who wish to run their web server may wish to do it for money.

===What is OpenX?===

Previously known as openAds, it is a software that manages and serves banners and other kind of ads. It is open source, of course (though there is a proprietary version too).

===How does it work?===

You need to have openx installed somewhere, or use openx hosted, a multiuser site. There, you define Advisers, Campaigns (inside Advisers) and banners (inside Campaigns) on one hand, and on the other hand you define Websites, and Zones in them. Then, you put some banners inside each zone.

Each zone has an invocation code, a piece of HTML you put where you want in your website. The invocation code makes the banner appear, and do the neccesary accounting.

===What do we do?===

====Input====

* OpenX instance address (i.e. http://myserver.com/openx)
* Zone number.
* Where in Media Goblin to put the code.

====Output====

* The HTML code in the desired area.

===Why OpenX?===

Because it is the better free advertising server I know of. If you know of another option, let me know.

===Architecture===

* For sure this must be a plugin. Any work done must be very modular and enough flexible to be adapted to the upcoming plugin infraestructure, whichever form it takes.
* I don't know gmg enough to say, but maybe page areas must be defined. Anyway, page areas will have to exist when a plugin infaestructure arrives.

===Planning===

I would like to take this work, but take it rather "long term". I would do it in a separate branch avoiding merge until there is something interesting and useful.

User:Manolinux

2011-12-07T18:54:23Z

Manolinux: /* Openx support */ finish openx support description (for now)

== Openx support ==

Here I am going to write all the stuff about a feature proposal.

===Rationale===

I hate ads.

But if we are going to have a server with thousands of users all day uploading pics, we need to have income.

Thinking federated, people who wish to run their web server may wish to do it for money.

===What is OpenX?===

Previously known as openAds, it is a software that manages and serves banners and other kind of ads. It is open source, of course (though there is a proprietary version too).

===How does it works?===

You need to have openx installed somewhere, or use openx hosted, a multiuser site. There, you define Advisers, Campaigns (inside Advisers) and banners (inside Campaigns) on one hand, and on the other hand you define Websites, and Zones in them. Then, you put some banners inside each zone.

Each zone has an invocation code, a piece of HTML you put where you want in your website. The invocation code makes the banner appear, and do the neccesary accounting.

===What do we do?===

====Input====

* OpenX instance address (i.e. http://myserver.com/openx)
* Zone number.
* Where in Media Goblin to put the code.

====Output====

* The HTML code in the desired area.

===Architecture===

* For sure this must be a plugin. Any work done must be very modular and enough flexible to be adapted to the upcoming plugin infraestructure, whichever form it takes.
* I don't know gmg enough to say, but maybe page areas must be defined. Anyway, page areas will have to exist when a plugin infaestructure arrives.

===Planning===

I would like to take this work, but take it rather "long term". I would do it in a separate branch avoiding merge until there is something interesting and useful.

User:Manolinux

2011-12-07T17:14:24Z

Manolinux: Detailing my feature idea, to be continued

== Openx support ==

===Rationale===

I hate ads.

But if we are going to have a server with thousands of users all day uploading pics, we need to have income.

Thinking federated, people who wish to run their web server may wish to do it for money.

===What is OpenX?===

Previously known as openAds, it is a software that manages and serves banners and other kind of ads. It is open source, of course (though there is a proprietary version too).

===How does it works?===

You need to have openx installed somewhere, or use openx hosted, a multiuser site. There, you define Advisers, Campaigns (inside Advisers) and banners (inside Campaigns) on one hand, and on the other hand you define Websites, and Zones in them. Then, you put some banners inside each zone.

Each zone has an invocation code, a piece of HTML you put where you want in your website. The invocation code makes the banner appear, and do the neccesary accounting.

Translations

2011-12-07T14:30:41Z

Manolinux: Fixing the stupid thing I said before :P

= For translators =

You can translate our tools at Transifex:

https://www.transifex.net/projects/p/mediagoblin/resource/mediagoblin/

To translate, click on your language on the list, and then click on "Translate now". By default, Transifex only shows you strings that currently have no translation. There is a checkbox to enable display of the translated strings, in case you can fix any of them.

We are currently using no translation teams, so you can just edit the strings (but try to be nice and consistent with the current translation).

Note: please don't translate the words "MediaGoblin" or "GNU" into your native language. Those words should be retained as-is for branding reasons. :)

== Notes for some language teams ==
=== German ===

Interessante Hinweise zur Übersetzung finden sich bei Gnome:
* http://live.gnome.org/de/UebersetzungsRichtlinien

In Abweichung von diesen Richtlinien wird momentan "du" für die Anrede benutzt.

=== Spanish ===

Se está adoptando la siguiente convención para la traducción al español. Si crees que alguna traducción se puede mejorar, sugiérela en la página de de discusión de este artículo.

{|
!Inglés
!Español
!Comentarios
|-
|you
|tú
|(segunda persona del singular, expresión informal)
|-
|media
|contenido
|-
|slug
|ficha
|}

==Fixing translations from transifex==

= For developers =
== Marking strings for translation ==
=== In Jinja2 ===

See: http://jinja.pocoo.org/docs/templates/#i18n

Mostly like Django template i18n support, if you have any experience with that.

=== In python code ===

Usually, like this:

<pre>
from mediagoblin.util import pass_to_ugettext as _

def some_func(something):
return _(u'This string would tooootally be translatable now.')
</pre>

Except, in form modules we don't actually want to translate things because for various reasons that doesn't work, so we do the translation call template-side. So write the module to use the fake ugettext passthrough (which doesn't do any translation but still wraps things in _() so that Babel will know to extract these strings):

<pre>
from mediagoblin.util import fake_ugettext_passthrough as _

class FunkyMonkeyForm(wtforms.Form):
funky = wtforms.TextAreaField(
_('Funkiness description'))
</pre>

== Extracting translations ==

If you run buildout it should create a script called 'pybabel'. Use it to extract translations like so:

<pre>
./bin/pybabel extract -F babel.ini -o mediagoblin/i18n/en/LC_MESSAGES/mediagoblin.po .
</pre>

== Compiling translations ==

<pre>
./bin/pybabel compile -D mediagoblin -d mediagoblin/i18n/
</pre>

== Pulling translations from Transifex ==

Unfortunately until the next release of transifex-client which has been patched to have proper entry points, you have to run transifex-client from a virtualenv or from site-packages. But assuming that's done, pulling translations is easy:

<pre>
tx pull -a
</pre>

== Pushing new translations to Transifex ==

<pre>
tx push -s
</pre>

= Troubleshooting =

Got an error on Transifex like:

"Translation must start with a newline (\n)"?

The problem here is when we have something like:

{% trans register_url=request.urlgen('mediagoblin.auth.register') %}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{% endtrans %}

instead of:

{% trans register_url=request.urlgen('mediagoblin.auth.register') -%}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{%- endtrans %}

The distinction might not be obvious... look for the %} versus -%} and {% versus {%- on the first and last lines. The thing about this is this tells Jinja2 to strip the whitespace. Without that, Transifex sees that there's a "\n" on the first line of the original but not on the future translation, and gets upset.

If this happens the template should be updated to strip whitespace and translations should be pushed to transifex.

Translations

2011-12-07T00:07:20Z

Manolinux: How to update translations in transifex

= For translators =

You can translate our tools at Transifex:

https://www.transifex.net/projects/p/mediagoblin/resource/mediagoblin/

Note: please don't translate the words "MediaGoblin" or "GNU" into your native language. Those words should be retained as-is for branding reasons. :)

We are currently using no translation teams, so you can just edit the strings (but try to be nice and consistent with the current translation).

== Notes for some language teams ==
=== German ===

Interessante Hinweise zur Übersetzung finden sich bei Gnome:
* http://live.gnome.org/de/UebersetzungsRichtlinien

In Abweichung von diesen Richtlinien wird momentan "du" für die Anrede benutzt.

=== Spanish ===

Se está adoptando la siguiente convención para la traducción al español. Si crees que alguna traducción se puede mejorar, sugiérela en la página de de discusión de este artículo.

{|
!Inglés
!Español
!Comentarios
|-
|you
|tú
|(segunda persona del singular, expresión informal)
|-
|media
|contenido
|-
|slug
|ficha
|}

==Fixing translations from transifex==

Transifex only show you strings that currently have no translation.

If you want to fix an existing translation, you can download a .po file with the "Download for viewing" or "Download for tranlation" link, then edit the .po file with an appropiate tool (i.e. Poedit or emacs po-mode) and then upload the resulting file with the "Upload file" button.

= For developers =
== Marking strings for translation ==
=== In Jinja2 ===

See: http://jinja.pocoo.org/docs/templates/#i18n

Mostly like Django template i18n support, if you have any experience with that.

=== In python code ===

Usually, like this:

<pre>
from mediagoblin.util import pass_to_ugettext as _

def some_func(something):
return _(u'This string would tooootally be translatable now.')
</pre>

Except, in form modules we don't actually want to translate things because for various reasons that doesn't work, so we do the translation call template-side. So write the module to use the fake ugettext passthrough (which doesn't do any translation but still wraps things in _() so that Babel will know to extract these strings):

<pre>
from mediagoblin.util import fake_ugettext_passthrough as _

class FunkyMonkeyForm(wtforms.Form):
funky = wtforms.TextAreaField(
_('Funkiness description'))
</pre>

== Extracting translations ==

If you run buildout it should create a script called 'pybabel'. Use it to extract translations like so:

<pre>
./bin/pybabel extract -F babel.ini -o mediagoblin/i18n/en/LC_MESSAGES/mediagoblin.po .
</pre>

== Compiling translations ==

<pre>
./bin/pybabel compile -D mediagoblin -d mediagoblin/i18n/
</pre>

== Pulling translations from Transifex ==

Unfortunately until the next release of transifex-client which has been patched to have proper entry points, you have to run transifex-client from a virtualenv or from site-packages. But assuming that's done, pulling translations is easy:

<pre>
tx pull -a
</pre>

== Pushing new translations to Transifex ==

<pre>
tx push -s
</pre>

= Troubleshooting =

Got an error on Transifex like:

"Translation must start with a newline (\n)"?

The problem here is when we have something like:

{% trans register_url=request.urlgen('mediagoblin.auth.register') %}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{% endtrans %}

instead of:

{% trans register_url=request.urlgen('mediagoblin.auth.register') -%}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{%- endtrans %}

The distinction might not be obvious... look for the %} versus -%} and {% versus {%- on the first and last lines. The thing about this is this tells Jinja2 to strip the whitespace. Without that, Transifex sees that there's a "\n" on the first line of the original but not on the future translation, and gets upset.

If this happens the template should be updated to strip whitespace and translations should be pushed to transifex.

Translations

2011-12-04T16:38:43Z

Manolinux: Remove what is said about translation teams

= For translators =

You can translate our tools at Transifex:

https://www.transifex.net/projects/p/mediagoblin/resource/mediagoblin/

Note: please don't translate the words "MediaGoblin" or "GNU" into your native language. Those words should be retained as-is for branding reasons. :)

We are currently using no translation teams, so you can just edit the strings (but try to be nice and consistent with the current translation).

== Notes for some language teams ==
=== German ===

Interessante Hinweise zur Übersetzung finden sich bei Gnome:
* http://live.gnome.org/de/UebersetzungsRichtlinien

In Abweichung von diesen Richtlinien wird momentan "du" für die Anrede benutzt.

=== Spanish ===

Se está adoptando la siguiente convención para la traducción al español. Si crees que alguna traducción se puede mejorar, sugiérela en la página de de discusión de este artículo.

{|
!Inglés
!Español
!Comentarios
|-
|you
|tú
|(segunda persona del singular, expresión informal)
|-
|media
|contenido
|-
|slug
|ficha
|}

= For developers =
== Marking strings for translation ==
=== In Jinja2 ===

See: http://jinja.pocoo.org/docs/templates/#i18n

Mostly like Django template i18n support, if you have any experience with that.

=== In python code ===

Usually, like this:

<pre>
from mediagoblin.util import pass_to_ugettext as _

def some_func(something):
return _(u'This string would tooootally be translatable now.')
</pre>

Except, in form modules we don't actually want to translate things because for various reasons that doesn't work, so we do the translation call template-side. So write the module to use the fake ugettext passthrough (which doesn't do any translation but still wraps things in _() so that Babel will know to extract these strings):

<pre>
from mediagoblin.util import fake_ugettext_passthrough as _

class FunkyMonkeyForm(wtforms.Form):
funky = wtforms.TextAreaField(
_('Funkiness description'))
</pre>

== Extracting translations ==

If you run buildout it should create a script called 'pybabel'. Use it to extract translations like so:

<pre>
./bin/pybabel extract -F babel.ini -o mediagoblin/i18n/en/LC_MESSAGES/mediagoblin.po .
</pre>

== Compiling translations ==

<pre>
./bin/pybabel compile -D mediagoblin -d mediagoblin/i18n/
</pre>

== Pulling translations from Transifex ==

Unfortunately until the next release of transifex-client which has been patched to have proper entry points, you have to run transifex-client from a virtualenv or from site-packages. But assuming that's done, pulling translations is easy:

<pre>
tx pull -a
</pre>

== Pushing new translations to Transifex ==

<pre>
tx push -s
</pre>

= Troubleshooting =

Got an error on Transifex like:

"Translation must start with a newline (\n)"?

The problem here is when we have something like:

{% trans register_url=request.urlgen('mediagoblin.auth.register') %}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{% endtrans %}

instead of:

{% trans register_url=request.urlgen('mediagoblin.auth.register') -%}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{%- endtrans %}

The distinction might not be obvious... look for the %} versus -%} and {% versus {%- on the first and last lines. The thing about this is this tells Jinja2 to strip the whitespace. Without that, Transifex sees that there's a "\n" on the first line of the original but not on the future translation, and gets upset.

If this happens the template should be updated to strip whitespace and translations should be pushed to transifex.