MozillaWiki

SeaMonkey:Suite Directory Layout: Difference between revisions

Page Discussion

SeaMonkey:Suite Directory Layout (view source)

Revision as of 20:02, 7 February 2007

3,371 bytes added ,  7 February 2007
m
→‎Proposed Mailnews l10n layout: spelling
 
(12 intermediate revisions by 3 users not shown)
Line 7: Line 7:


* organize things according to function, not according to "how it's built"
* organize things according to function, not according to "how it's built"
* organize locales in a way that works well for "source L10n" (even if that might not fit with the above rule)
* organize locales in a way that works well for "source L10n" (even if that might not fit with the above rule), i.e. '''all''' localizable stuff goes into mozilla/suite/locales/en-US/ directories (other locales will have the same structure of files under l10n/<ab-CD>/suite/ in the future)
* themes are kept in suite/themes/<name>/
* use general descriptive names for the components' directories, not "brand" names ("common" instead of "communicator", "browser" instead of "navigator", "mailnews" instead of "messenger", etc.)
* use general descriptive names for the components' directories, not "brand" names ("common" instead of "communicator", "browser" instead of "navigator", "mailnews" instead of "messenger", etc.)


== Example ==
== Example ==


''main repository:''
mozilla/
*suite/
*suite/
**branding/ - ''stuff used for branding the application (mainly artwork)''
**app/ - ''application startup''
**branding/ - ''common place for application branding (mainly artwork)''
**browser/
**browser/
**common/
**common/
***prefs/
***pref/
**installer/
**installer/
**locales/
***en-US/
****chrome/
*****[branding|browser|common|mailnews|...]/
****installer/
**mailnews/
**mailnews/
**themes/
***classic/
****[browser|common|mailnews|...]/
***modern/
****[browser|common|mailnews|...]/
''L10n repository:''
l10n/
*<ab-CD>/
**suite/
***chrome/
****[branding|browser|common|mailnews|...]/
***installer/
== Proposed Mailnews l10n layout ==
''Thunderbird's Layout:''
l10n/
*<ab-CD>/
**mail/
***chrome/
****messenger/
*****addressbook/
*****messengercompose/
*****migration/
*****preferences/
****messenger-mapi/
****messenger-newsblog/
****messenger-offline/
****messenger-region/
****messenger-smime/
''Proposed SeaMonkey Layout:''
l10n/
*<ab-CD>/
**suite/
***chrome/
****messenger/
*****addressbook/
*****messengercompose/
*****pref/
****messenger-mapi/
****messenger-region/
****messenger-smime/
Note: migration is elsewhere in the SeaMonkey tree.
Note: preferences renamed to pref to match suite/chrome/common/pref/
''Where to move directories to/from:''
Note that * means the files need to move to more than one directory.
To mozilla/suite/locales/en-US/chrome/messenger/:
* [http://lxr.mozilla.org/seamonkey/source/mailnews/base/resources/locale/en-US/ mozilla/mailnews/base/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/base/search/resources/locale/en-US/ mozilla/mailnews/base/search/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/extensions/mailviews/resources/locale/en-US/ mozilla/mailnews/extensions/mailviews/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/extensions/mdn/resources/locale/en-US/ mozilla/mailnews/extensions/mdn/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/imap/resources/locale/en-US/ mozilla/mailnews/imap/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/import/comm4x/resources/locale/en-US/ mozilla/mailnews/import/comm4x/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/import/eudora/resources/locale/en-US/ mozilla/mailnews/import/eudora/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/import/oexpress/resources/locale/en-us/ mozilla/mailnews/import/oexpress/resources/locale/en-us/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/import/outlook/resources/locale/en-us/ mozilla/mailnews/import/outlook/resources/locale/en-us/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/import/resources/locale/en-us/ mozilla/mailnews/import/resources/locale/en-us/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/import/text/resources/locale/en-US/ mozilla/mailnews/import/text/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/local/resources/locale/en-US/ mozilla/mailnews/local/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/mime/cthandlers/resources/ mozilla/mailnews/mime/cthandlers/resources/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/mime/resources/ mozilla/mailnews/mime/resources/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/news/resources/locale/en-US/ mozilla/mailnews/news/resources/locale/en-US/]
To mozilla/suite/locales/en-US/chrome/messenger/addressbook/:
* [http://lxr.mozilla.org/seamonkey/source/mailnews/addrbook/resources/locales/en-US/  mozilla/mailnews/addrbook/resources/locales/en-US/]
To mozilla/suite/locales/en-US/chrome/messenger/pref/:
* [http://lxr.mozilla.org/seamonkey/source/mailnews/base/prefs/resources/locale/en-US/ mozilla/mailnews/base/prefs/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/compose/prefs/resources/locale/en-US/ mozilla/mailnews/compose/prefs/resources/locale/en-US/]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/mapi/resources/locale/en-US/ mozilla/mailnews/mapi/resources/locale/en-US/]*
To mozilla/suite/locales/en-US/chrome/messenger/messengercompose/:
* [http://lxr.mozilla.org/seamonkey/source/mailnews/compose/resources/locale/en-US/ mozilla/mailnews/compose/resources/locale/en-US/]
To mozilla/suite/locales/en-US/chrome/messenger-offline/:
* [http://lxr.mozilla.org/seamonkey/source/mailnews/extensions/offline-startup/resources/locale/en-US/ mozilla/mailnews/extensions/offline-startup/resources/locale/en-US/]
To mozilla/suite/locales/en-US/chrome/messenger-smime/:
* [http://lxr.moziila.org/seamonkey/source/mailnews/extensions/smime/resources/locale/en-US/ mozilla/mailnews/extensions/smime/resources/locale/en-US/]
To mozilla/suite/locales/en-US/chrome/messenger-mapi/:
* [http://lxr.mozilla.org/seamonkey/source/mailnews/mapi/resources/locale/en-US/ mozilla/mailnews/mapi/resources/locale/en-US/]*
''relevant jar.mn files (containing locale information):''
* [http://lxr.mozilla.org/seamonkey/source/mailnews/jar.mn mozilla/mailnews/jar.mn]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/extensions/mdn/jar.mn mozilla/mailnews/extensions/mdn/jar.mn]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/extensions/mailviews/jar.mn mozilla/mailnews/extensions/mailviews/jar.mn]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/extensions/offline-startup/jar.mn mozilla/mailnews/extensions/offline-startup/jar.mn]
* [http://lxr.mozilla.org/seamonkey/source/mailnews/extensions/smime/jar.mn mozilla/mailnews/extensions/smime/jar.mn]


== IRC discussion snippets ==
== IRC discussion snippets ==
=== [2007-01-12 13:39 PST] - topic: mailnews locale organization in suite ===
<br><KaiRo> Standard8Away: btw, as we usually have only one or two files there, we tend not to do a separate *-region in suite/
<br><KaiRo> phew, locale/en-US/messenger/ in en-US.jar really has all the files of the different dirs merged, (almost) no subdirs? wow...
<br><NeilZZZ> KaiRo: my memory is that addressbook and messengercompose have their own subdirs, but everything else is in that dir
<br><KaiRo> NeilZZZ: yes, that's what I'm seeing... which means that we probably need/want(?) to mirror that in the new structure in suite/locales/
<br><KaiRo> hmm, even pref panels are directly in mailnews/
<br><NeilZZZ> well, there are two things to consider
<br><NeilZZZ> 1) we could reorganise mailnews under suite but in jar.mn it would still be mapped to the original locations
<br><NeilZZZ> 2) we could then reorganise messenger.jar with the new locations
<br><NeilZZZ> but we could only do that for forked files
<br><KaiRo> hmm, true, we could reorganize in the source tree, but as you said, matching chrome structure to that would be a good idea, and that's hard because of shared files
<br><KaiRo> though somehow I start thinking that it might be a good idea to think of forking the whole mailnews UI and make mozilla/mailnews/ only have backend code in the long term
<br><KaiRo> NeilZZZ: it might be safe and perhaps a good idea in any case to move pref panels the way you describe, like Standard8Away proposes in his doc
<br><KaiRo> just not sure if it's correct/good to move the MAPI one there as well
<br><KaiRo> wait, that's not even a panel, that's just an overlay


=== [2006-01-17 07:00 PST] - topic: suite/ organization ===
=== [2006-01-17 07:00 PST] - topic: suite/ organization ===
Line 53: Line 186:
<br><bsmedberg> 2) is probably best
<br><bsmedberg> 2) is probably best


 
[[category:SeaMonkey|s]]
=== [2006-02-06 18:00 PST] - topic: locales/ structure ===
<br><KaiRo> gandalf: could you give me some clue about what structure we need for source L10n? we've been discussing if it needs to be suite /locales/ or could be suite/<component>/locales/ as well, and I've been wondering what implications that might have for the dir structure in /l10n repository... could you shed some light on that?
<br><gandalf> hmm
<br><gandalf> in your case...
<br><gandalf> KaiRo: what are the chances that someone will want to build seamonkey without a mail?
<br><gandalf> or browser?
<br><gandalf> or chatzilla?
<br><gandalf> or another component?
<br><KaiRo> gandalf: well, we want to be able to do that... on the other hand, I'd probably like to ship the same en-US.jar in all cases... chatzilla is in a seperate structure anyways
<br><gandalf> so, I see no reason to put locales in components
<br><gandalf> rather use locales as one of the components
<br><gandalf> so
<br><gandalf> suite/locales/browser/
<br><gandalf> erm
<br><gandalf> suite/locales/en-US/chrome
<br><KaiRo> suite/locales/en-US/chrome/browser actually :)
<br><KaiRo> (and others in the same structure, of course)
<br><gandalf> yes
<br><KaiRo> I'd just like to know what path change it might have in /l10n if we'd like to use suite/browser/locales/en-US/chrome instead (not that I myself want it, but I have to explain it to the others)
<br><gandalf> well, if you'd switch to this
<br><gandalf> it's not a big deal for localizers
<br><gandalf> they'll just to ./ab-CD/suite/browser/chrome/ instead of ./ab-CD/suite/chrome/browser
<br><gandalf> but
<<br>gandalf> it would make a pain for you to maintain l10n module code
<br><gandalf> etc. more locale makefiles
<br><gandalf> etc.
<br><KaiRo> gandalf: true... and separate jar.mn files... but some developers would actually like that better
<br><gandalf> I'm trying to figure out possible cons
<br><KaiRo> thanks... I for myself still feel better with suite/locales but not everyone is sure of that...
<br><gandalf> ok
<br><gandalf> what about strings shared between components?
<br><gandalf> where those would land?
<br><KaiRo> gandalf: that might even be spread across multiple directories, most will have the related XUl in suite/common/ though
<br><gandalf> ah, ok
<br><gandalf> so suite/common/locales ?
<br><gandalf> because otherwise, if you'll not build a component, you're dead
<br><KaiRo> gandalf: our directory structure is defined by http://wiki.mozilla.org/SeaMonkey:Suite_Directory_Layout - but you might note that we don't have concrete stuff there yet for locales
<br><KaiRo> gandalf: sure, suite/common/locales would exist then... maybe others as well though, as suite/branding/locales or so
<br><gandalf> In my opinion it's too much splitting
<br><gandalf> locales is a module
<br><gandalf> and I'd like to think of it like that
<br><gandalf> of course if we have optional components that are enough big to have it's own component dir and have a lot of l10n, those should use it's own locales dir
<br><gandalf> but usually
<br><gandalf> product/locales is ok
<br><KaiRo> Id feel better with that as well... OTOH, having all browser files in suite/borwser and all branding stuff in suite/branding has its good things as well
<br><gandalf> we use flock/locales in Flock
<br><gandalf> but we're way smaller than Seamonkey
<br><KaiRo> suite will build multiple locales/ dirs from all over the tree anyways, as we'll have all the core files, editor files, eventually chatzilla/venkman/inspector (what way ever they'll go in the future), possibly calendar - and last not least toolkit, once we'll use it
<br><KaiRo> (add reporter to the extensions-like crowd)
[...]
<br><KaiRo> gandalf: but to come back, the main argument against suite/<component>/locales/ is that it's more complicated in our original /mozilla tree, right?
<br><gandalf> yes
<br><KaiRo> ok, good to know
Schapel
213

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/17090...48508"