Bug 129098 - Convert Web Site to Phoenix Style
Summary: Convert Web Site to Phoenix Style
Status: CLOSED FIXED
Alias: None
Product: WTP Website
Classification: WebTools
Component: website (show other bugs)
Version: 1.5   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Bob Fraser CLA
QA Contact:
URL:
Whiteboard:
Keywords: helpwanted
Depends on:
Blocks: 153085
  Show dependency tree
 
Reported: 2006-02-22 22:26 EST by Arthur Ryman CLA
Modified: 2007-09-07 12:16 EDT (History)
6 users (show)

See Also:


Attachments
Patch for Phoenix Style Webtools pages (27.25 KB, patch)
2007-01-10 16:44 EST, Bob Fraser CLA
no flags Details | Diff
Patch for Phoenix Style Webtools pages round 2 (25.42 KB, patch)
2007-01-10 19:37 EST, Bob Fraser CLA
no flags Details | Diff
Generalize /webtools/phoenix/main.php to grab the title dynamically (1.25 KB, patch)
2007-01-11 14:35 EST, Bob Fraser CLA
no flags Details | Diff
Add a phoenix style dali subproject page (2.63 KB, patch)
2007-01-11 19:11 EST, Bob Fraser CLA
no flags Details | Diff
Add a number of Phoenix style web pages (13.00 KB, patch)
2007-01-12 14:18 EST, Bob Fraser CLA
no flags Details | Diff
Phoenix about and development pages. (14.41 KB, text/plain)
2007-01-25 11:59 EST, Bob Fraser CLA
no flags Details
Phoenix enable about and development pages - This time as patch (14.41 KB, patch)
2007-01-25 12:01 EST, Bob Fraser CLA
no flags Details | Diff
Patch to cut the Web Tools Web site over to the Phoenix pages (144.48 KB, patch)
2007-02-08 18:02 EST, Bob Fraser CLA
no flags Details | Diff
Patch to implement folding navigation menus (20.10 KB, text/plain)
2007-02-12 19:35 EST, Bob Fraser CLA
no flags Details
Center the news feed (1.21 KB, patch)
2007-02-13 14:38 EST, Bob Fraser CLA
no flags Details | Diff
Better way to center the news (2.61 KB, patch)
2007-02-13 16:54 EST, Bob Fraser CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Arthur Ryman CLA 2006-02-22 22:26:34 EST
I'd like to establish some requirements.

1. Don't break existing URLs. If we replace *.html pages with *.php pages then the old *.html URLs should still work but redirect the browser to the corresponding *.php URL.

2. Don't force everyone to learn PHP. Let's continue to use XHTML or XML for our content. This content should be transformed by the PHP files using XSLT as is now the case for generating HTML. The difference is that with PHP we can avoid the build scripts that generate static HTML. Instead, the PHP file will dynamically transform the content.

3. Modify the current XSLT's to generate the Phoenix look and feel to support client-side XSLT when requesting raw XML or XHTML.

4. Convert the site incrementally. Start with some simple cases and then apply to the rest of the site.
Comment 1 Arthur Ryman CLA 2006-11-07 10:48:10 EST
I created a sandbox phoenix directory and moved some files into it. I invite the subproject and component teams and the volunteers to begin migrating the content. There are instructions for getting started with Phoenix in the Eclipse Committer Tools wiki.[1]

[1] http://wiki.eclipse.org/index.php/Using_Phoenix
Comment 2 Bob Fraser CLA 2007-01-10 16:42:23 EST
I have a patch that implements the Phoenix style for about a dozen of the Webtools web pages.
Comment 3 Bob Fraser CLA 2007-01-10 16:44:48 EST
Created attachment 56731 [details]
Patch for Phoenix Style Webtools pages
Comment 4 Arthur Ryman CLA 2007-01-10 17:00:02 EST
I am rejecting this since the patch was creating with webtools as a subdirectory of a project. Please check out webtools as a project (Check out), or see if you can generate the patch from the webtools folder, not at the project level.
Comment 5 Bob Fraser CLA 2007-01-10 19:36:52 EST
Submitting a subset of the original patch.  This one looks to not have the offending subdirectory.
Comment 6 Bob Fraser CLA 2007-01-10 19:37:27 EST
Created attachment 56739 [details]
Patch for Phoenix Style Webtools pages round 2
Comment 7 Arthur Ryman CLA 2007-01-11 08:21:31 EST
Bob, I applied your second patch. Please test it out on the live site. Thx.
Comment 8 Bob Fraser CLA 2007-01-11 11:31:02 EST
Patch looks good.  Thanks Arthur.  Tested /webtools/main.php and /webtools/phoenix/main.php is dynamically serving up an XSL transformation of an xhtml page.  There will be a few broken links until I submit another patch or two.
Comment 9 Bob Fraser CLA 2007-01-11 14:34:36 EST
Adding patch to generalize /webtools/phoenix/main.php
Set page title dynamically from the xml document.

