Skip to content
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.

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

move all themable strings into lib/defaults.php #3791

Closed
jancborchardt opened this issue Jun 19, 2013 · 21 comments
Closed

move all themable strings into lib/defaults.php #3791

jancborchardt opened this issue Jun 19, 2013 · 21 comments

Comments

@jancborchardt
Copy link
Member

There are some strings already in https://github.com/owncloud/core/blob/master/lib/defaults.php

We should put the other ones in there too, most notably the big footers as well as the logo-claim text (are there any others?). All themable strings should be in that file.

cc @schiesbn @butonic

@ghost ghost assigned schiessle Jun 19, 2013
@MTRichards
Copy link
Contributor

There are a few leftovers too, not sure if these are included above or not:

WebDAV http://192.168.1.73/owncloud/remote.php/webdav/
"Use this address to connect to your ownCloud in your file manager"

@MTRichards
Copy link
Contributor

Plus, of course, apps that have strings.

@schiessle
Copy link
Contributor

Just be be sure, default.php wasn't meant for all strings that somewhere appear in ownCloud. The idea of default.php was to have a single place for standard text phrases which appear on multiple places and which might differ between the community and enterprise addition to make it easy to change them. A typical example is the footer.

We should put the other ones in there too, most notably the big footers

I also saw that we use different footers on different pages. Maybe it would be a good idea to harmonize them. I think one footer should be enough, or at most two (if it is really needed), a long version and a short version.

@jancborchardt
Copy link
Member Author

@schiesbn yeah, but I think it’s a good idea to put all the themable stuff there anyway. Or should we totally not do it? It’s your call. :)
Regarding footers, don’t we only have 2 different ones? The short one (log in & installation pages), and the long one (Personal and Admin settings).

@schiessle
Copy link
Contributor

Themable stuff is OK. This should be mostly stuff which is used on different places and which is different between the community and the enterprise edition. I just want to avoid to have a large list of strings in default.php where it is hard to know which string is used in which context. For example I don't think it makes sense to add strings like "Use this address to connect to your ownCloud in your file manager".

I will have another look regarding the footers, thought that I saw more than two different.

I would suggest to just start to add themable strings and decide one by one.

@MTRichards
Copy link
Contributor

The problem is the word ownCloud in that sentence "Use this address to connect to your ownCloud in your file manager". It is not possible to change that name without a manual edit, which means ... well, lets just say I get a lot of complaints.

We really need a string in that spot that we can use as the "name" of the ownCloud instance. Maybe I want to call it "mtCloud", there should be a place I can define that name, which would pull it for places where that term is used.

@schiessle
Copy link
Contributor

Maybe we should try to avoid "ownCloud" in such sentences, for example we could write instead "Use this address to access your files in your file manager". This would be even more accurate, since ownCloud can be much more than your files.

Of course we could try to replace "ownCloud" everywhere with OC_Default::getName(); but I'm not sure if this will work out in every area, especially for non-core apps. Therefore I would rather try to avoid "ownCloud" in areas where it is not really needed, like the example above. For everything else, like page titles we already have the name in defaults.php.

@MTRichards
Copy link
Contributor

Agreed! Can you do that easily? That would be great.

@jancborchardt
Copy link
Member Author

Good point @MTRichards. And I agree with @schiesbn that we should avoid the term »ownCloud« in the interface. Let me search and submit a pull request for some wording fixes.

@MTRichards
Copy link
Contributor

Looked into it, here are a few more areas that we need to look at getting ownCloud

Most imporant ones I think you have covered, except perhaps the email templates:

  • Footer in Personal Settings: © 2013 ownCloud Inc. – Your Cloud, Your Data, Your Way!
  • String in personal settings: Use this address to connect to your ownCloud in your file manager
  • Footer in login Page
  • Email templates: apps/file_sharing/templates/public.php, owncloud/core/lib/mail.php and core/templates/layout.guest.php

Less important, as they are in the Admin Panel, but still good to change in the apps:

  • Export Users: (several): Export this ownCloud instance; This will create a compressed file that contains the data of this owncloud instance. ownCloud instance (user data and database); ownCloud system files
  • Cron Selection: Use systems cron service. Call the cron.php file in the owncloud folder via a system cronjob once a minute.
  • Security: Enforce HTTPS; Enforces the clients to connect to ownCloud via an encrypted connection. Please connect to this ownCloud instance via HTTPS to enable or disable the SSL enforcement.
  • WebDAV Authentication: ownCloud will send the user credentials to this URL. This plugin checks the response and will interpret the HTTP statuscodes 401 and 403 as invalid credentials, and all other responses as valid credentials.
  • LDAP: Expert tab with lots of ownCloud instances.
  • Admin page footer: ownCloud Inc.

@msrex
Copy link

msrex commented Jun 26, 2013

@schiesbn - ping

@schiessle
Copy link
Contributor

Footers in personal settings, admin settings and login page are already fixed. Or do you want something different from "© 2013 ownCloud Inc. – Your Cloud, Your Data, Your Way!" for the enterprise edition?

