|
News Portkey > Documentation
The appearance and content of the Wizard News Portkey can be altered by adding
one or more options to the portkey command line. For example:
- portkey.cgi?bordercolor=darkgreen&match=Deathly+Hallows
The optional settings are separated from the portkey.cgi command with a ? symbol
and then, if there are more than one option, each option is separated from one
another with an & symbol.
Each option has a default value. If you want to use the default value of an option,
it's not necessary to specify the option at all.
These are the optional settings you can add to the portkey command line to customize
the appearance of the News Portkey on your web site:
- count
- Change the number of news items listed.
default: 6, maximum: 10
example: count=4
- topic
- Specify whether to show Harry Potter or Lord of the Rings news.
default: harrypotter
example: topic=lordoftherings
example: topic=all
- match
- Only shows headlines matching specified string. Replace any spaces in search string with a + symbol. Searches are
done case-insensitive, but a search string with the proper capitalization will look better in the header of the portkey
box.
Note: The portkey only shows very recent news, a search string that is not constantly in the news will frequently result
in no headlines returned.
default: none
example: match=Half-Blood+Prince
example: match=Prisoner+of+Azkaban
- linktype
- Specifies whether links in the news display will open in the browser's current window or open a new window.
default: currentwindow
example: linktype=newwindow
- format
- Specifies whether to show news listing in table format or plain html text.
Use the plain text option to combine the News Portkey with the look and feel
already on your web site.
default: table
example: format=text
The following settings apply when using table format only:
- width
- Changes the width of the table. Can either be an absolute number of pixels or a
percentage of window space.
default: table takes up as much width as longest headline
example: width=160
example: width=100%
- fontface
- Changes font used in table. Be careful to only specify a font that all computers
have.
default: arial
example: fontface=courier
example: fontface=verdana
- fontsize
- Changes the font size of text in the table.
default: 2
example: fontsize=1
- color
- Changes the color of the non-link text in the table.
Note: Do NOT preface a hex color combination with the # symbol.
default: black
example: color=red (or any valid color name)
example: color=FF0000 (or any hex color combination)
- bgcolor
- Changes the background color of the table.
default: white
- bordercolor
- Changes the color of the border of the table.
default: black
- linkcolor
- Changes the color of links in the table.
default: blue
- hlinkcolor
- Changes the color of the links when the mouse is hovering over them.
default: darkred
More customization features may be added in the future, and ideas for new
customizations from webmasters may be considered. We appreciate your ideas
and comments.
The News Portkey is Copyright © 2005-2008, David Haber
|