You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by Robert Burrell Donkin <ro...@gmail.com> on 2008/08/21 22:29:02 UTC

[mailets] Revised Site (Draft)

i've committed a revised version of the mailet site based on the new
division into products. should appear on
http://james.apache.org/mailet/ once the servers have sync'd. it's
still pretty basic and feedback appreciated or even better, dive in
and patch. the easiest way to edit the site is to check out
http://svn.apache.org/repos/asf/james/mailet/current/ (it might look a
little empty but the products are linked by externals). the main site
is found in src/site and the subsite for each product in the src/site
directory of the product subdirectory (for example, api/src/site).

IMHO improving website content is the major task which needs to be
completed before API and crypto can be released. since we're on a
release roll, now seems a good time to start :-)

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Robert Burrell Donkin <ro...@gmail.com>.
On Tue, Aug 26, 2008 at 8:25 AM, Stefano Bagnara <ap...@bago.org> wrote:
> Robert Burrell Donkin ha scritto:
>>
>> On Mon, Aug 25, 2008 at 7:52 PM, Stefano Bagnara <ap...@bago.org> wrote:
>>>
>>> Robert Burrell Donkin ha scritto:
>>>>
>>>> On Mon, Aug 25, 2008 at 2:57 PM, Stefano Bagnara <ap...@bago.org>
>>>> wrote:
>>>>
>>>> <snip>
>>>>
>>>>> Hope you don't mind that I also found the cycle to recreate mailet
>>>>> products
>>>>> logos using the same font we used for the main logo and changed it to
>>>>> use
>>>>> relative links to the subproduct images instead of cloning resources
>>>>> (anyway
>>>>> the root content is only intended to publish our website so I see no
>>>>> harm
>>>>> in
>>>>> directly linking content from subproduct)
>>>>> http://people.apache.org/~bago/mailet/ (reload if you already loaded
>>>>> this)
>>>>> (I also added a newline before the description)
>>>>
>>>> the difference in font was quasi-intentional (i don't have that
>>>> particular font but i would probably have opted for a different font
>>>> in any case)
>>>>
>>>> IMHO the same font is used then the design needs to be more balanced
>>>> and harmonious:
>>>>
>>>> 1 the font needs to be the same size as 'james'
>>>> 2 'API' needs to be changed from black to a colour
>>>> 3 the colours need to be chosen more harmoniously (rather than
>>>> constrasting)
>>>> 4 the tone weight need to be the same throughout (and should match the
>>>> 'james' tone weight)
>>>> 5 the capitalization should to be removed (from 'Standard' etc)
>>>
>>> I didn't want to collect more work ;-)
>>>
>>> I'll put back your logos tomorrow, but please cut the images correctly
>>> (they
>>> all have the first j incomplete)
>>
>> no, leave them
>>
>> if you let me know the details of the font, i'll probably take a look
>> at making at least some of the improvements i indicated
>
> When I had to change the logo 2 years ago no one was able to tell what was
> the font and give me an "original" (vectorial) copy, so I did a search and I
> found this:
> http://www.myfonts.com/fonts/urw/florentine/urw-t-regular/
>
> About your points.
> 1) I guess they will be too big and maybe they are no more appropriate in
> the higher baseline. When I completed it I thought it should have been
> smaller ;-/

if they're in the same font then it would probably be more balanced if
the product names were on the baseline

> 2) I agree. I was about doing that using the gray from the second central
> feather.
> 3) I liked the choice of colours from the feathers. I can't think at better
> colours.

yes

reusing the feather colours is be more harmonious

> 4) I guess the "tone weight" is the same, maybe the aliasing make it appear
> different.
> 5) I agree.
>
> BTW I'm not a designer, simply I didn't like the previous logos (didn't like
> mainly the random horizontal placement, the bad crop)

:-)

a corollary to Mazzocchi's law: never waste time perfecting something
you want others to improve

> so I took the freedom
> to update them (as I created all of our "derived" logos). You seem to know
> the matter better than me.