This template file can be dropped next to an xhtml style "main.xml" page to dynamically generate a phoenix style page via php.

The only changes to the template would be:

1) change the name of the source document if it is not "main.xml"
2) optionally add page keywords
3) change the author
Comment 10 Bob Fraser CLA 2007-01-11 14:35:53 EST
Created attachment 56792 [details]
Generalize  /webtools/phoenix/main.php to grab the title dynamically
Comment 11 Arthur Ryman CLA 2007-01-11 17:54:46 EST
Bob, Looks good. Applied.
Comment 12 Bob Fraser CLA 2007-01-11 18:37:50 EST
Verified, thanks.
Comment 13 Bob Fraser CLA 2007-01-11 19:09:28 EST
One more small patch before I make a larger update.

Add ATF description to /webtools/project-info
Add dali description to /webtools/project-info
Add a main.php to /webtools/dali to serve up a phoenix style /webtools/dali subproject page.
NOTE - this is totally unrelated to the http://www.eclipse.org/dali/ page.
Comment 14 Bob Fraser CLA 2007-01-11 19:11:07 EST
Created attachment 56810 [details]
Add a phoenix style dali subproject page
Comment 15 Arthur Ryman CLA 2007-01-11 19:34:22 EST
Bob - committed.
Comment 16 Bob Fraser CLA 2007-01-11 19:45:07 EST
Verified, thanks
Comment 17 Bob Fraser CLA 2007-01-12 14:16:55 EST
Final patch for phase one. Add a number of Phoenix style web pages. Areas like Community and People will need to come in a later patch as they will need different XSL processing.
Comment 18 Bob Fraser CLA 2007-01-12 14:18:19 EST
Created attachment 56844 [details]
Add a number of Phoenix style web pages
Comment 19 Arthur Ryman CLA 2007-01-15 18:34:33 EST
Adding Tim on the cc list.

Tim, as my PMC delegate and a committer, please handle Bob's patches since I'll be travelling the week. Thx.
Comment 20 Arthur Ryman CLA 2007-01-15 18:36:20 EST
Tim, pls handle this patch to confirm there are no problems. Thx.
Comment 21 Tim deBoer CLA 2007-01-17 13:40:49 EST
Sorry, Bob. I was as well have been on a plane the last day and a half considering how much time I haven't been in a meeting.

Checked out WTP website... could we possibly have more bloat? I think it's still checking out. :)

Applied patch and committed. Please verify on the website and I'll try to be quicker next time.
Comment 22 Bob Fraser CLA 2007-01-17 14:27:38 EST
Verified, thanks
Comment 23 Bob Fraser CLA 2007-01-25 11:57:01 EST
Starting round two.  This patch adds a new template in /webtools/phoenix/page.php.  This template creates a Phoenix style of page, driven from the <section> and <infobox> style of document. (See /webtools/phoenix/page.xml for an example)

Other changes:
 * Phoenix enabled the "about" and "development" pages
 * Minor change to color and placement of page subtitles
 * Added a link to the WTP Project wiki to the left side nav (under Development)

Comment 24 Bob Fraser CLA 2007-01-25 11:59:08 EST
Created attachment 57526 [details]
Phoenix about and development pages.
Comment 25 Bob Fraser CLA 2007-01-25 12:01:04 EST
Created attachment 57527 [details]
Phoenix enable about and development pages - This time as patch
Comment 26 Tim deBoer CLA 2007-01-25 12:37:37 EST
Patch from comment #25 applied, please verify on the website.
Comment 27 Bob Fraser CLA 2007-01-25 14:23:22 EST
I believe everything is working.  I am getting some 404s but I think that is bad browser cache behavior on my side.

Thanks.
Comment 28 Bob Fraser CLA 2007-01-26 19:19:03 EST
I added documentation of the Phoenix templates to the Web Tools project wiki:

http://wiki.eclipse.org/index.php/Using_Web_Tools_Phoenix_PHP_templates
All comments welcome
Comment 29 Arthur Ryman CLA 2007-01-27 16:45:35 EST
Thx for the wiki pages. Looks very useful. How about adding info on how to set up a local development environment so you can test the PHP before committing fixes?
Comment 30 Bob Fraser CLA 2007-01-30 13:16:13 EST
Done.  As always comments welcome.

http://wiki.eclipse.org/index.php/Web_Tools_Web_Site_Development_Setup
Comment 31 Bob Fraser CLA 2007-02-08 18:00:18 EST
Here is the patch that will cut over the Web Tools Web Site to the Phoenix enabled pages.

