I2P_Developers/i2p.www
3
0
Fork 5
Code Issues 27 Pull Requests Actions 1 Packages Projects Releases Wiki Activity

- newtranslators (new)

Browse Source 
- tunnel-alt-creation fixes
This commit is contained in:
zzz
2010-08-04 22:10:12 +00:00
parent 5e1cff3fdc
commit 47c0fc4034
5 changed files with 197 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
www.i2p2/pages/getinvolved.html
View File

@ -37,6 +37,9 @@ Check for open tickets on <a href="http://trac.i2p2.i2p/">Trac</a>
or the TODO list on <a href="http://zzz.i2p/">zzz.i2p</a> for
some ideas on where to start.
See the <a href="newdevelopers.html">new developer's guide</a> for details.
<li><b>Translation</b> -
Help translate the website and the software into your language.
See the <a href="newtranslators.html">new translator's guide</a> for details.
<li><b>Analysis</b> -
Study or test the code to look for vulnerabilities.
Both anonymity vulnerabilities from the various

17
www.i2p2/pages/newdevelopers.html
View File

@ -1,7 +1,8 @@
{% extends "_layout.html" %}
{% block title %}New Developer's Guide{% endblock %}
{% block content %}
Here's a very quick guide to getting started.
Here's a very quick guide to getting started
on contributing to the website or the software, including translations.
<ul>
<li>
Not quite ready for coding?
@ -32,6 +33,10 @@ Non-anonymous access: mtn.i2p2.de:4691 or mtn.i2p-projekt.de:4691
<br>
Website branch: use i2p.www instead of i2p.i2p.
<br>
The initial pull may take several hours using the tunnel.
If it fails after a partial pull, simply rerun it, it will start where it left off.
If you are in a hurry, use the non-anonymous access.
<br>
Full list of branches: see <a href="http://stats.i2p/cgi-bin/viewmtn/">viewmtn</a>.
<br>
Long version: see the <a href="monotone.html">monotone page</a>.
@ -62,7 +67,7 @@ Say hi to the developers on #i2p
<li>
See the bottom of <a href="licenses.html">licenses.html</a> for
commit privilege requirements.
commit privilege requirements. (Not required for website)
<li>
Short version of how to generate and use keys if you plan to commit:
@ -70,12 +75,16 @@ Short version of how to generate and use keys if you plan to commit:
<li>mtn genkey yourname-transport@mail.i2p <i>(use an empty passphrase)</i>
<li>mtn genkey yourname@mail.i2p <i>(enter a passphrase)</i>
<li>mtn pubkey yourname-transport@mail.i2p <i>(<a href="mailto:mtn@welterde.de">send</a> this to a mtn repo operator to get push privileges)</i>
<li>mtn pubkey yourname@mail.i2p <i>(send this to a release manager to get commit privileges)</i>
<li>mtn pubkey yourname@mail.i2p <i>(send this to <a href="mailto:zzz@mail.i2p">a release manager</a> to get commit privileges - not required for website)</i>
<li>mtn ci -k yourname@mail.i2p <i>(check in with this key)</i>
<li>mtn sync -k yourname-transport@mail.i2p <i>(push with this key)</i>
</ul>
Long version: see the <a href="monotone.html">monotone page</a>.
</ul>
<p>
Website and router console translators: See the <a href="newtranslators.html">New Translators Page</a>
for next steps.
{% endblock %}

5
www.i2p2/pages/newdevelopers_de.html
View File

@ -65,4 +65,9 @@ Schaue in den unteren Teil der <a href="licenses_de.html">Lizenzen</a> Seite
um Rechte zum Einpflegen von Quelltext zu bekommen.
</ul>
<p>
Website and router console translators: See the <a href="newtranslators.html">New Translators Page</a>
for next steps.
{% endblock %}

173
www.i2p2/pages/newtranslators.html Normal file
View File