Regarding email templates, @jancborchardt merged some stuff to master (#3683) but didn't backported it to stable5. Was it by intention? Do you want to backport it to stable5 first before I adjust the templates for different themes?

@jancborchardt
Copy link
Member Author

@schiesbn the mail template changes are too substantial to be safely backported to stable5 I think. Too much risk for errors. @DeepDiver1975?

Can you make the getEdition check in master for that? And can you check out #3827 as well, for the doc addresses?

I will check out the other strings @MTRichards mentioned and try to reword them without »ownCloud« in them.

@MTRichards
Copy link
Contributor

The footers are ok for EE, the issue is that these strings are theme able from a single location so we don't "discover" strings buried somewhere.

We should try hard to back port to stable 5 if we can, but only if we can without breaking everything.

This was referenced Jun 26, 2013
@schiessle
Copy link
Contributor

I just merged the branch with the updated defaults.php and updated footer for both web and mail.

Regarding the doc links, I will add this directly to Jans branch.

So from my side this issue is solved. @jancborchardt did you already checked the other strings? You can close this issue if the strings are OK.

@schiessle
Copy link
Contributor

@jancborchardt anything new about the remaining strings?

schiessle pushed a commit that referenced this issue Jul 8, 2013
Squashed commit of the following:

commit eed4b49
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 8 10:03:23 2013 +0200

    initialize OC_Defaults only once

commit bf6f07c
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 8 10:02:48 2013 +0200

    link to doc in error messages

commit ea61ee6
Merge: e41af3d 3c1308f
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Thu Jul 4 11:10:56 2013 +0200

    Merge branch 'master' into better-messages

commit e41af3d
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Thu Jul 4 11:10:41 2013 +0200

    move to non-static defaults.php

commit 9e4258b
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Tue Jul 2 10:32:13 2013 +0200

    no sprintf here, lets t() handle it

commit fe1df34
Merge: d8f6859 cb5811b
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 1 11:13:38 2013 +0200

    Merge branch 'master' into better-messages

commit d8f6859
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 1 11:10:57 2013 +0200

    use document base url from defaults.php

commit 6c54037
Merge: bea6b1c 7b0e3e6
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 1 11:00:15 2013 +0200

    Merge branch 'master' into better-messages

commit bea6b1c
Author: Jan-Christoph Borchardt <hey@jancborchardt.net>
Date:   Mon Jun 24 16:21:12 2013 +0200

    link to docs in WebDAV message, ref #3791

commit 3119b36
Author: Jan-Christoph Borchardt <hey@jancborchardt.net>
Date:   Mon Jun 24 16:10:21 2013 +0200

    link to docs in error messages, fix #3819
schiessle pushed a commit that referenced this issue Jul 8, 2013
Squashed commit of the following:

commit eed4b49
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 8 10:03:23 2013 +0200

    initialize OC_Defaults only once

commit bf6f07c
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 8 10:02:48 2013 +0200

    link to doc in error messages

commit ea61ee6
Merge: e41af3d 3c1308f
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Thu Jul 4 11:10:56 2013 +0200

    Merge branch 'master' into better-messages

commit e41af3d
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Thu Jul 4 11:10:41 2013 +0200

    move to non-static defaults.php

commit 9e4258b
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Tue Jul 2 10:32:13 2013 +0200

    no sprintf here, lets t() handle it

commit fe1df34
Merge: d8f6859 cb5811b
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 1 11:13:38 2013 +0200

    Merge branch 'master' into better-messages

commit d8f6859
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 1 11:10:57 2013 +0200

    use document base url from defaults.php

commit 6c54037
Merge: bea6b1c 7b0e3e6
Author: Björn Schießle <schiessle@owncloud.com>
Date:   Mon Jul 1 11:00:15 2013 +0200

    Merge branch 'master' into better-messages

commit bea6b1c
Author: Jan-Christoph Borchardt <hey@jancborchardt.net>
Date:   Mon Jun 24 16:21:12 2013 +0200

    link to docs in WebDAV message, ref #3791

commit 3119b36
Author: Jan-Christoph Borchardt <hey@jancborchardt.net>
Date:   Mon Jun 24 16:10:21 2013 +0200

    link to docs in error messages, fix #3819

Conflicts:

	lib/config.php
@jancborchardt
Copy link
Member Author

@schiesbn I checked out the remaining strings @MTRichards mentioned. Apart from the ones I already changed, they would sound weird if we try to avoid the word »ownCloud« there.

What we could do is replace all those instances with a variable (different from defaultEntity and defaultName) which for both community and Enterprise returns »ownCloud«. Like a defaultOwnCloud or something like that – because in those sentences, »ownCloud Inc.« does not make sense and »ownCloud Enterprise Edition« is way too long. There companies can set what they want their software to be referred as in short.

But then again, all those strings are in admin areas only anyway, so I think it might be overkill. You decide @schiesbn @MTRichards.

@MTRichards
Copy link
Contributor

Seems like overkill, but I know that some folks really want it branded their own solution. So, lets close this for now but keep the enhancement request open for the string in a later version.

@te-online
Copy link

Very good work! Now someone should update http://owncloud.org/theming/ and other documentation files, explaining how to change the default ownCloud name.

@schiessle
Copy link
Contributor

@jancborchardt can we close this issue? From my side we are done or is there anything still open?

@jancborchardt
Copy link
Member Author

Yep this is done. Yeeeha!

@lock lock bot locked as resolved and limited conversation to collaborators Aug 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants