portlet-guide

Guidelines for developing portlets

alpha pre-release!!!!

Meta

Table of contents

Being a Portlet

Being a Portlet in uPortal

Markup and CSS

JavaScript

UI conventions

Voice

Being a portlet product

Scope

This is the portlet style guide.

In-scope

Examples of topics in-scope (but not treated yet in this guide):

Out-of-scope

Examples of topics out-of-scope:

See also

Other guides that might be relevant:

Be kind

Be kind to your users. Be kind to your fellow developers. Be especially kind to those who especially struggle, who struggle to understand your portlet, who struggle to navigate the portal, who struggle to understand, support, and build upon your work, who struggle to make the most of the richness and complexity of the University. The purpose of a portlet development guide is to guide development towards processes, products, and experiences that are more kind.

A kind portlet is a usable, accessible, adoptable, supportable, maintainable, loved portlet.

Modifying and writing portlets is a tiny little opportunity to be kind. Certainly nothing like the most important such opportunities you will enjoy, but when life hands you an opportunity to be kind, take it.

Take care to be kind when applying this guide to others' work. The guide is not intended as a blunt instrument. Portlet development, like much of life, requires poise and charm.

Life's most persistent and urgent question is, "What are you doing for others?"

- Martin Luther King, Jr.

Be Kind to the Portal

Being a Portlet

Hipster Ipsum

Documentation goes here. Beard keytar VHS blog, photo booth church-key Bushwick flannel stumptown Thundercats Blue Bottle. Raw denim gluten-free sartorial brunch cliche. Locavore synth master cleanse, keffiyeh bitters Pitchfork Brooklyn asymmetrical YOLO beard distillery Carles fashion axe. 90's single-origin coffee deep v, Cosby sweater fingerstache banjo Tumblr organic ethnic bespoke kogi gluten-free lo-fi chillwave. Helvetica food truck fanny pack, quinoa wayfarers wolf literally banh mi chambray banjo chia hella single-origin coffee. Selvage Banksy literally trust fund paleo Thundercats High Life, Godard vinyl drinking vinegar wolf banjo. Mumblecore whatever organic PBR typewriter, butcher occupy dreamcatcher wayfarers vinyl pop-up.

Examples and further explanation go here.

Another list of some other stuff

Another guideline

Details about something that can be explained with a picture.

Yet another guideline

Something that needed explaining with a bigger picture.

Being a Portlet in uPortal

Markup and CSS

JavaScript

TODO: say something intelligent about JavaScript in the context of portlets. Somehow JavaScript is not turning out to be a passing fad.

Be kind to the users

UI Conventions

Voice

App not portlet

The components in MyUW are called "Apps", not portlets, though they may technically be JSR-286 portlets. App is always capitalized where it appears in the UI (i.e., "App"). "An App" rather than "A App".

Examples

Be kind to your fellow developers and the portal community

Portlet as Product