i'm not sure i'd say that ;-)

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Stefano Bagnara <ap...@bago.org>.
Robert Burrell Donkin ha scritto:
> On Mon, Aug 25, 2008 at 7:52 PM, Stefano Bagnara <ap...@bago.org> wrote:
>> Robert Burrell Donkin ha scritto:
>>> On Mon, Aug 25, 2008 at 2:57 PM, Stefano Bagnara <ap...@bago.org> wrote:
>>>
>>> <snip>
>>>
>>>> Hope you don't mind that I also found the cycle to recreate mailet
>>>> products
>>>> logos using the same font we used for the main logo and changed it to use
>>>> relative links to the subproduct images instead of cloning resources
>>>> (anyway
>>>> the root content is only intended to publish our website so I see no harm
>>>> in
>>>> directly linking content from subproduct)
>>>> http://people.apache.org/~bago/mailet/ (reload if you already loaded
>>>> this)
>>>> (I also added a newline before the description)
>>> the difference in font was quasi-intentional (i don't have that
>>> particular font but i would probably have opted for a different font
>>> in any case)
>>>
>>> IMHO the same font is used then the design needs to be more balanced
>>> and harmonious:
>>>
>>> 1 the font needs to be the same size as 'james'
>>> 2 'API' needs to be changed from black to a colour
>>> 3 the colours need to be chosen more harmoniously (rather than
>>> constrasting)
>>> 4 the tone weight need to be the same throughout (and should match the
>>> 'james' tone weight)
>>> 5 the capitalization should to be removed (from 'Standard' etc)
>> I didn't want to collect more work ;-)
>>
>> I'll put back your logos tomorrow, but please cut the images correctly (they
>> all have the first j incomplete)
> 
> no, leave them
> 
> if you let me know the details of the font, i'll probably take a look
> at making at least some of the improvements i indicated

When I had to change the logo 2 years ago no one was able to tell what 
was the font and give me an "original" (vectorial) copy, so I did a 
search and I found this:
http://www.myfonts.com/fonts/urw/florentine/urw-t-regular/

About your points.
1) I guess they will be too big and maybe they are no more appropriate 
in the higher baseline. When I completed it I thought it should have 
been smaller ;-/
2) I agree. I was about doing that using the gray from the second 
central feather.
3) I liked the choice of colours from the feathers. I can't think at 
better colours.
4) I guess the "tone weight" is the same, maybe the aliasing make it 
appear different.
5) I agree.

BTW I'm not a designer, simply I didn't like the previous logos (didn't 
like mainly the random horizontal placement, the bad crop) so I took the 
freedom to update them (as I created all of our "derived" logos). You 
seem to know the matter better than me.

pardon,
Stefano

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Robert Burrell Donkin <ro...@gmail.com>.
On Mon, Aug 25, 2008 at 7:52 PM, Stefano Bagnara <ap...@bago.org> wrote:
> Robert Burrell Donkin ha scritto:
>>
>> On Mon, Aug 25, 2008 at 2:57 PM, Stefano Bagnara <ap...@bago.org> wrote:
>>
>> <snip>
>>
>>> Hope you don't mind that I also found the cycle to recreate mailet
>>> products
>>> logos using the same font we used for the main logo and changed it to use
>>> relative links to the subproduct images instead of cloning resources
>>> (anyway
>>> the root content is only intended to publish our website so I see no harm
>>> in
>>> directly linking content from subproduct)
>>> http://people.apache.org/~bago/mailet/ (reload if you already loaded
>>> this)
>>> (I also added a newline before the description)
>>
>> the difference in font was quasi-intentional (i don't have that
>> particular font but i would probably have opted for a different font
>> in any case)
>>
>> IMHO the same font is used then the design needs to be more balanced
>> and harmonious:
>>
>> 1 the font needs to be the same size as 'james'
>> 2 'API' needs to be changed from black to a colour
>> 3 the colours need to be chosen more harmoniously (rather than
>> constrasting)
>> 4 the tone weight need to be the same throughout (and should match the
>> 'james' tone weight)
>> 5 the capitalization should to be removed (from 'Standard' etc)
>
> I didn't want to collect more work ;-)
>
> I'll put back your logos tomorrow, but please cut the images correctly (they
> all have the first j incomplete)

no, leave them

if you let me know the details of the font, i'll probably take a look
at making at least some of the improvements i indicated

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Stefano Bagnara <ap...@bago.org>.
Robert Burrell Donkin ha scritto:
> On Mon, Aug 25, 2008 at 2:57 PM, Stefano Bagnara <ap...@bago.org> wrote:
> 
> <snip>
> 
>> Hope you don't mind that I also found the cycle to recreate mailet products
>> logos using the same font we used for the main logo and changed it to use
>> relative links to the subproduct images instead of cloning resources (anyway
>> the root content is only intended to publish our website so I see no harm in
>> directly linking content from subproduct)
>> http://people.apache.org/~bago/mailet/ (reload if you already loaded this)
>> (I also added a newline before the description)
> 
> the difference in font was quasi-intentional (i don't have that
> particular font but i would probably have opted for a different font
> in any case)
> 
> IMHO the same font is used then the design needs to be more balanced
> and harmonious:
> 
> 1 the font needs to be the same size as 'james'
> 2 'API' needs to be changed from black to a colour
> 3 the colours need to be chosen more harmoniously (rather than constrasting)
> 4 the tone weight need to be the same throughout (and should match the
> 'james' tone weight)
> 5 the capitalization should to be removed (from 'Standard' etc)