I modified a number of html pages to redirect to php pages:
adopters/index.html
atf/index.html
dali/index.html
development/main.html
development/bugs/bugs.html
jsf/index.html
jst/main.html
wst/main.html
about.html
main.html
index.html

I also modified build.xml to not overwrite these html files.
Comment 32 Bob Fraser CLA 2007-02-08 18:02:46 EST
Created attachment 58615 [details]
Patch to cut the Web Tools Web site over to the Phoenix pages
Comment 33 Bob Fraser CLA 2007-02-08 18:05:03 EST
Please test carefully.  If something does go wrong, it would be easy to undo this.  Just revert the build.xml and invoke the html target with force=true and the old html pages will reappear.
Comment 34 Lawrence Mandel CLA 2007-02-09 12:59:52 EST
Bob, I'm seeing a lot of errors when testing locally. Do you have any tips on configuring my environment to match the Eclipse.org environment?

Comment 35 Bob Fraser CLA 2007-02-09 13:05:20 EST
Try the following set up instructions:

http://wiki.eclipse.org/index.php/Web_Tools_Web_Site_Development_Setup
Comment 36 Kaloyan Raev CLA 2007-02-09 13:08:54 EST
Hello, I have tested the address:
http://www.eclipse.org/webtools/main.php
with both IE7 (win) and FF2 (linux). 

It looks very good. Just one remark: the label "Committers/Contributors" is too long and does not fit in the left side menu. I suggest that if you insert spaces around the slash char (i.e. "Committers / Contributors") the label will be wrapped in two lines. 
Comment 37 Lawrence Mandel CLA 2007-02-09 13:16:37 EST
Ah, never mind my previous comment. I just saw your follow-up post on the mailing list.

Good work on updating the site. A few comments:

1. On the WTP home page the new items are listed in small font on the side. As these announcements are changing I think they'll be of primary interest to visitors to the page and should get more screen real estate such as the news items get on the eclipse.org home page. Also, these news items do not display links and images added as they did before. Can this be fixed so the images and links are displayed?

2. The menu looks very long. Is there anything that can be done to reduce the number of items displayed? Perhaps submenus should only be displayed once a root menu has already been selected. For example, clicking on documentation can take the user to a documentation page that has links to user and extender documentation. The subprojects are already listed on the home page and may not need to be listed in the menu as well.

3. For ATF and Dali why not just link directly to the project pages? Why have the intermediate page that has a short description of the project?
Comment 38 Bob Fraser CLA 2007-02-12 17:32:54 EST
Thanks for the feedback.  I will create a patch parallel to the cutover patch to implement some of the feedback.  This patch could be applied before or after the cutover patch.
Comment 39 Bob Fraser CLA 2007-02-12 19:25:33 EST
> 1. On the WTP home page the new items are listed in small font on the side.
I see three options
 1) Put news in center.  It will be "below the fold" (need to scroll).
 2) Split the center.  Projects in center left and news in center right.
 3) Leave it the way it is (far right small column)

What do y'all think?  I favor 3 then 1.
Comment 40 Bob Fraser CLA 2007-02-12 19:33:57 EST
> 2. The menu looks very long.
I will submit a patch that implements folding nav menus. The trade off is we have to keep the _projectCommon.php files in webtools ./development ./community and ./documentation all in sync manually.  I kept the subprojects in the left hand nav.

The patch also fixes the "Committers/Contributors" label.
Comment 41 Bob Fraser CLA 2007-02-12 19:35:13 EST
Created attachment 58813 [details]
Patch to implement folding navigation menus
Comment 42 Bob Fraser CLA 2007-02-12 19:40:37 EST
> 3. For ATF and Dali why not just link directly to the project pages?
The main project page was modeled from webtools/main.html which links to intermediate pages.  Now that ATF is phoenix enabled, I am happy to make a patch to link directly to eclipse/atf.  But it would be nice if they link back to the WTP project.  Who do I work with on atf to get an update to their _projectCommon.php to refer back to Webtools?
Comment 43 Lawrence Mandel CLA 2007-02-12 22:29:20 EST
In response to comment #39, how about above the list of subprojects? The subprojects are also listed in the nav so they should still be visible. To reiterate my previous comment, I think the news will be of primary interest to the WTP site's frequent visitors.

In response to comment #40, thanks!

In response to comment #42, good suggestion. I think getting in touch with the ATF team is the right approach. I'm not sure who's responsible for the ATF web site. You might try speaking with Bob Goodman[1].