@ -0,0 +1,173 @@
{% extends "_layout.html" %}
{% block title %}New Translator's Guide{% endblock %}
{% block content %}
Here's a very quick guide to getting started.
<h2>How to Translate the Website</h2>
<ol>
<li>
Preparation
<ol>
<li>
Come to #i2p-dev on irc and talk to people.
Claim the language -
To make sure other coworkers don't bump onto the files you are working on,
please update the translation status on <a href="http://ugha.i2p/i2pTranslation">this wiki page</a> .
<li>
Follow the <a href="newdevelopers.html">new developer's guide</a>,
Including the installation of monotone,
checking out i2p.www branch, and generate your own monotone keys.
It is not required that you sign a dev agreement.
</ol>
<li>
Create files:
If the file for your language does not exist yet, copy another language file to a new file foo_xx.bar for your language.
Then 'mtn add' the file.
Also add a _layout_xx.html for your language xx.
Add a flag image file for the menu (copy from the router).
<li>
Edit files:
Edit _layout_xx.html and _menu.html, and other files.
Edit the files with any text editor.
Be sure not to use an editor in HTML mode that reformats everything.
<li>
Check in:
mtn pull, mtn update. Then check in by "mtn ci -k yourname@mail.i2p file1 file2 ..."
This collects the diff info of your changed file into your local repo. Then "mtn sync mtn.i2p2.de -k yourname-transport@mail.i2p i2p.i2p".
This synchronizes your local repo with the repo on the target machine.
<li>
Repeat. Check in often. Don't wait until it is perfect.
</ol>
<h2>How to Translate the Router Console</h2>
<ol>
<li>
Preparation
<ol>
<li>
Come to #i2p-dev on irc and talk to people.
Claim the language -
To make sure other coworkers don't bump onto the files you are working on,
please update the translation status on <a href="http://ugha.i2p/i2pTranslation">this wiki page</a> .
<li>
Follow the <a href="newdevelopers.html">new developer's guide</a>,
Including the installation of monotone and the gettext tools,
checking out i2p.i2p branch, and generate your own monotone keys.
<li>
Generate your own gpg key and sign the dev agreement.
</ol>
<li>
Before starting a console translation, better help translate some i2p webpages first.
At least an i2p homepage in your language would be great. This will also help you learn monotone.
<li>
What to translate:
There are about 15 files in the i2p.i2p branch that needs translation:
<ol>
<li>
installer/resources/readme/readme_xx.html
<li>
apps/routerconsole/local/messages_xx.po
<li>
installer/resources/proxy/*_xx.ht
<li>
apps/routerconsole/jsp/help_xx.jsp
<li>
installer/resources/eepsite.help/help/index_xx.html
<li>
apps/i2ptunnel/locale/messages_xx.po
<li>
apps/i2psnark/locale/messages_xx.po
<li>
apps/susidns/locale/messages_xx.po
</ol>
Where xx is your language code like fr/de/ch/zh/...
There may be or may not be files with your lang code. If not, you can create your own. by copying and renaming other language files you know with your own lang code.
<li>
Create files:
If the file for your language does not exist yet, copy another language file to a new file foo_xx.bar for your language.
Then 'mtn add' the file.
After creating a .po file, edit the headers. Then run 'ant distclean poupdate'.
<li>
Start to work:
Edit the HTML files with any text editor.
Be sure not to use an editor in HTML mode that reformats everything.
To work with .po files efficiently, you may wish to use <a href="http://www.poedit.net/download.php">POEdit</a>
<li>
Check in:
mtn pull, mtn update. Then check in by "mtn ci -k yourname@mail.i2p file1 file2 ..."
This collects the diff info of your changed file into your local repo. Then "mtn sync mtn.i2p2.de -k yourname-transport@mail.i2p i2p.i2p".
This synchronizes your local repo with the repo on the target machine.
<li>
Repeat. Check in often. Don't wait until it is perfect.
</ol>
As you see it's simple.
If you have questions about the meaning of the terms in the console, ask in #i2p-dev on IRC.
<h2>FAQ</h2>
<b>Q: Why do I have to install monotone, Java, jsp, learn about .po files and html, etc.? Why can't I just do a translation and email it to you?</b>
<p>
<b>Answer: Several reasons:</b>
<ul>
<li>
We don't have anybody who has time to accept manual contributions and submit them to our source control system on your behalf. Even if we did, it doesn't scale.
<li>
Maybe you are thinking translation is a one-step process. It isn't. You can't do it all at once. You will make mistakes. You need to test it and tweak it to make it look right [i]before[/i] you submit it. Developers will update or add to the English text, thus requiring a translation update.
<li>
Having translators use a source control system directly provides authentication and accountablility - we know who is doing what, and we can track changes, and revert them if necessary.
<li>
.po files are not difficult. If you don't want to work directly with them, we recommend 'poedit'.
<li>
HTML files are not difficult. Just ignore the html stuff and translate the text.
<li>
Installing and using monotone is not that difficult. Several of the translators and other contributors to I2P are non-programmers, and they use monotone regularly. Monotone is simply a source control system, it is not about "coding".
<li>
Our items to translate are not "documents". They are html files and po files, with a specific format and character encoding (UTF-8) that must be maintained, and not corrupted by email programs or other methods of transfer.
<li>
We looked at 'pootle' as a front-end for translators. It didn't work well, needed an administrator, and a pootle-based process would suffer from a number of the above flaws.
</ul>
<b>In summary:</b>
Yes, we know it is somewhat of a hurdle to get started. It's really the only possible way we can do it. Give it a try, it really isn't that hard.
<h2>More Information</h2>
The #i2p-dev channel on IRC, or the <a href="http://zzz.i2p/forums/14">translation forum on zzz.i2p</a>.
{% endblock %}

4
www.i2p2/pages/tunnel-alt-creation.html
View File

@ -38,7 +38,7 @@ In the current network, most tunnels are 2 or 3 hops long.
The current implementation uses a 5-record VTBM to build tunnels of 4 hops or less,
and the 8-record TBM for longer tunnels.
The 5-record VTBM (which fits in 3 1KB tunnel messaages) reduces network traffic
and increases build sucess rate, because larger messages are less likely to be dropped.
and increases build sucess rate, because smaller messages are less likely to be dropped.
<p>
The reply message must be the same type and length as the build message.
@ -255,6 +255,8 @@ attack</a>
<li>
<a href="http://prisms.cs.umass.edu/brian/pubs/wright.tissec.2008.pdf">2008
update</a>
<li>
<a href="http://www-users.cs.umn.edu/~hopper/hashing_it_out.pdf">Hashing it out in Public</a>
</ul>
<h2 id="future">Future Work</h2>