I didn't want to collect more work ;-)

I'll put back your logos tomorrow, but please cut the images correctly 
(they all have the first j incomplete)

Stefano

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Robert Burrell Donkin <ro...@gmail.com>.
On Mon, Aug 25, 2008 at 2:57 PM, Stefano Bagnara <ap...@bago.org> wrote:

<snip>

> Hope you don't mind that I also found the cycle to recreate mailet products
> logos using the same font we used for the main logo and changed it to use
> relative links to the subproduct images instead of cloning resources (anyway
> the root content is only intended to publish our website so I see no harm in
> directly linking content from subproduct)
> http://people.apache.org/~bago/mailet/ (reload if you already loaded this)
> (I also added a newline before the description)

the difference in font was quasi-intentional (i don't have that
particular font but i would probably have opted for a different font
in any case)

IMHO the same font is used then the design needs to be more balanced
and harmonious:

1 the font needs to be the same size as 'james'
2 'API' needs to be changed from black to a colour
3 the colours need to be chosen more harmoniously (rather than constrasting)
4 the tone weight need to be the same throughout (and should match the
'james' tone weight)
5 the capitalization should to be removed (from 'Standard' etc)

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Stefano Bagnara <ap...@bago.org>.
Robert Burrell Donkin ha scritto:
> On Sat, Aug 23, 2008 at 7:07 PM, Stefano Bagnara <ap...@bago.org> wrote:
>> Robert Burrell Donkin ha scritto:
>>> On Fri, Aug 22, 2008 at 9:04 PM, Stefano Bagnara <ap...@bago.org> wrote:
>>>> [...]
>>>> I created a very simple Mojo (attached to MAILET-14) that scan all of the
>>>> java files in a maven project and if they implements Mailet or Matcher
>>>> take
>>>> them, their "getMailetInfo"/"getMatcherInfo" return value (yes, it
>>>> instantiate them too) and the class javadoc and put all of this in an
>>>> xdoc
>>>> report that will be automatically generated during the maven site
>>>> generation.
>>>> [...]
>>> cool toys but would require work
>>> 4. semantic export
>>> 5. mailet composite indexer (using semantic exports)
>> Cool, but too much for me now. I have too many todos with higher priorities
>> that I can't even add this to the end of the list ;-)
> 
> yeh but they are cool :-)
> 
> maybe someone will jump in...

maven plugins have some good "template" using modello. They use this for 
most descriptors in the maven world. I had to deal with it while 
creating a patch for a feature request I just made for the assembly 
plugin. Maybe sooner or later I'll have collected some more skills and 
this task will be trivial, but I'm not there yet.

>>>> I think this approach is very good, expecially if we define some new
>>>> taglet
>>>> and we start documenting mailets using some specific taglet (e.g: for
>>>> parameters) so to be able to better document their usage.
>>> +1
>>>
>>>> All a project have todo to automatically create a similar report for the
>>>> mailets included in the product is add this to the pom's <reporting>
>>>> configuration:
>>>> <plugin>
>>>>  <groupId>org.apache.james</groupId>
>>>>  <artifactId>maven-mailetdocs-plugin</artifactId>
>>>> </plugin>
>>> great
>>>
>>> let's think of a good name and get it committed into the mailets
>>> subproject
>> I added it as maven-mailetdocs-plugin.
>> If you have any better suggestion we can easily rename it.
> 
> i don't. anyone else?
> 
> what else would we need to do for a prompt 0.1 release?

See if it works for mailets-function module in server.trunk.

Hope you don't mind that I also found the cycle to recreate mailet 
products logos using the same font we used for the main logo and changed 
it to use relative links to the subproduct images instead of cloning 
resources (anyway the root content is only intended to publish our 
website so I see no harm in directly linking content from subproduct)
http://people.apache.org/~bago/mailet/ (reload if you already loaded this)
(I also added a newline before the description)