[1]http://www.eclipse.org/webtools/people/goodman.html
Comment 44 Arthur Ryman CLA 2007-02-13 01:49:00 EST
Bob, What's the status of the patches? Are these just for evaluation or are they ready to be applied? 
Comment 45 Tim deBoer CLA 2007-02-13 10:35:50 EST
Patches were ready to be applied, and a secondary discussion was held on the WTP mailing list and weekly PMC meeting. The PMC agreed to the official switch to Phoenix today.

Tagged entire website as "v20070213" before applying patch in case we need to revert anything. Patches #32 & #41 released, and looks great live. WTP has officially switched to Phoenix. Thanks, Bob!

Since the official switch has now occurred, shall we close this defect and track remaining/new issues via new bugs?
Comment 46 Bob Fraser CLA 2007-02-13 11:25:42 EST
> From comment #43
> how about above the list of subprojects?
Excellent suggestion.  Sold.  Unless there are objections, I will work on moving the news to the center pane.  I will also investigate issues with the news feed.  You are right, links and images are lost in the body content.  Also date is broken.
Comment 47 Lawrence Mandel CLA 2007-02-13 14:24:22 EST
No objections here. Thanks for your continued work on the site Bob.
Comment 48 Bob Fraser CLA 2007-02-13 14:37:41 EST
I have a patch that moves the news feed from the right column to the center top.
Comment 49 Bob Fraser CLA 2007-02-13 14:38:32 EST
Created attachment 58880 [details]
Center the news feed
Comment 50 Bob Fraser CLA 2007-02-13 16:39:56 EST
Ignore the center news feed patch.  The patch ended up duplicating an existing function.
I will provide a new patch that accomplishes the same thing but uses the org.eclipse-common/rss_to_html function.
Comment 51 Bob Fraser CLA 2007-02-13 16:53:01 EST
Resubmitting patch to move the news to the center pane.  Use the existing rss_to_html function in /community/news/scripts/news.php
Comment 52 Bob Fraser CLA 2007-02-13 16:54:08 EST
Created attachment 58906 [details]
Better way to center the news
Comment 53 Bob Fraser CLA 2007-02-13 20:00:24 EST
Found the reason dates are not appearing in our news feed.  We have strange characters in our rss feed that will not make it through the date parse. I have tried emacs, eclipse, and notepad and haven't been able to make them go away as they all try to preserve encoding. Still trying.
Comment 54 Bob Fraser CLA 2007-02-15 18:03:15 EST
Found the root cause of dates not appearing rss20.xsl is inserting literal &#160; (&nbsp;) chars which breaks the date parser downstream.  I will file a separate bug to resolve the issue.
Comment 55 Tim deBoer CLA 2007-02-15 18:14:50 EST
Patch from comment #52 released.
Comment 56 Bob Fraser CLA 2007-02-16 10:45:38 EST
Looks good, thanks.
Comment 57 Lawrence Mandel CLA 2007-02-20 13:41:19 EST
Just saw the news on the WTP home page. Nice work.
Comment 58 Bob Fraser CLA 2007-02-20 17:55:21 EST
Links and images in the content section of the feed still don't work.  We will have to file an enhancement request on org.eclipse-common/rss_to_html.
Comment 59 Bob Fraser CLA 2007-02-20 18:35:06 EST
Spoke too soon.  The links are not in the RSS feed either. I believe html entities are getting stripped out of the description field of the feed upon xsl processing.  I will take a look at it.
Comment 60 Tim deBoer CLA 2007-02-22 15:04:13 EST
Closing this bug since all main pages on the website are complete and have been working fine on Phoenix for a couple weeks. Please open new bugs for any problems found or pages that haven't been transferred.

Excellent work, Bob!
Comment 61 Arthur Ryman CLA 2007-03-18 20:40:22 EDT
I see that the main pages are converted, but there are still unconverted pages, e.g. the contributor page, http://www.eclipse.org/webtools/people/contributors.html

This bug is for the whole site. Let's keep this open to cover the remaining work.
Comment 62 Bob Fraser CLA 2007-04-19 13:47:59 EDT
I am working on the conversion of the people pages to the Phoenix LAF and I have some questions on approach.  So I created bugzilla 183225.  Please feel free to join the conversation there.  I would love your opinions.
Comment 63 Bob Fraser CLA 2007-04-19 13:49:25 EDT
Here's a direct link:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=183225
Comment 64 Lawrence Mandel CLA 2007-04-19 14:24:54 EDT
Bob, in the future you can just state bug 183225 and bugzilla will create the link for you. :)
Comment 65 David Williams CLA 2007-09-04 01:00:52 EDT
I believe all the major areas have been converted. 

Bob, please correct me if I'm wrong and re-open this bug. 

In the future, if there's specific areas that need work, specific bugs should be open for those areas. 

Thanks all. 

Comment 66 Bob Fraser CLA 2007-09-07 12:16:24 EDT
Closing