Virginia Tech is pleased to offer a uPortal 2.4.2 Quick Start with most of our My VT modifications applied. For a preview/summary of our changes, take a look at our online tour.
| Warning | ||
|---|---|---|
| ||
Please put comments at the end of this document if things are unclear/incomplete/incorrect and I will update the documentation. I'm just trying to get this out the door, so the document will evolve over time. |
What's in the Quick Start
...
- Log on with demo/demo
- Click the Change Content button
- Create a new tab
- Rename the tab to: tab::Chicken
- Click the Add Default Page link
- Click the Add Main Column link
- Click the Add Side Column button
- Rename the tab to: tab::Home*
- Click the Finished Changing Content button
Using Tab/Page/Column
Tab/Page/Column is a custom structure transform for uPortal that allowed us to have multiple levels of tabs using pushed fragments. Check out the sample fragments.xml to see an actual fragment definition XML. Here are the general guidelines for using Tab/Page/Column:
- Tabs are folders with a name: tab::<Tab Name>
- Pages are folders with a name: page::<Page Name>
- Columns are folders with a name: column::<Column Name>
- Channels are regular <channel> elements
- The root layout can contain Tabs and Columns
- Tabs can contain Tabs and Pages
- Pages can contain Pages and Columns
- Columns can contain Channels
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="UTF-8"?>
<layout>
<folder ID="userLayoutRootNode" type="regular" hidden="false"
unremovable="true" immutable="false" name="Root folder" priority="0">
<folder ID="3" type="regular" hidden="false" unremovable="true"
immutable="true" name="tab::Administration" priority="20003">
<folder ID="14-2" type="regular" hidden="false"
unremovable="true" immutable="true"
name="tab::Channel Manager" priority="2147483646">
<folder ID="14-3" type="regular" hidden="false"
unremovable="true" immutable="true"
name="page::default" priority="0">
<folder ID="14-4" type="regular" hidden="false"
unremovable="true" immutable="true"
name="column::main-column" priority="0">
<channel .../>
</folder>
</folder>
</folder>
<folder ID="14-14" type="regular" hidden="false"
unremovable="true" immutable="true" name="page::default" priority="2147483643">
<folder ID="14-15" type="regular" hidden="false"
unremovable="true" immutable="true"
name="column::main-column" priority="0">
<channel .../>
</folder>
</folder>
</folder>
<folder ID="4" type="regular" hidden="false" unremovable="true"
immutable="true" name="column::footer" priority="19998">
<channel .../>
</folder>
</folder>
</layout>
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="UTF-8"?>
<layout userName="" newNodeID="6" ID="userLayoutRootNode" mode="edit"
page="default" tab="5" authenticated="true">
<tab name="Administration" ID="3" locked="yes" type="system">
<tab name="Channel Manager" ID="14-2" locked="yes" type="system">
<page name="default" ID="14-3" locked="yes" type="system">
<column name="main-column" ID="14-4" locked="yes" type="system">
<channel .../>
</column>
</page>
</tab>
<page name="default" ID="14-14" locked="yes" type="system">
<column name="main-column" ID="14-15" locked="yes" type="system"/>
</page>
</tab>
<column name="footer" ID="4" locked="yes" type="system">
<channel .../>
</column>
</layout>
|
Navigating Tabs and Pages
Use the navigate.jsp file to create links inside of channels to tabs, pages, and channels.Example: . The JSP takes 4 parameters:
- tab - the ID or name of the tab to navigate to. Note: Navigating by name only works for tabs defined via tab::Name.
- page - the name of the page to navigate to. Note: You must specify a tab as well.
- channel - the fname of the channel to load full screen
- root=root - Returns to the "normal" view of the portal from a full screen channel
To go to the default page of the Home tab:
/uPortal/navigate.jsp?tab=Home&page=default
To show the CNET News.com channel in full screen:
/uPortal/navigate.jsp?channel=cnet-news-com
To return to normal view from full screen channel view:
/uPortal/navigate.jsp?root=root
Common Tasks
Publishing a Channel
At the command line, run: ant pubchan -Dchannel=<Channel Filename>
Example: ant pubchan -Dchannel=cnet-news-com.xml
...
Adding a User
At the command line, run: ant md5passwd -Dusername=<Username>
Example: ant md5passwd -Dusername=bcjones
Known Bugs
- Images for folders and channels in the Content Subscriber channel do not work. The image files are licensed by VT and cannot be distributed, I have not yet updated the XSLT to point to generic versions.