Stefano

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Robert Burrell Donkin <ro...@gmail.com>.
On Sat, Aug 23, 2008 at 7:07 PM, Stefano Bagnara <ap...@bago.org> wrote:
> Robert Burrell Donkin ha scritto:
>>
>> On Fri, Aug 22, 2008 at 9:04 PM, Stefano Bagnara <ap...@bago.org> wrote:
>>>
>>> [...]
>>> I created a very simple Mojo (attached to MAILET-14) that scan all of the
>>> java files in a maven project and if they implements Mailet or Matcher
>>> take
>>> them, their "getMailetInfo"/"getMatcherInfo" return value (yes, it
>>> instantiate them too) and the class javadoc and put all of this in an
>>> xdoc
>>> report that will be automatically generated during the maven site
>>> generation.
>>> [...]
>>
>> cool :-)
>>
>>> I gave it only a couple of hours, so there is a lot to do yet.. any
>>> suggestion is welcome.
>>
>> a couple of easy starters:
>> 1. sort alphabetically
>> 2. add an index for the page
>
> Done, and generate:
> http://svn.apache.org/repos/asf/james/site/trunk/www/mailet/standard/mailet-report.html

great :-)

>> cool but a little more involved
>> 3. support faceted classification (this would mean adding a category
>> taglet)
>
> Let's first add the category.. when they will be categorized I'll add
> category support to the plugin.



>> cool toys but would require work
>> 4. semantic export
>> 5. mailet composite indexer (using semantic exports)
>
> Cool, but too much for me now. I have too many todos with higher priorities
> that I can't even add this to the end of the list ;-)

yeh but they are cool :-)

maybe someone will jump in...

>>> I think this approach is very good, expecially if we define some new
>>> taglet
>>> and we start documenting mailets using some specific taglet (e.g: for
>>> parameters) so to be able to better document their usage.
>>
>> +1
>>
>>> All a project have todo to automatically create a similar report for the
>>> mailets included in the product is add this to the pom's <reporting>
>>> configuration:
>>> <plugin>
>>>  <groupId>org.apache.james</groupId>
>>>  <artifactId>maven-mailetdocs-plugin</artifactId>
>>> </plugin>
>>
>> great
>>
>> let's think of a good name and get it committed into the mailets
>> subproject
>
> I added it as maven-mailetdocs-plugin.
> If you have any better suggestion we can easily rename it.

i don't. anyone else?

what else would we need to do for a prompt 0.1 release?

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Stefano Bagnara <ap...@bago.org>.
Robert Burrell Donkin ha scritto:
> On Fri, Aug 22, 2008 at 9:04 PM, Stefano Bagnara <ap...@bago.org> wrote:
>> [...]
>> I created a very simple Mojo (attached to MAILET-14) that scan all of the
>> java files in a maven project and if they implements Mailet or Matcher take
>> them, their "getMailetInfo"/"getMatcherInfo" return value (yes, it
>> instantiate them too) and the class javadoc and put all of this in an xdoc
>> report that will be automatically generated during the maven site
>> generation.
>> [...]
> 
> cool :-)
> 
>> I gave it only a couple of hours, so there is a lot to do yet.. any
>> suggestion is welcome.
> 
> a couple of easy starters:
> 1. sort alphabetically
> 2. add an index for the page

Done, and generate:
http://svn.apache.org/repos/asf/james/site/trunk/www/mailet/standard/mailet-report.html

> cool but a little more involved
> 3. support faceted classification (this would mean adding a category taglet)

Let's first add the category.. when they will be categorized I'll add 
category support to the plugin.

> cool toys but would require work
> 4. semantic export
> 5. mailet composite indexer (using semantic exports)

Cool, but too much for me now. I have too many todos with higher 
priorities that I can't even add this to the end of the list ;-)

>> I think this approach is very good, expecially if we define some new taglet
>> and we start documenting mailets using some specific taglet (e.g: for
>> parameters) so to be able to better document their usage.
> 
> +1
> 
>> All a project have todo to automatically create a similar report for the
>> mailets included in the product is add this to the pom's <reporting>
>> configuration:
>> <plugin>
>>  <groupId>org.apache.james</groupId>
>>  <artifactId>maven-mailetdocs-plugin</artifactId>
>> </plugin>
> 
> great
> 
> let's think of a good name and get it committed into the mailets subproject

I added it as maven-mailetdocs-plugin.
If you have any better suggestion we can easily rename it.

