Skip to content

fix readme and internationalize #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stuartf wants to merge 5 commits into
base: master
Choose a base branch
from
Open

fix readme and internationalize #12

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
024846d
Fix setup instructions
stuartf Jun 10, 2015
aae5688
we don't need to overwrite the template, we can just i18n it
stuartf Jun 10, 2015
e1be8fd
add crowdin sync script
stuartf Jun 16, 2015
dba11a4
Upload keys and existing translations before downloading
stuartf Jun 18, 2015
03f693c
remove config.json and pass key through argv
stuartf Jun 26, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,22 @@ It provides a way to do:

You will need to set the `requireSession` and `editOnly` values to `true` in etherpad's `settings.json` file.

It's recommended to also add in a `sessionKey`. This can be any random value, but should be the same across the cluster.

To get it working, change the `dbType` to `cassandra` and enter the following `dbSettings`:
Copy link

@nicolaasmatthijs nicolaasmatthijs Jun 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this no longer recommended?

Copy link
Contributor

@simong simong Jun 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's now recommended to have a SESSIONKEY.txt file

Copy link
Author

@stuartf stuartf Jun 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I had it in the settings.json I got this deprecation warning:

[2015-06-10 09:21:46.175] [WARN] console - Declaring the sessionKey in the settings.json is deprecated. This value is auto-generated now. Please remove the setting from the file.


```javascript
"dbSettings" : {
"hosts": ["127.0.0.1:9160"],
"keyspace": "oae",
"cfName": "Etherpad",
"columnFamily": "Etherpad",
"user": "",
"pass": "",
"timeout": 3000,
"replication": 1,
"strategyClass": "SimpleStrategy"
"strategyClass": "SimpleStrategy",
"clientOptions": {
"keyspace": "oae",
"contactPoints": ["127.0.0.1"]
}
}
```

Expand All @@ -46,7 +48,7 @@ You should have the following structure (assuming you have etherpad at `/opt/eth
* index.json
* ep.json

Copy or symlink the `static/css/padd.css` file in this plugin to `your-etherpad-directory/src/static/custom/pad.css`. This file will skin the etherpad chrome. In order to have custom titles for headers, copy or symlink the `static/templates/editbarButtons.ejs` file in this plugin to `your-etherpad-directory/node_modules/ep_headings/templates/editbarButtons.ejs`.
Copy or symlink the `static/css/padd.css` file in this plugin to `your-etherpad-directory/src/static/custom/pad.css`. This file will skin the etherpad chrome.

In order to use the OAE toolbar, the etherpad `settings.json` file needs to be updated to reflect the following changes:

Expand Down
13 changes: 13 additions & 0 deletions locales/de.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"ep_headings.code" : "Code",
"ep_headings.h1" : "Titel 1",
"ep_headings.h2" : "Titel 2",
"ep_headings.h3" : "Titel 3",
"ep_headings.h4" : "Titel 4",
"ep_headings.h5" : "Titel 5",
"ep_headings.h6" : "Titel 6",
"ep_headings.normal" : "Normal",
"ep_headings.style" : "Stil",
"ep_oae.download": "Download",
"ep_oae.togglecolors": "Schaltet die Urheber Farben"
}
13 changes: 13 additions & 0 deletions locales/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
Copy link
Contributor

@simong simong Jun 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stuartf did you have a way in mind to sync this with crowdin? It would be preferential if the i18n keys could be part of the same project as 3akai-ux. I believe this could be done by adding a fourth location in 3akai-ux/tools/crowdin/crowdin.template that points to ep_oae's locales/en.json file.

Copy link
Author

@stuartf stuartf Jun 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like those paths are relative to 3akai-ux though, and this source doesn't end up in there.

"ep_headings.code": "Code",
"ep_headings.normal": "Normal",
"ep_headings.style": "Style",
"ep_headings.h1": "Title 1",
"ep_headings.h2": "Title 2",
"ep_headings.h3": "Title 3",
"ep_headings.h4": "Title 4",
"ep_headings.h5": "Title 5",
"ep_headings.h6": "Title 6",
"ep_oae.download": "Download",
"ep_oae.togglecolors": "Toggle authorship colors"
}
4 changes: 2 additions & 2 deletions static/js/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ exports.postAceInit = function (hook_name, args, cb) {
$('.buttonicon-showusers').removeClass('buttonicon-showusers').addClass('buttonicon-oae buttonicon-user');

// Add extra buttons to the toolbar *after* the style select
$('ul.menu_left').append('<li data-type="button" data-key="colorcheck"><a class="grouped-left" data-l10n-id="pad.settings.colorcheck" title="Toggle authorship colors"><button class="buttonicon buttonicon-oae buttonicon-clearauthorship"></button></a></li>');
$('ul.menu_left').append('<li data-type="button" data-key="download"><a target="_blank" href="' + window.location.pathname + '/export/pdf" class="grouped-right" data-l10n-id="pad.importExport.exportpdf" title="Download"><button class="buttonicon buttonicon-oae buttonicon-download"></button></a></li>');
$('ul.menu_left').append('<li data-type="button" data-key="colorcheck"><a class="grouped-left" data-l10n-id="pad.settings.colorcheck" title="' + window._('ep_oae.togglecolors') + '"><button class="buttonicon buttonicon-oae buttonicon-clearauthorship"></button></a></li>');
$('ul.menu_left').append('<li data-type="button" data-key="download"><a target="_blank" href="' + window.location.pathname + '/export/pdf" class="grouped-right" data-l10n-id="pad.importExport.exportpdf" title="' + window._('ep_oae.download') + '"><button class="buttonicon buttonicon-oae buttonicon-download"></button></a></li>');

// Show the toolbar
$('.toolbar').animate({
Expand Down
14 changes: 0 additions & 14 deletions static/templates/editbarButtons.ejs
View file
Open in desktop

This file was deleted.