Community
Participate
Working Groups
We have lots of old pages on eclipse.org which are no longer relevant or accurate, but need to be maintained for historical purposes. It would be nice to have a Nova-like theme which makes it automatically clear to the reader that the page is out-of-date. This could be something added to the header, the banner, or a watermark, or some combination thereof.
Note that I don't think Mike necessarily means a "theme" in any implementation specific way (i.e. I don't think we need to reimplement Nova). We just need a way of annotating old and out-of-date pages. Some thoughts: Add a field to $App that we can explicitly set to indicate that the page is out of date, e.g. $App->setOutdated(true), or something. Add a "valid until" field to $App that will automatically put up the indications after a specific date has passed, e.g. $App->validUntil('2013-06-26'); (In reply to comment #0) > This could be something added to the header, the banner, or a watermark, or > some combination thereof. I'm thinking all of the above.
(In reply to comment #1) > Note that I don't think Mike necessarily means a "theme" in any > implementation specific way (i.e. I don't think we need to reimplement > Nova). confirmed.
(In reply to comment #1) > Note that I don't think Mike necessarily means a "theme" in any > implementation specific way (i.e. I don't think we need to reimplement > Nova). We just need a way of annotating old and out-of-date pages. > > Some thoughts: > > Add a field to $App that we can explicitly set to indicate that the page is > out of date, e.g. $App->setOutdated(true), or something. > > Add a "valid until" field to $App that will automatically put up the > indications after a specific date has passed, e.g. > $App->validUntil('2013-06-26'); How about only creating $App->setOutdated(). This function would accept a Boolean value (TRUE or FALSE) or a date ('2013-06-26'). > > (In reply to comment #0) > > > This could be something added to the header, the banner, or a watermark, or > > some combination thereof. > > I'm thinking all of the above. Watermark: Here I am thinking about have a background image with the text "Deprecated" in pink or grey behind the content. Header: We could replace the eclipse logo with a newly created "Eclipse Deprecated" logo. This new logo would be created based off our Eclipse Artwork: http://www.eclipse.org/artwork/ Banner: A red/pink message box could be inserted before the content is printed.
(In reply to comment #3) > How about only creating $App->setOutdated(). This function would accept a > Boolean value (TRUE or FALSE) or a date ('2013-06-26'). +1 How about something like: function setOutdated($when = 'now') Then you don't have to have extra checks for true/false. I doubt that we'd ever say $App->setOutdated(FALSE) > Watermark: Here I am thinking about have a background image with the text > "Deprecated" in pink or grey behind the content. +1 for grey. > Header: We could replace the eclipse logo with a newly created "Eclipse > Deprecated" logo. This new logo would be created based off our Eclipse > Artwork: http://www.eclipse.org/artwork/ This may be overkill. Also, it's probably not bad to display the advertisements that go in this space; even for out-of-date pages. > Banner: A red/pink message box could be inserted before the content is > printed. How about "Screaming Yellow"? Maybe also include "(out of date)" in the page title.
Created attachment 227953 [details] Initial mockup of a deprecated page. Here's a quick mockup of what I was thinking for the look and feel of a deprecated page.
(In reply to comment #4) > (In reply to comment #3) > > > How about only creating $App->setOutdated(). This function would accept a > > Boolean value (TRUE or FALSE) or a date ('2013-06-26'). > > +1 > > How about something like: > > function setOutdated($when = 'now') +1 > > Then you don't have to have extra checks for true/false. > > I doubt that we'd ever say $App->setOutdated(FALSE) Agreed > > > Watermark: Here I am thinking about have a background image with the text > > "Deprecated" in pink or grey behind the content. > > +1 for grey. > > > Header: We could replace the eclipse logo with a newly created "Eclipse > > Deprecated" logo. This new logo would be created based off our Eclipse > > Artwork: http://www.eclipse.org/artwork/ > > This may be overkill. Also, it's probably not bad to display the > advertisements that go in this space; even for out-of-date pages. Maybe we could show this "new" logo if we dont have any ads? > > > Banner: A red/pink message box could be inserted before the content is > > printed. > > How about "Screaming Yellow"? I saw this comment after posting my first mockup. I am working on a new one with your color suggestion so that we can compare what works best. > > Maybe also include "(out of date)" in the page title. +1
Created attachment 227955 [details] Bright yellow message box Similar to my first layout but with a bright yellow box and a grey watermark.
(In reply to comment #5) > Created attachment 227953 [details] > Initial mockup of a deprecated page. > > Here's a quick mockup of what I was thinking for the look and feel of a > deprecated page. Very nice. Though, I don't like the "Eclipse DEPRECATED" logo. It seems too negative. (In reply to comment #7) > Created attachment 227955 [details] > Bright yellow message box > > Similar to my first layout but with a bright yellow box and a grey watermark. I was wrong.
(In reply to comment #8) > (In reply to comment #5) > > Created attachment 227953 [details] > > Initial mockup of a deprecated page. > > > > Here's a quick mockup of what I was thinking for the look and feel of a > > deprecated page. > > Very nice. > > Though, I don't like the "Eclipse DEPRECATED" logo. It seems too negative. True > > (In reply to comment #7) > > Created attachment 227955 [details] > > Bright yellow message box > > > > Similar to my first layout but with a bright yellow box and a grey watermark. > > I was wrong. I agree, I prefer the red box but I could go either way on the watermark color.
(In reply to comment #9) > I agree, I prefer the red box but I could go either way on the watermark > color. I also prefer the red. The yellow is just too over the top.
Created attachment 228011 [details] Patch: add the "deprecated" page concept to Nova This patch will add a watermark and a red message box to a page that was flagged to be deprecated. To deprecate a page you need to set the OutDated flag: $App->setOutDated('2011-11-11'); Accepted formats 'YYYY-MM-DD' or 'now'.
Created attachment 228017 [details] Real world example of my patch Attach is a proof of how a deprecated page will look like on a all possible nova layout that I could find.
(In reply to comment #11) > Created attachment 228011 [details] > Patch: add the "deprecated" page concept to Nova > > This patch will add a watermark and a red message box to a page that was > flagged to be deprecated. > > To deprecate a page you need to set the OutDated flag: > > $App->setOutDated('2011-11-11'); > > Accepted formats 'YYYY-MM-DD' or 'now'. +1 Though, I don't think you need to spend quite so much effort on validating the date format. In fact, it might be better to just remove the validation. (In reply to comment #12) > Created attachment 228017 [details] > Real world example of my patch > > Attach is a proof of how a deprecated page will look like on a all possible > nova layout that I could find. +1
(In reply to comment #13) > (In reply to comment #11) > > Created attachment 228011 [details] > > Patch: add the "deprecated" page concept to Nova > > > > This patch will add a watermark and a red message box to a page that was > > flagged to be deprecated. > > > > To deprecate a page you need to set the OutDated flag: > > > > $App->setOutDated('2011-11-11'); > > > > Accepted formats 'YYYY-MM-DD' or 'now'. > > +1 > > Though, I don't think you need to spend quite so much effort on validating > the date format. In fact, it might be better to just remove the validation. > The date validation is important because it only return TRUE if the date is valid. For example if I remove $this->validateDateFormat($when) and if someone pass an invalid date: $App->setOutDated('2013-31-31'); The OutDated flag will be sent to TRUE and the deprecated theme will appear on the page. It's because strtotime('2013-31-31') = FALSE if the date is invalid and(time() >= FALSE) = TRUE
> The OutDated flag will be sent to TRUE and the deprecated theme will appear on > the page. The OutDated flag will be set to TRUE...
+1 Patch looks good Chris!
(In reply to comment #16) > +1 Patch looks good Chris! I made the commit http://git.eclipse.org/c/www.eclipse.org/eclipse.org-common.git/commit/ I also added some documentation on our wiki : http://wiki.eclipse.org/Using_Phoenix#Deprecated_theme
(In reply to comment #17) > (In reply to comment #16) > > +1 Patch looks good Chris! > > I made the commit > http://git.eclipse.org/c/www.eclipse.org/eclipse.org-common.git/commit/ The commit url should be http://git.eclipse.org/c/www.eclipse.org/eclipse.org-common.git/commit/?id=c52b1751625dbb98eb38959e5a56e8be43c148ec
This sounds cool.. where can we see this in action?
Oops -- somehow I hit the Security checkbox.
(In reply to comment #19) > This sounds cool.. where can we see this in action? I dont think we've started to use this yet. Do you know of a page that needs to be deprecated? I would be happy to test this.
I thought perhaps the intention was to examine the timestamp on the PHP file itself and automatically indicate that content may be deprecated. For example: http://www.eclipse.org/phoenix/downloads.php That "downloads.php" file is timestamped from 2005, and the contents is definitely old and stale.
(In reply to comment #22) > I thought perhaps the intention was to examine the timestamp on the PHP file > itself and automatically indicate that content may be deprecated. For > example: > > http://www.eclipse.org/phoenix/downloads.php > > That "downloads.php" file is timestamped from 2005, and the contents is > definitely old and stale. I like your idea. We could probably use http://php.net/manual/en/function.filemtime.php for that but this might automatically deprecate a page that doesn't need to be deprecated. For example, an old press release.
We could perhaps examine the time and the path .. for instance, exclude auto-deprecation of content in /org/... At any rate, if there are exceptions, we could always add the $App->setOutDated(FALSE); for those pages that should never expire.
I like the idea of being able to explicitly mark a page as out of date. I'm skeptical that we can do this automatically without making a lot of mistakes (and--by extension--a lot of grumpy committers). It's worth exploring, however. Perhaps an automatic mechanism can be a little softer. How about we put a "last modified" date on the page and let the reader make their own decision?
(In reply to comment #21) > I dont think we've started to use this yet. Do you know of a page that needs > to be deprecated? I would be happy to test this. Chris, If you could deprecate [1], and the pages linked from [1], I would appreciate it. The wrinkle is that those pages are so old, they don't use Nova. Thanks. [1] http://www.eclipse.org/legal/cpl2epl/
FWIW, I've started to use this. http://www.eclipse.org/articles/article.php?file=Article-PDE-Automation/article.html http://www.eclipse.org/articles/article.php?file=Article-Preferences/article.html
(In reply to comment #26) > (In reply to comment #21) > > I dont think we've started to use this yet. Do you know of a page that needs > > to be deprecated? I would be happy to test this. > > Chris, > > If you could deprecate [1], and the pages linked from [1], I would > appreciate it. The wrinkle is that those pages are so old, they don't use > Nova. > > Thanks. > > [1] http://www.eclipse.org/legal/cpl2epl/ I can definitely do that! I have 2 options, create a patch for this old theme to print the deprecated message or I switch those legal pages to use the Nova theme. 1) would allow us to deprecated pages with the old theme without having to switch to nova. 2) converting a page to Nova doesn't take a lot of time.
(In reply to comment #28) > I have 2 options, create a patch for this old theme to print the deprecated > message or I switch those legal pages to use the Nova theme. I'm fine with either. Do whichever you think is the least amount of work for you.
(In reply to comment #28) > I have 2 options, create a patch for this old theme to print the deprecated > message or I switch those legal pages to use the Nova theme. > > 1) would allow us to deprecated pages with the old theme without having to > switch to nova. > 2) converting a page to Nova doesn't take a lot of time. I'm pretty sure that we have some projects still using the old theme. Did we ever officially deprecate the the "phoenix" theme (I think that's what we're talking about)? I'm not necessarily against this. It will provide a much-needed kick for some projects to invest some effort in their websites. We just need to prepare ourselves for the inevitable screams. Denis, without loading every single Git repository, I have no means of finding out who is still using Phoenix. Can you run a scan on the web directory for projects using the old theme? Something like: grep '$theme\s*=\s*\"phoenix\";' -i -r . Should get most of them.
(In reply to comment #26) > (In reply to comment #21) > > I dont think we've started to use this yet. Do you know of a page that needs > > to be deprecated? I would be happy to test this. > > Chris, > > If you could deprecate [1], and the pages linked from [1], I would > appreciate it. The wrinkle is that those pages are so old, they don't use > Nova. > > Thanks. > > [1] http://www.eclipse.org/legal/cpl2epl/ I know you said to deprecated all pages linked from [1] but can you confirm that I should deprecated this page : http://www.eclipse.org/org/documents/epl-v10.php It's the only link on the page outside of /legal/cpl2epl/
(In reply to comment #31) > I know you said to deprecated all pages linked from [1] but can you confirm > that I should deprecated this page : > http://www.eclipse.org/org/documents/epl-v10.php My bad! Please leave that one alone :) I will check the rest.
(In reply to comment #32) > (In reply to comment #31) > > I know you said to deprecated all pages linked from [1] but can you confirm > > that I should deprecated this page : > > http://www.eclipse.org/org/documents/epl-v10.php > > My bad! Please leave that one alone :) > > I will check the rest. Awesome, I am glad I did a double check! I made the commit for the other pages: http://git.eclipse.org/c/www.eclipse.org/legal.git/commit/?id=20a3fce029099f7437556f7bfca711875d822359
This new theme seems to work just fine. Marking as closed fixed.