Stefano

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Robert Burrell Donkin <ro...@gmail.com>.
On Fri, Aug 22, 2008 at 9:04 PM, Stefano Bagnara <ap...@bago.org> wrote:
> Robert Burrell Donkin ha scritto:
>>
>> i've committed a revised version of the mailet site based on the new
>> division into products. should appear on
>> http://james.apache.org/mailet/ once the servers have sync'd. it's
>> still pretty basic and feedback appreciated or even better, dive in
>> and patch. the easiest way to edit the site is to check out
>> http://svn.apache.org/repos/asf/james/mailet/current/ (it might look a
>> little empty but the products are linked by externals). the main site
>> is found in src/site and the subsite for each product in the src/site
>> directory of the product subdirectory (for example, api/src/site).
>>
>> IMHO improving website content is the major task which needs to be
>> completed before API and crypto can be released. since we're on a
>> release roll, now seems a good time to start :-)
>
> I'm not good at documentation, but I think I've found a task for me.
> It was at least an year I wanted to write some maven plugin to understand
> how difficult they are, so I decided this time was the right time.
>
> I created a very simple Mojo (attached to MAILET-14) that scan all of the
> java files in a maven project and if they implements Mailet or Matcher take
> them, their "getMailetInfo"/"getMatcherInfo" return value (yes, it
> instantiate them too) and the class javadoc and put all of this in an xdoc
> report that will be automatically generated during the maven site
> generation.
>
> I didn't know if you will like this idea, so I simply compiled the plugin
> locally and temporarily added it only to mailet-standard product so to be
> able to produce a result on people.a.o and let you see it.
>
> If you like it then we'll probably should put the maven plugin as a sister
> project for the mailet products.
>
> Here you can see the resulting report of the current "raw" code.
> http://people.apache.org/~bago/mailet/standard/site/mailet-report.html

cool :-)

> I gave it only a couple of hours, so there is a lot to do yet.. any
> suggestion is welcome.

a couple of easy starters:
1. sort alphabetically
2. add an index for the page

cool but a little more involved
3. support faceted classification (this would mean adding a category taglet)

cool toys but would require work
4. semantic export
5. mailet composite indexer (using semantic exports)

> I think this approach is very good, expecially if we define some new taglet
> and we start documenting mailets using some specific taglet (e.g: for
> parameters) so to be able to better document their usage.

+1

> All a project have todo to automatically create a similar report for the
> mailets included in the product is add this to the pom's <reporting>
> configuration:
> <plugin>
>  <groupId>org.apache.james</groupId>
>  <artifactId>maven-mailetdocs-plugin</artifactId>
> </plugin>

great

let's think of a good name and get it committed into the mailets subproject

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Re: [mailets] Revised Site (Draft)

Posted by Stefano Bagnara <ap...@bago.org>.
Robert Burrell Donkin ha scritto:
> i've committed a revised version of the mailet site based on the new
> division into products. should appear on
> http://james.apache.org/mailet/ once the servers have sync'd. it's
> still pretty basic and feedback appreciated or even better, dive in
> and patch. the easiest way to edit the site is to check out
> http://svn.apache.org/repos/asf/james/mailet/current/ (it might look a
> little empty but the products are linked by externals). the main site
> is found in src/site and the subsite for each product in the src/site
> directory of the product subdirectory (for example, api/src/site).
> 
> IMHO improving website content is the major task which needs to be
> completed before API and crypto can be released. since we're on a
> release roll, now seems a good time to start :-)

I'm not good at documentation, but I think I've found a task for me.
It was at least an year I wanted to write some maven plugin to 
understand how difficult they are, so I decided this time was the right 
time.

I created a very simple Mojo (attached to MAILET-14) that scan all of 
the java files in a maven project and if they implements Mailet or 
Matcher take them, their "getMailetInfo"/"getMatcherInfo" return value 
(yes, it instantiate them too) and the class javadoc and put all of this 
in an xdoc report that will be automatically generated during the maven 
site generation.

I didn't know if you will like this idea, so I simply compiled the 
plugin locally and temporarily added it only to mailet-standard product 
so to be able to produce a result on people.a.o and let you see it.

If you like it then we'll probably should put the maven plugin as a 
sister project for the mailet products.

Here you can see the resulting report of the current "raw" code.
http://people.apache.org/~bago/mailet/standard/site/mailet-report.html

I gave it only a couple of hours, so there is a lot to do yet.. any 
suggestion is welcome.

I think this approach is very good, expecially if we define some new 
taglet and we start documenting mailets using some specific taglet (e.g: 
for parameters) so to be able to better document their usage.

All a project have todo to automatically create a similar report for the 
mailets included in the product is add this to the pom's <reporting> 
configuration:
<plugin>
   <groupId>org.apache.james</groupId>
   <artifactId>maven-mailetdocs-plugin</artifactId>
</plugin>

Stefano

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org