Dreamwidth S2 Core, v2

[<< Advanced Customization]
[<< Public Layers] [View Source: Raw Source Code | Syntax Highlighted]

Layer Info

author_email	webmaster@dreamwidth.org
author_name	Dreamwidth Webmaster
majorversion	2
name	Dreamwidth S2 Core, v2
redist_uniq	core2
type	core

Properties Set

all_commentsubjects	0
all_entrysubjects	1
color_comment_bar	#d0d0ff
comment_date_format	iso
comment_datetime_format_group	[ comment_date_format, comment_time_format, ]
comment_interaction_links	text
comment_management_links	icons
comment_page_next	>&gt
comment_page_prev	<&lt
comment_time_format	short
comment_userpic_style	(empty)
custom_background_element	(empty)
custom_colors_template	(empty)
custom_control_strip_colors	off
custom_css	(empty)
custom_foreground_element	(empty)
entry_date_format	med
entry_datetime_format_group	[ entry_date_format, entry_time_format, ]
entry_interaction_links	text
entry_management_links	icons
entry_metadata_position	bottom
entry_time_format	short
entry_userpic_style	(empty)
external_stylesheet	1
font_base	(empty)
font_fallback	(empty)
icons_page_sort	upload
image_background_entry_group	[ image_background_entry_url, image_background_entry_repeat, image_background_entry_position, ]
image_background_header_group	[ image_background_header_url, image_background_header_repeat, image_background_header_position, ]
image_background_module_group	[ image_background_module_url, image_background_module_repeat, image_background_module_position, ]
image_background_page_group	[ image_background_page_url, image_background_page_repeat, image_background_page_position, ]
include_default_stylesheet	1
lang_current	en
lang_dayname_long	[ (empty), Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, ]
lang_dayname_short	[ (empty), Sun, Mon, Tue, Wed, Thu, Fri, Sat, ]
lang_dayname_shorter	[ (empty), S, M, T, W, T, F, S, ]
lang_fmt_date_iso	%%yyyy%%-%%mm%%-%%dd%%
lang_fmt_date_long	%%month%% %%dayord%%, %%yyyy%%
lang_fmt_date_long_day	%%day%%, %%month%% %%dayord%%, %%yyyy%%
lang_fmt_date_long_day_dayfirst	%%day%%, %%d%% %%month%% %%yyyy%%
lang_fmt_date_long_dayfirst	%%d%% %%month%% %%yyyy%%
lang_fmt_date_med	%%mon%%. %%dayord%%, %%yyyy%%
lang_fmt_date_med_day	%%da%%, %%mon%%. %%dayord%%, %%yyyy%%
lang_fmt_date_med_day_iso	%%yyyy%%-%%mon%%-%%dd%%, %%day%%
lang_fmt_date_med_dayfirst	%%d%% %%mon%% %%yyyy%%
lang_fmt_date_short	%%m%%/%%d%%/%%yy%%
lang_fmt_date_short_dayfirst	%%d%%/%%m%%/%%yy%%
lang_fmt_date_short_dayfirst_full	%%dd%%/%%mm%%/%%yyyy%%
lang_fmt_month_long	%%month%% %%yyyy%%
lang_fmt_month_med	%%mon%% %%yyyy%%
lang_fmt_month_short	%%m%%/%%yy%%
lang_fmt_time_short	%%hh%%:%%min%% %%a%%m
lang_fmt_time_short_24	%%HH%%:%%min%%
lang_monthname_long	[ (empty), January, February, March, April, May, June, July, August, September, October, November, December, ]
lang_monthname_short	[ (empty), Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, ]
layout_authors	[]
layout_resources	[]
layout_type	(empty)
linked_stylesheet	(empty)
linklist_support	1
margins_size	0
margins_unit	em
module_active_group	[ module_active_show, module_active_order, module_active_section, ]
module_active_order	8
module_active_section	one
module_active_show	1
module_calendar_group	[ module_calendar_show, module_calendar_order, module_calendar_section, module_calendar_opts_group, ]
module_calendar_opts_group	[ module_calendar_opts_type, ]
module_calendar_order	3
module_calendar_section	one
module_calendar_show	1
module_credit_group	[ module_credit_show, module_credit_order, module_credit_section, ]
module_credit_order	14
module_credit_section	one
module_credit_show	1
module_customtext_group	[ module_customtext_show, module_customtext_order, module_customtext_section, ]
module_customtext_order	13
module_customtext_section	one
module_customtext_show	0
module_cuttagcontrols_group	[ module_cuttagcontrols_show, module_cuttagcontrols_order, module_cuttagcontrols_section, ]
module_cuttagcontrols_order	16
module_cuttagcontrols_section	one
module_cuttagcontrols_show	1
module_layout_sections	none|(none)|one|Main Module Section|two|Secondary Module Section
module_links_group	[ module_links_show, module_links_order, module_links_section, ]
module_links_order	4
module_links_section	one
module_links_show	1
module_navlinks_group	[ module_navlinks_show, module_navlinks_order, module_navlinks_section, ]
module_navlinks_order	2
module_navlinks_section	one
module_navlinks_show	1
module_pagesummary_group	[ module_pagesummary_show, module_pagesummary_order, module_pagesummary_section, module_pagesummary_opts_group, ]
module_pagesummary_opts_comments_tooltip	1
module_pagesummary_opts_group	[ module_pagesummary_opts_comments_tooltip, ]
module_pagesummary_order	7
module_pagesummary_section	one
module_pagesummary_show	1
module_poweredby_group	[ module_poweredby_show, module_poweredby_order, module_poweredby_section, ]
module_poweredby_order	12
module_poweredby_section	two
module_poweredby_show	1
module_search_group	[ module_search_show, module_search_order, module_search_section, ]
module_search_order	15
module_search_section	one
module_search_show	1
module_subscriptionfilters_group	[ module_subscriptionfilters_show, module_subscriptionfilters_order, module_subscriptionfilters_section, ]
module_subscriptionfilters_order	17
module_subscriptionfilters_section	one
module_subscriptionfilters_show	0
module_syndicate_group	[ module_syndicate_show, module_syndicate_order, module_syndicate_section, ]
module_syndicate_order	5
module_syndicate_section	one
module_syndicate_show	1
module_tags_group	[ module_tags_show, module_tags_order, module_tags_section, module_tags_opts_group, ]
module_tags_opts_count_type	(empty)
module_tags_opts_group	[ module_tags_opts_limit, module_tags_opts_type, ]
module_tags_opts_limit	50
module_tags_opts_type	(empty)
module_tags_order	6
module_tags_section	one
module_tags_show	1
module_time_group	[ module_time_show, module_time_order, module_time_section, ]
module_time_order	11
module_time_section	two
module_time_show	1
module_userprofile_group	[ module_userprofile_show, module_userprofile_order, module_userprofile_section, module_userprofile_opts_group, ]
module_userprofile_opts_group	[ module_userprofile_opts_userpic, module_userprofile_opts_name, module_userprofile_opts_website, ]
module_userprofile_opts_name	1
module_userprofile_opts_userpic	1
module_userprofile_opts_website	1
module_userprofile_order	1
module_userprofile_section	one
module_userprofile_show	1
num_items_icons	0
num_items_reading	20
num_items_recent	20
reg_firstdayofweek	sunday
reverse_sortorder_day	0
reverse_sortorder_group	[ reverse_sortorder_year, reverse_sortorder_month, reverse_sortorder_day, ]
reverse_sortorder_month	0
reverse_sortorder_reading	1
reverse_sortorder_recent	1
reverse_sortorder_year	0
separator_image_group	[ separator_image_url, separator_image_repeat, separator_image_position, ]
sidebar_width	(empty)
sidebar_width_doubled	(empty)
tags_aware	1
tags_page_count_type	(empty)
tags_page_type	multi
text_admin_post_note	as admin
text_admin_post_subject	Admin Post:
text_base_layout_authors	Base style:
text_calendar_num_entries	1 entry // # entries
text_comment_date	Date:
text_comment_edittime	Edited
text_comment_expand	Expand
text_comment_from	From:
text_comment_frozen	Frozen
text_comment_hide	Hide 1 comment // Hide # comments
text_comment_ipaddr	IP Address:
text_comment_link	Link
text_comment_parent	Parent
text_comment_posted	Comment successfully posted.
text_comment_reply	Reply
text_comment_thread	Thread
text_comment_threadroot	Thread from start
text_comment_unhide	Show 1 comment // Show # comments
text_comments_disabled_maintainer	Comments disabled by an administrator of this community
text_commentview_flat	Flat
text_commentview_threaded	Threaded
text_commentview_toponly	Top-Level Comments Only
text_cuttagcontrols_nocuttags	No cut tags
text_day_next	Next Day
text_day_prev	Previous Day
text_default_separator	|
text_deleted	(deleted comment)
text_edit_comment_title	Edit reply
text_edit_entry	Edit Entry
text_edit_tags	Edit Tags
text_entry_next	Next Entry
text_entry_prev	Previous Entry
text_fromsuspended	(reply from suspended user)
text_frozen	(frozen)
text_generated_on	Page generated
text_icon_alt_18	[18+]
text_icon_alt_admin_post	[admin post]
text_icon_alt_groups	[custom friends groups post]
text_icon_alt_nsfw	[NSFW]
text_icon_alt_private	[private post]
text_icon_alt_protected	[protected post]
text_icon_alt_sticky_entry	[sticky entry]
text_icon_manage	Manage Icons
text_icons_comment	Comment:
text_icons_default	Default
text_icons_description	Description:
text_icons_inactive	Inactive
text_icons_keyword_sep	,
text_icons_keywords	Keywords:
text_icons_page_empty_header	No Icons
text_icons_page_header	Current Icons
text_icons_sort_keyword	Keyword Order
text_icons_sort_upload	Upload Order
text_layout_authors	Style:
text_layout_resources	Resources:
text_linklist_manage	Manage Links
text_max_comments	Maximum comments reached
text_mem_add	Add Memory
text_meta_groups	Custom Access Groups:
text_meta_location	Current Location:
text_meta_mood	Current Mood:
text_meta_music	Current Music:
text_meta_xpost	Crossposts:
text_module_active_entries	Active Entries
text_module_credit	Style Credit
text_module_customtext	Custom Text
text_module_customtext_content	(empty)
text_module_customtext_url	(empty)
text_module_cuttagcontrols	Expand Cut Tags
text_module_links	Links
text_module_pagesummary	Page Summary
text_module_popular_tags	Most Popular Tags
text_module_search	Search
text_module_search_btn	Search
text_module_subscriptionfilters	Subscription Filters
text_module_syndicate	Syndicate
text_module_tags	Tags
text_module_userprofile	Profile
text_month_form_btn	View
text_month_screened_comments	w/ Screened
text_multiform_btn	Perform Action
text_multiform_check	Select:
text_multiform_conf_delete	Delete selected comments?
text_multiform_des	Mass action on selected comments:
text_multiform_opt_delete	Delete
text_multiform_opt_deletespam	Delete as Spam
text_multiform_opt_edit	Edit
text_multiform_opt_freeze	Freeze
text_multiform_opt_screen	Screen
text_multiform_opt_track	Track This
text_multiform_opt_unfreeze	Unfreeze
text_multiform_opt_unscreen	Unscreen
text_multiform_opt_unscreen_to_reply	Unscreen to reply
text_multiform_opt_untrack	Untrack This
text_new_comment_title	Reply
text_noentries_day	There were no entries on this day.
text_noentries_read	There are no earlier entries to display. This page displays only the most recent 1000 entries posted within the last 14 days.
text_noentries_recent	There are no entries to display.
text_nosubject	(no subject)
text_nosubject_screenreader	no subject
text_openid_from	from
text_page_top	Top of page
text_permalink	Link
text_post_comment	Reply
text_post_comment_friends	Reply
text_poster_anonymous	(Anonymous)
text_posting_in	posting in
text_powered_by	Powered by
text_read_comments	1 comment // # comments
text_read_comments_friends	1 comment // # comments
text_read_comments_screened	1 screened comment // # screened comments
text_read_comments_screened_visible	1 visible // # visible
text_read_comments_threads	1 response // # responses
text_reply_back	Read Comments
text_reply_nocomments	Comments have been disabled for this post.
text_reply_nocomments_header	Comments Disabled:
text_replyform_header	Comment Form
text_screened	(screened comment)
text_skiplinks_back	Previous #
text_skiplinks_forward	Next #
text_stickyentry_subject	Sticky:
text_subscriptionfilters_manage	Manage Filters
text_tag_uses	1 use // # uses
text_tags	Tags:
text_tags_item_sep	,
text_tags_manage	Manage Tags
text_tags_page_header	Visible Tags
text_tagsmultilevel_delimiter	:
text_tell_friend	Share This Entry
text_theme_authors	Theme:
text_unwatch_comments	Untrack This
text_view_archive	Archive
text_view_day	Day
text_view_entry	Entry
text_view_friends	Reading
text_view_friends_comm	Member Posts
text_view_friends_filter	Reading (Custom filter)
text_view_icons	Icons
text_view_memories	Memories
text_view_month	View Subjects
text_view_monthpage	Month
text_view_network	Network
text_view_network_filter	Network (Custom filter)
text_view_recent	Recent Entries
text_view_recent_tagged	Entries tagged with
text_view_tags	Tags
text_view_userinfo	Profile
text_watch_comments	Track This
text_website_default_name	My Website
theme_authors	[]
time_ago_days	1 day // # days
time_ago_hours	1 hour // # hours
time_ago_minutes	1 minute // # minutes
time_ago_seconds	1 second // # seconds
use_custom_friend_colors	0
use_journalstyle_entry_page	1
use_journalstyle_icons_page	0
use_shared_pic	0
userlite_interaction_links	icons
userpics_position	left
userpics_style_group	[ entry_userpic_style, comment_userpic_style, ]

Global Functions

PalItem(int index, Color c) : PalItem	Convenience constructor to make populating an array of PalItems (like in palimg_modify(string,PalItem[])) easy.
UserLite(string username) : UserLite	Constructor for making a UserLite object from a username
alternate(string a, string b) : string	With each call, this function will alternate between the two values and return one of them. Useful for making tables whose rows alternate in background color.
clean_css_classname(string classname) : string	Provide a version of a string that's always suitable for classnames, with potentially suspicious words present in original and modified forms.
clean_url(string s) : string	Returns the given URL back if it's a valid URL.
close_module() : void
close_module(bool nocontent) : void
control_strip_logged_out_full_userpic_css() : string	Returns CSS for the loggedout_userpic div in the logged out version of the control strip.
control_strip_logged_out_userpic_css() : string	Returns CSS for the userpic div in the logged out version of the control strip.
ehtml(string s) : string	Escapes all HTML tags and entities from the text
end_css() : void	Declare that you're done printing CSS and the output thus buffered should be cleaned and printed.
etags(string s) : string	Escapes all HTML tags (but not entities) from text
eurl(string s) : string	URL escape
generate_background_css(string background_image, string background_image_repeat, string background_image_position, Color background_color) : string	Take the values for the properties in a background image group and output the appropriate line of CSS for inclusion in your stylesheet.
generate_color_css(Color text_color, Color background_color, Color border_color) : string	Take the color property values and return the appropriate lines of CSS for your style sheet.
generate_font_css(string font_base, string font_fallback, string font_size, string font_unit) : string
generate_font_css(string font_specific, string font_base, string font_fallback, string font_size, string font_unit) : string
generate_image_url(string image_path) : string	Take an image property and append style image directory path if not given absolute path
generate_large_media_query() : string
generate_media_query(string user_breakpoint, int sidebar_width_multiplier, string default_min_width) : string
generate_medium_media_query() : string
get_image(string key) : Image	Given an image key to look up, returns an Image object populated with src, width, height taken from the standard images used by S2. Image object may be null if key is not valid
get_page() : Page	Gets the top-level Page instance that Dreamwidth ran the Page.print() method on.
get_plural_phrase(int n, string prop) : string	Picks the phrase with the proper plural form from those in the property $prop, passing $n to lang_map_plural(int) to get the proper form for the current language, and then substituting the # character with $n. Also, returned string is HTML-escaped.
get_url(UserLite user, string view) : string	Returns a URL to the specified view for the specified user. Views use the same names as elsewhere. (recent, friends, archive, month, userinfo)
get_url(string user, string view) : string	Returns a URL to the specified view for the specified user. Views use the same names as elsewhere. (recent, friends, archive, month, userinfo)
handle_module_group_array(string[][] list) : void
htmlattr(string name, int value) : string	If the value isn't blank, return in HTML attribute format with a leading space. HTML of name is not escaped.
htmlattr(string name, string value) : string	If the value isn't blank, return in HTML attribute format with a leading space. HTML of name is not escaped.
int(string s) : int	Convert the string to an integer and return
journal_current_datetime() : DateTime	Returns the current datetime in the timezone of the journal being viewed.
journal_subscription_filters() : SubscriptionFilter[]	Returns the subscription filters for the journal being viewed, in sort order.
keys_alpha(string{} elements) : string[]	Return the keys of the array in alphabetically sorted order.
lang_at_datetime(DateTime d) : string	Returns a string saying "at {the data and time given}". Used in the core implementation of EntryPage and ReplyPage. i18nc layers should override this.
lang_icon_sortorder_title(string which) : string	Get a human-readable caption for an icons sort order key. Overriding this function is NOT RECOMMENDED. Overriding this function could prevent sitewide improvements to styles, accessibility, or other functionality from operating in your layout. Sets strings according to layer or wizard supplied string properties.
lang_map_plural(int n) : int	This function defines plurals for different languages. Use this if you are writing a language layer that needs customization for its plurals.
lang_metadata_title(string which) : string	Get a human-readable caption for a metadata key. Overriding this function is NOT RECOMMENDED. Overriding this function could prevent sitewide improvements to styles, accessibility, or other functionality from operating in your layout. Sets strings according to layer or wizard supplied string properties.
lang_ordinal(int num) : string	Make an ordinal number from a cardinal number. Override only for language layers.
lang_ordinal(string num) : string	Make an ordinal number from a cardinal number. Don't override this, since the core layer implementation just calls lang_ordinal(int), which i18nc layers should override.
lang_page_of_pages(int pg, int pgs) : string	This function returns the current page number as well as number of available pages. Override for language layers.
lang_user_wrote(UserLite u) : string	Returns text describing that the user wrote something. This function is deprecated in favor of print_poster. Override for # language layers, but even better, use print_poster.
lang_viewname(string viewid) : string	Overriding this function is NOT RECOMMENDED. Overriding this function could prevent sitewide improvements to styles, accessibility, or other functionality from operating in your layout. Sets strings according to layer or wizard supplied string properties.
modules_init() : void	This function sets up the modules. It is called immediately after prop_init.
open_module(string intname, string title, string headlink_url) : void	Opens up a module for printing, using the appropriate HTML/CSS.
open_module(string intname, string title, string headlink_url, bool nocontent) : void	Opens up a module for printing, using the appropriate HTML/CSS.
pageview_unique_string() : string	Returns a unique string for the remote user.
palimg_gradient(string filename, PalItem start, PalItem end) : string	Return a URL to the specified filename (relative to the palimg root) with its palette table made into a gradient. All palette entries between the inclusive indexes of $start and $end will fade from the colors in $start and $end. The palette indexes for the start and end can be between 0 and 255.
palimg_modify(string filename, PalItem[] items) : string	Return a URL to the specified filename (relative to the palimg root) with its palette table altered, once for each provided PalItem. Restrictions: only 7 palette entries may be modified, and the PalItem indexes must be 0-15.
palimg_tint(string filename, Color bright) : string	Return a URL to the specified filename (relative to the palimg root) with its palette table tinted. The given 'bright' color will be the new white, and darkest color remains black.
palimg_tint(string filename, Color bright, Color dark) : string	Return a URL to the specified filename (relative to the palimg root) with its palette table tinted. The given 'bright' color will be the new white, and the given 'dark' color is the new black.
print_cloud_tags(TagDetail[] tagslist, string{} opts) : void	Prints out a list of tags in a cloud. Takes as arguments the taglist and a hash with optional arguments 'min_size' (minimum size in ems, times 10), 'maz_size' (maximum size in ems, times 10), 'list-class' and 'item-class'. 'print_uses' option can be 'number', 'text' or 'title' to determine whether to display the uses as a number, as full text, or in the link title. It defaults to the link title
print_custom_control_strip_css() : void	Prints the CSS for custom control strip colors, if the option is enabled. This should be called by print_stylesheet(). If you override this function, you will be changing the design of what is effectively site navigation, so proceed with caution.
print_linklist_manage_link() : void	Prints out a link to the links list management page, if the viewer can manage the list.
print_list_tags(TagDetail[] tagslist, string{} opts) : void	Prints out a list of tags. Takes as arguments the taglist and a hash with optional arguments 'list-class' and 'item-class'. 'print_uses' option can be 'number', 'text' or 'title' to determine whether to display the uses as a number, as full text, or in the link title. It defaults to full text
print_module_active() : void
print_module_calendar() : void
print_module_credit() : void
print_module_customtext() : void
print_module_cuttagcontrols() : void
print_module_links() : void
print_module_list(string[] list) : void	Takes a straight list of strings, prints them out as a list for a module
print_module_list(string{}[] list) : void	Takes a list of hashes in the form of [ { class => list_of_classes, item => list_item_contents }], prints them out as a list for a module
print_module_navlinks() : void
print_module_navlinks(bool apply_class_to_link) : void
print_module_pagesummary() : void
print_module_pagesummary_comment_count(Comment comment) : int
print_module_pagesummary_comments(string esubject, int count, string prop, string read_url) : string
print_module_poweredby() : void
print_module_search() : void
print_module_subscriptionfilters() : void
print_module_syndicate() : void
print_module_tags() : void
print_module_time() : void
print_module_userprofile() : void
print_multilevel_tags(TagDetail[] tagslist) : void	Prints out a list of multilevel tags. Takes as arguments the taglist.
print_multilevel_tags(TagDetail[] tagslist, string{} opts) : void	Prints out a list of multilevel tags. Takes as arguments the taglist and a hash with optional arguments 'list-class' and 'item-class'. 'print_uses' option can be 'number', 'text' or 'title' to determine whether to display the uses as a number, as full text, or in the link title. It defaults to uses as a number
print_search_form(string button_text) : void	Prints a search form, with the button text as the label to the submit button.
print_stylesheet() : void	Prints a stylesheet, the URL of which can be referenced by Page.stylesheet_url. This is another S2 entry point, in addition to Page.print(). If you want to hardcode a stylesheet into your layout, override this function.
print_subscriptionfilters_manage_link() : void	Prints out a link to the subscription filter management page, if the viewer can manage them.
print_tag_manage_link() : void	Prints out a link to the tag management page, if the viewer can manage tags.
prop_init() : void	This function is the first thing called and is the place to set properties based on the values of other properties. It's called before the style system looks at its builtin properties, so if you need to conditionally setup something based on your own custom properties, do it here. You can't print from this function.
rand(int high) : int	Returns a random integer between 1 and $high, inclusive.
rand(int low, int high) : int	Returns a random integer between $low and $high, inclusive.
secs_to_string(int sec) : string
server_sig() : void	Provides the site branding for each page.
set_content_type(string text) : void	Set the HTTP Content-type response header (for example, if outputting XML). Must be called before printing any data.
set_handler(string eventname, string[][] commands) : void
start_css() : void	Declare that you're about to start printing out CSS that should be buffered, then later cleaned when you call end_css(). WARNING: this is not re-entrant. You can't call start_css recursively.
string(int i) : string	Return the given integer as a string
striphtml(string s) : string	Similar to ehtml, but the HTML tags are stripped rather than escaped.
style_is_active() : bool	Returns if the style (layout and theme) calling it is active based on a hook. If hook isn't defined, returns true always.
userinfoicon(UserLite user) : Image	Prints the user icon identifying an account link's type. Be aware that overriding this function will allow you to change an image which contains semantically meaningful information used for site navigation, so override with caution.
userlite_base_url(UserLite ul) : string
viewer_can_manage_tags() : bool	Returns true if the user viewing the page can add, edit, and delete tags on the journal being viewed.
viewer_can_search() : bool	Returns true if the user viewing the page is logged in and can search that journal.
viewer_has_access() : bool	Returns true if the user viewing the page is logged in and has access to the journal being viewed. In communities, returns true if the viewer is a member of the community.
viewer_is_admin() : bool	Returns true if the user viewing a community is logged in and is an admin of the community.
viewer_is_friend() : bool	Returns true if the user viewing the page is logged in and has access to the journal being viewed. Returns true if the user is a member of a community.
viewer_is_member() : bool	Returns true if the user viewing the page is both logged in, and is a member of the community being viewed. Always returns false for personal journals, since they cannot have members.
viewer_is_moderator() : bool	Returns true if the user viewing a community is logged in and a moderator of the community.
viewer_is_owner() : bool	Returns true if the user viewing the page is both logged in, and is the owner of the content in question. Useful for returning links to manage information, or edit entries.
viewer_is_subscribed() : bool	Returns true if the user viewing the page is logged in and subscribes to the journal being viewed.
viewer_logged_in() : bool	Returns true if the user viewing the page is logged in. It's recommended that your page links to the site login page if the user isn't logged in.
viewer_sees_control_strip() : bool	Returns true if reader will see the built in control strip.
weekdays() : int[]	Integers representing the days of the week. This will start on Monday (2) or Sunday (1) depending on the property setting for start-of-week and go to Sunday (1) or Saturday (7)
zeropad(int n, int digits) : string	Returns the number padded with zeroes so it has the amount of digits indicated.
zeropad(string n, int digits) : string	Returns the number padded with zeroes so it has the amount of digits indicated.

Classes

Alphabetical Color Comment CommentInfo CommentNav Date DateTime DayPage Entry EntryLite EntryPage EntryPreviewPage Friend FriendsPage Icon IconsPage Image int ItemRange Link MessagePage MonthDay MonthEntryInfo MonthPage Page PalItem RecentNav RecentPage Redirector ReplyForm ReplyPage StickyEntry string SubscriptionFilter Tag TagDetail TagsPage User UserLink UserLite YearDay YearMonth YearPage YearWeek YearYear

Hierarchical Color CommentInfo CommentNav Date DateTime EntryLite Comment Entry StickyEntry Icon Image int ItemRange Link MonthEntryInfo Page DayPage EntryPage EntryPreviewPage IconsPage MessagePage MonthPage RecentPage FriendsPage ReplyPage TagsPage YearPage PalItem RecentNav Redirector ReplyForm string SubscriptionFilter Tag TagDetail UserLink UserLite Friend User YearDay MonthDay YearMonth YearWeek YearYear

Color Class

Represents a color.

Members

string as_string	HTML hex encoded: #rrggbb
int b	Blue value, 0-255. (Read-only)
int g	Green value, 0-255. (Read-only)
int r	Red value, 0-255. (Read-only)

Methods

Color(string s) : Color	Constructor for color class. Lets you make a Color object from a string of form #rrggbb
average(Color other) : Color	Returns color averaged with $other color.
blend(Color other, int value) : Color	Returns color blended with $other color by percentage value (int between 0 and 100).
blue() : int	Get the blue value.
blue(int b) : void	Set the blue value. (0-255)
clone() : Color	Returns identical color.
darker() : Color	Returns a new color with lightness decreased by 30.
darker(int amt) : Color	Returns a new color with lightness decreased by amount given.
green() : int	Get the green value.
green(int g) : void	Set the green value. (0-255)
hue() : int	Get the hue value. (0-255)
hue(int h) : void	Set the hue value. (0-255)
inverse() : Color	Returns inverse of color.
lighter() : Color	Returns a new color with lightness increased by 30.
lighter(int amt) : Color	Returns a new color with lightness increased by amount given.
lightness() : int	Get the lightness value. (0-255)
lightness(int v) : void	Set the lightness value. (0-255)
red() : int	Get the red value.
red(int r) : void	Set the red value. (0-255)
saturation() : int	Get the saturation value. (0-255)
saturation(int s) : void	Set the saturation value. (0-255)
set_hsl(int h, int s, int v) : void	Set the HSL value for a color class.

Comment Class

Child class of EntryLite. A comment to a journal entry, or to another comment.

Members

bool admin_post	Indicates if this is an official post to this community (Read-only)
string anchor	Direct link to comment, via HTML name anchors (Read-only)
bool comment_posted	True if comment was just posted by the current user. (Read-only)
bool deleted	True if comment has been deleted. Deleted comments still show up if they are the parent of a thread. (Read-only)
int depth	Visual depth of entry. Top-level journal entries are always depth zero. Comments have a depth greater than or equal to one, depending on where the thread is rooted at.
string dom_id	The DOM 'id' attribute you should put on your outer-most element (Read-only)
string echi	The Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool edited	True if the comment has been edited. (Read-only)
string editreason	The reason this comment was last edited (Read-only)
DateTime edittime	The GMT time the comment was edited. Or undef if the comment hasn't been edited. (Read-only)
DateTime edittime_poster	The local time the comment was edited, in the commenter's timezone. Or undef if anonymous comment, or commenter's timezone is unknown, or the comment hasn't been edited. (Read-only)
DateTime edittime_remote	The local time the comment was edited, in the remote user's (reader's) timezone. Or undef if no remote user, or remote user hasn't set their timezone, or the comment hasn't been edited. (Read-only)
bool fromsuspended	True if comment's author has been suspended. (Read-only)
bool frozen	True if comment is in frozen state. (Read-only)
bool full	True if all information is available for this comment. False if only the subject, poster, and date are available. (collapsed threads)
bool hidden_child	Indicates if the child is hidden by default. (Read-only)
bool hide_children	Indicates we are hiding the children of this comment (Read-only)
UserLite journal	Journal the entry has been posted to
string[] link_keyseq	An array of keys which you should pass to EntryLite.get_link(string key) to produce an entry 'toolbar'. Does not contain nav_next and nav_prev for entries; you should retrieve those separately and put them somewhere appropriate for your layout.
string{} metadata	Post metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
string parent_url	URL to parent comment, or blank if a top-level comment. (Read-only)
string permalink_url	A URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite poster	Author of the entry, or null if an anonymous comment
Comment[] replies	Comments replying to this comment.
string reply_url	URL to reply to this comment. (Read-only)
bool screened	True if comment is in screened state. (Read-only)
bool screened_noshow	True if comment is in screened state and user isn't allowed to see it. (Read-only)
int seconds_since_entry	The number of elapsed seconds from the time of the journal entry until the comment was initially posted. (Read-only)
string subject	Subject. May contain HTML. Don't do substring chops on this. (Read-only)
Image subject_icon	Subject icon, or null.
DateTime system_time	The system time (in GMT) this entry or comment was posted.
Tag tagnav	Which tag to apply to the intra-tag navigation links.
Tag[] tags	Array of tags applied to this entry. (Read-only)
int talkid	Server stored ID number for this comment.
string text	Entry Text; Use EntryLite.print_text() to print this so that the entry's trust level is not affected by your layer's trust level. (Read-only)
bool text_must_print_trusted	Indicates that this entry's text contains some content that must be printed trusted, with EntryLite.print_text(), rather than printed directly from an untrusted context. Use this to fall back to a plain trusted print if you are doing something unusual with EntryLite.text. Most layers can just ignore this and always use EntryLite.print_text(). (Read-only)
string thread_url	URL to view threaded rooted at this comment, or blank if comment has no children. (Read-only)
string threadroot_url	URL to view the entire thread this comment is part of, or blank if a top-level comment. (Read-only)
DateTime time	The user-specified time of the post, or the GMT time if it's a comment.
DateTime time_poster	The local time the comment appeared, in the commenter's timezone. Or undef if anonymous comment, or commenter's timezone is unknown. (Read-only)
DateTime time_remote	The local time the comment appeared, in the remote user's (reader's) timezone. Or undef if no remote user, or remote user hasn't set their timezone. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpic	The userpic selected to relate to this entry.

Methods

edittime_display() : string	Show the time that this comment was edited, with most useful information for user. Empty string if the comment hasn't been edited.
edittime_display(string datefmt, string timefmt) : string	edittime_display, with customized date/time formats.
expand_link() : string	Returns a link to expand a collapsed comment. Uses the value of the 'text_comment_expand' property as the text. Will not work in untrusted layers.
expand_link(string{} opts) : string	Returns a link to expand a collapsed comment. Can pass options 'text', 'title', 'class', and 'img_url' (and other 'img_*' options). Will not work in untrusted layers.
formatted_subject(string{} opts) : string	formats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : Link	Get a link to some action related to this entry or comment. You can iterate over EntryLite.link_keyseq to get keys to pass in here to produce a 'toolbar' of links.
get_plain_subject() : string	For Entries that can contain HTML subjects, this returns the subject without HTML. Comments can't have HTML in subjects, so this is equivalent to just using $.subject. The returned 'plain' subject may still contain HTML entities, so don't do substring chops on it either.
get_tags_text() : string	Returns a string containing a div of class 'ljtags' with the tags for the entry. If there are no tags on the entry, returns a blank string. The string is formatted according to the 'text_tags' property.
print_admin_post_icon() : void	prints the icon into the subject line
print_edit_text() : void	Print the text that says when this comment was edited.
print_edittime() : void	Print the time that this comment was edited, with most useful information for user. Empty string if the comment hasn't been edited.
print_edittime(string datefmt, string timefmt) : void	print_edittime, with customized date/time formats.
print_expand_link() : string	Prints a link to expand a collapsed comment. Uses the value of the 'text_comment_expand' property as the text.
print_expand_link(string{} opts) : string	Prints a link to expand a collapsed comment. Can pass options 'text', 'title', 'class', and 'img_url' (and other 'img_*' options).
print_hide_link() : string	Prints a link to hide a comment thread. Uses the value of the 'text_comment_hide' property as the text.
print_hide_link(string{} opts) : string	Prints a link to hide a comment. Can pass options 'text', 'title', 'class', and 'img_url' (and other 'img_*' options).
print_interaction_links() : void	Print the links to interact with this entry or comment. (Post a comment etc)
print_management_links() : void	Print the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : void	Print the metadata associated with this entry or comment
print_metatypes() : void	Print the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_multiform_check() : void	Prints the select checkbox in CSS class 'ljcomsel' with DOM id 'ljcomsel_$talkid' for a multi-action form started with EntryPage.print_multiform_start().
print_poster() : void	Print the poster of the entry or comment (user or user in journal, etc)
print_reply_container() : void	Prints the area in which the quickreply box will go. If no container is available, quickreply will not work.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. You may 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, and the link CSS class in 'class'. You may also specify the url of an image to use as a button in 'img_url'.
print_subject() : void	Print the formatted subject for this entry or comment
print_subject(string{} opts) : void	Print the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_text() : void	Print the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : void	Print the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : void	Print the time of the post, with customized date/time formats.
print_time(string datefmt, string timefmt, bool edittime) : void	Same as EntryLite::print_time, except can pass in if we want the edit time or not.
print_unhide_link() : string	Prints a link to unhide a comment thread. Uses the value of the 'text_comment_unhide' property as the text.
print_unhide_link(string{} opts) : string	Prints a link to hide a comment. Can pass options 'text', 'title', 'class', and 'img_url' (and other 'img_*' options).
print_userpic() : void	Print the userpic for this entry or comment
print_wrapper_end() : void	End the wrapper for this entry or comment.
print_wrapper_start() : void	Start the wrapper for this entry or comment; includes anchor and classes
time_display() : string	Show the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : string	time_display, with customized date/time formats.
time_display(string datefmt, string timefmt, bool edittime) : string	Same as EntryLite::time_display, except can pass in if we want the edit time or not.

CommentInfo Class

Information about comments attached to something.

Members

bool comments_disabled_maintainer	Set to true if the comments on this entry were disabled by a community administrator.
int count	Current number of comments available to be read by the viewer.
bool enabled	Set to false if comments disabled journal-wide or just on this item.
bool maxcomments	Set to true if entry has reached a comment maximum.
string permalink_url	Permanent URL for the entry. (Read-only)
string post_url	URL pointer to the 'Post Comments' view. (Read-only)
string read_url	URL pointer to the 'Read Comments' view. (Read-only)
bool screened	Set to true if there are screened comments and remote user can unscreen them.
int screened_count	Current number of screened comments (only visible if remote user can view screened comments)
bool show_postlink	Indicates whether the Post Comment link for this entry should be shown.
bool show_readlink	Indicates whether the Read Comments link for this entry should be shown.
bool show_readlink_hidden	Indicates whether to show the Read Comments link for this entry, but hidden, to be shown my JS.

Methods

print() : void	Print all comment related links
print(Entry e, string{} opts) : void	Print all comment related links, with arguments
print_postlink() : void	Print the formatted link to the 'Post Comments' view
print_readlink() : void	Print the formatted link to the 'Read Comments' view

CommentNav Class

Represents the comment navigation bar.

Members

int current_page	The currently displayed page
bool filter	True if the current view is filtered.
bool show_expand_all	True if we should show the expand_all option.
string url	The url for this entry page, complete with style argument if present.
string view_mode	The current view mode (threaded, flat, top-only).

Methods

print() : void	Prints the nav bar, including the comment_pages bar, with a default CSS class
print(string{} extra) : void	Prints the nav bar with the given attributes. Accepts 'class'

Date Class

Represents a date.

Members

int day	Day; 1-31.
int month	Month; 1-12.
int year	Year; 4 digits.

Methods

compare(Date d) : int	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
compare(DateTime d) : int	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
date_format() : string	Returns date formatted as normal. /// SeeAlso: siteapi.core1.dateformats
date_format(string fmt) : string	Returns date formatted as indicated by $fmt. One of: short, med, long, med_day, long_day. Or a custom format. Default is 'short'. /// SeeAlso: siteapi.core1.dateformats
date_format(string fmt, bool linkify) : string	Returns date formatted in the same way as calling date_format(string fmt), but with day, month, and year as links to the corresponding archive pages.
day_of_week() : int	Returns the day of the week this date falls on, from Sunday=1 to Saturday=7

DateTime Class

Child class of Date. Represents both a date and time.

Members

int day	Day; 1-31.
int hour	Hour; 0-23.
int min	Minute; 0-59.
int month	Month; 1-12.
int sec	Second; 0-59.
int year	Year; 4 digits.

Methods

compare(Date d) : int	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
compare(DateTime d) : int	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
date_format() : string	Returns date formatted as normal. /// SeeAlso: siteapi.core1.dateformats
date_format(string fmt) : string	Returns date formatted as indicated by $fmt. One of: short, med, long, med_day, long_day. Or a custom format. Default is 'short'. /// SeeAlso: siteapi.core1.dateformats
date_format(string fmt, bool linkify) : string	Returns date formatted in the same way as calling date_format(string fmt), but with day, month, and year as links to the corresponding archive pages.
day_of_week() : int	Returns the day of the week this date falls on, from Sunday=1 to Saturday=7
time_format() : string	Returns time formatted as normal. /// SeeAlso: siteapi.core1.dateformats
time_format(string fmt) : string	Returns time formatted as indicated by $fmt, or normal if blank. /// SeeAlso: siteapi.core1.dateformats

DayPage Class

Child class of Page. View entries by specific day

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
Date date	Date of the current day
Entry[] entries	Array of entries available to be seen by the viewer of the page
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
bool has_entries	True if there are entries on the specified day
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
Date next_date	Next day
string next_url	URL to next day (Read-only)
Date prev_date	Previous day
string prev_url	URL to previous day (Read-only)
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

Entry Class

Child class of EntryLite. A journal entry

Members

bool admin_post	Indicates if this is an official post to this community (Read-only)
Image adult_content_icon	A little icon which should be displayed somewhere on an entry to represent the adult content level
string adult_content_level	The adult content level ('NSFW', '18'), or blank if unrestricted. (Read-only)
CommentInfo comments	Comment information on this entry
int depth	Visual depth of entry. Top-level journal entries are always depth zero. Comments have a depth greater than or equal to one, depending on where the thread is rooted at.
string dom_id	The DOM 'id' attribute you should put on your outer-most element (Read-only)
string echi	The Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool end_day	Is this the last entry of a day?
bool hidden_child	Indicates if the child is hidden by default. (Read-only)
bool hide_children	Indicates we are hiding the children of this comment (Read-only)
int itemid	Server stored ID number for this entry
UserLite journal	Journal the entry has been posted to
string[] link_keyseq	An array of keys which you should pass to EntryLite.get_link(string key) to produce an entry 'toolbar'. Does not contain nav_next and nav_prev for entries; you should retrieve those separately and put them somewhere appropriate for your layout.
string{} metadata	Post metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
Image mood_icon	Mood icon, or null.
bool new_day	Is this entry on a different day to the previous one?
string permalink_url	A URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite poster	Author of the entry, or null if an anonymous comment
string security	The security level of the entry ('private', 'protected'), or blank if public. (Read-only)
Image security_icon	A little icon which should be displayed somewhere on an entry to represent the security setting
string subject	Subject. May contain HTML. Don't do substring chops on this. (Read-only)
DateTime system_time	The system time (in GMT) this entry or comment was posted.
Tag tagnav	Which tag to apply to the intra-tag navigation links.
Tag[] tags	Array of tags applied to this entry. (Read-only)
string text	Entry Text; Use EntryLite.print_text() to print this so that the entry's trust level is not affected by your layer's trust level. (Read-only)
bool text_must_print_trusted	Indicates that this entry's text contains some content that must be printed trusted, with EntryLite.print_text(), rather than printed directly from an untrusted context. Use this to fall back to a plain trusted print if you are doing something unusual with EntryLite.text. Most layers can just ignore this and always use EntryLite.print_text(). (Read-only)
DateTime time	The user-specified time of the post, or the GMT time if it's a comment.
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpic	The userpic selected to relate to this entry.

Methods

formatted_subject(string{} opts) : string	formats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : Link	Get a link to some action related to this entry or comment. You can iterate over EntryLite.link_keyseq to get keys to pass in here to produce a 'toolbar' of links.
get_plain_subject() : string	For Entries that can contain HTML subjects, this returns the subject without HTML. Comments can't have HTML in subjects, so this is equivalent to just using $.subject. The returned 'plain' subject may still contain HTML entities, so don't do substring chops on it either.
get_tags_text() : string	Returns a string containing a div of class 'ljtags' with the tags for the entry. If there are no tags on the entry, returns a blank string. The string is formatted according to the 'text_tags' property.
plain_subject() : string	Return entry's subject as plain text, with all HTML removed.
print_admin_post_icon() : void	prints the icon into the subject line
print_ebox() : void	Prints a small horizontal bar of site-specific content between entries in a journal.
print_interaction_links() : void	Print the links to interact with this entry or comment. (Post a comment etc)
print_interaction_links(string target) : void	Print the links to interact with this entry or comment, with target.
print_link_next() : void	Print the link to the next entry in this journal.
print_link_prev() : void	Print the link to the previous entry in this journal.
print_link_tag_next() : void	Print the link to the next entry in this journal with this tag
print_link_tag_prev() : void	Print the link to the previous entry in this journal with this tag
print_management_links() : void	Print the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : void	Print the metadata associated with this entry or comment
print_metatypes() : void	Print the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_metatypes(bool icon, bool info) : void	Print the metatype information for this entry
print_poster() : void	Print the poster of the entry or comment (user or user in journal, etc)
print_reply_container() : void	Prints the area in which the quickreply box will go. If no container is available, quickreply will not work.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. You may 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, and the link CSS class in 'class'. You may also specify the url of an image to use as a button in 'img_url'.
print_subject() : void	Print the formatted subject for this entry or comment
print_subject(string{} opts) : void	Print the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_tags() : void	Print the tags for this entry.
print_text() : void	Print the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : void	Print the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : void	Print the time of the post, with customized date/time formats.
print_userpic() : void	Print the userpic for this entry or comment
print_wrapper_end() : void	End the wrapper for this entry or comment.
print_wrapper_start() : void	Start the wrapper for this entry or comment; includes anchor and classes
time_display() : string	Show the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : string	time_display, with customized date/time formats.
viewer_sees_ebox() : bool	True if opaque horizontal site-specific content boxes between entries should be displayed to the user.

EntryLite Class

Base class for both journal entries and comments.

Members

bool admin_post	Indicates if this is an official post to this community (Read-only)
int depth	Visual depth of entry. Top-level journal entries are always depth zero. Comments have a depth greater than or equal to one, depending on where the thread is rooted at.
string dom_id	The DOM 'id' attribute you should put on your outer-most element (Read-only)
string echi	The Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool hidden_child	Indicates if the child is hidden by default. (Read-only)
bool hide_children	Indicates we are hiding the children of this comment (Read-only)
UserLite journal	Journal the entry has been posted to
string[] link_keyseq	An array of keys which you should pass to EntryLite.get_link(string key) to produce an entry 'toolbar'. Does not contain nav_next and nav_prev for entries; you should retrieve those separately and put them somewhere appropriate for your layout.
string{} metadata	Post metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
string permalink_url	A URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite poster	Author of the entry, or null if an anonymous comment
string subject	Subject. May contain HTML. Don't do substring chops on this. (Read-only)
DateTime system_time	The system time (in GMT) this entry or comment was posted.
Tag tagnav	Which tag to apply to the intra-tag navigation links.
Tag[] tags	Array of tags applied to this entry. (Read-only)
string text	Entry Text; Use EntryLite.print_text() to print this so that the entry's trust level is not affected by your layer's trust level. (Read-only)
bool text_must_print_trusted	Indicates that this entry's text contains some content that must be printed trusted, with EntryLite.print_text(), rather than printed directly from an untrusted context. Use this to fall back to a plain trusted print if you are doing something unusual with EntryLite.text. Most layers can just ignore this and always use EntryLite.print_text(). (Read-only)
DateTime time	The user-specified time of the post, or the GMT time if it's a comment.
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpic	The userpic selected to relate to this entry.

Methods

formatted_subject(string{} opts) : string	formats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : Link	Get a link to some action related to this entry or comment. You can iterate over EntryLite.link_keyseq to get keys to pass in here to produce a 'toolbar' of links.
get_plain_subject() : string	For Entries that can contain HTML subjects, this returns the subject without HTML. Comments can't have HTML in subjects, so this is equivalent to just using $.subject. The returned 'plain' subject may still contain HTML entities, so don't do substring chops on it either.
get_tags_text() : string	Returns a string containing a div of class 'ljtags' with the tags for the entry. If there are no tags on the entry, returns a blank string. The string is formatted according to the 'text_tags' property.
print_admin_post_icon() : void	prints the icon into the subject line
print_interaction_links() : void	Print the links to interact with this entry or comment. (Post a comment etc)
print_management_links() : void	Print the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : void	Print the metadata associated with this entry or comment
print_metatypes() : void	Print the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_poster() : void	Print the poster of the entry or comment (user or user in journal, etc)
print_reply_container() : void	Prints the area in which the quickreply box will go. If no container is available, quickreply will not work.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. You may 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, and the link CSS class in 'class'. You may also specify the url of an image to use as a button in 'img_url'.
print_subject() : void	Print the formatted subject for this entry or comment
print_subject(string{} opts) : void	Print the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_text() : void	Print the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : void	Print the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : void	Print the time of the post, with customized date/time formats.
print_userpic() : void	Print the userpic for this entry or comment
print_wrapper_end() : void	End the wrapper for this entry or comment.
print_wrapper_start() : void	Start the wrapper for this entry or comment; includes anchor and classes
time_display() : string	Show the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : string	time_display, with customized date/time formats.

EntryPage Class

Child class of Page. A page with a single journal entry and associated comments.

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
CommentNav comment_nav	The comment navigation bar
ItemRange comment_pages	Represents what comment page is being displayed.
Comment[] comments	Comments to journal entry, or at least some of them.
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
Entry entry	Journal entry being viewed
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
bool multiform_on	Set to true if the multi-action is to be printed, which requires both comments and applicable permissions for the remote user.
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
bool viewing_thread	True if viewing a specific sub-thread of the comments. Style may which to hide the journal entry at this point, since the focus is the comments.
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_comment(Comment comment) : void	Prints a full comment
print_comment_partial(Comment comment) : void	Prints a collapsed comment
print_comment_section(Entry entry) : void	Prints comment section
print_comments(Comment[] comments) : void	Prints comments
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_multiform_actionline() : void	Prints the line of the multiform giving instructions, options, and the submit button, using the text of the different $*text_multiform_ properties.
print_multiform_end() : void	Prints end of form tag to do a multi-comment action.
print_multiform_start() : void	Prints start of form tag and hidden elements to do a multi-comment action (multiple delete, screen, unscreen, etc...)
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

EntryPreviewPage Class

Child class of EntryPage. We disable funtionality for previews, and print messages about that

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
CommentNav comment_nav	The comment navigation bar
ItemRange comment_pages	Represents what comment page is being displayed.
Comment[] comments	Comments to journal entry, or at least some of them.
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
Entry entry	Journal entry being viewed
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
bool multiform_on	Set to true if the multi-action is to be printed, which requires both comments and applicable permissions for the remote user.
string preview_warn_text	Text to display instead of management controls for previews
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
bool viewing_thread	True if viewing a specific sub-thread of the comments. Style may which to hide the journal entry at this point, since the focus is the comments.
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_comment(Comment comment) : void	Prints a full comment
print_comment_partial(Comment comment) : void	Prints a collapsed comment
print_comment_section(Entry entry) : void	Prints comment section
print_comments(Comment[] comments) : void	Prints comments
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_multiform_actionline() : void	Prints the line of the multiform giving instructions, options, and the submit button, using the text of the different $*text_multiform_ properties.
print_multiform_end() : void	Prints end of form tag to do a multi-comment action.
print_multiform_start() : void	Prints start of form tag and hidden elements to do a multi-comment action (multiple delete, screen, unscreen, etc...)
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_standout_box(string message) : void	Prints a standout box containing a message
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

Friend Class

Child class of UserLite. Represents a friends or friendof list

Members

Color bgcolor	Background color selected for friend
Link{} data_link	Links to various machine-readable data sources relating to this user
string[] data_links_order	An array of data views which can be used to order the data_link hash
Color fgcolor	Foreground color selected for friend
string journal_type	Type of account: P (personal), C (community), Y (syndicated), I (external identity) etc (Read-only)
string[] link_keyseq	Array of keys which can be passed into the get_link
string name	User's formatted name, ex: John Q. Public (Read-only)
string user	Backend Username: should match username for registered journals, external identities will be represented as ext_XXX instead (Read-only)
string username	Canonical Username, ex: johnqpub. Note that if journal_type is an external identity, there will be no username, so this field will be a display version of their URL, longer than 25 characters, and with characters other than a-z, 0-9 and underscore. (Read-only)
string userpic_listing_url	URL of a page listing this user's userpics (Read-only)

Methods

as_string() : string
base_url() : string	Returns URL of user's journal.
equals(UserLite u) : bool	Returns true if the two user objects refer to the same user. Use this rather than comparing usernames, since usernames aren't globally unique.
get_link(string key) : Link	Returns a link based on the given key, or null if the link is unavailable
icon_manage_url() : string	Returns URL to user's icon management page.
linklist_manage_url() : string	Returns URL to user's tag management page.
ljuser() : string	Returns an LJ user tag for the user.
ljuser(Color link_color) : string	Returns an LJ user tag for the user. The color of the link will be link_color.
print() : void
print_interaction_links() : void	Print the interaction links for this user/journal.
subscriptionfilters_manage_url() : string	Returns URL to user's subscription filter page.
tag_manage_url() : string	Returns URL to user's tag management page.

FriendsPage Class

Child class of RecentPage. Friends most recent entries

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
Entry[] entries	Array of entries available to be seen by the viewer of the page.
bool filter_active	If true, some kind of filter is in effect. If this filter has a name, it will be included in RecentPage.filter_name
string filter_name	The name of the filter in effect, if it has a name. This is only used when RecentPage.filter_active is true.
bool filter_tags	If true, the page is being filtered to only entries tagged with a specific tag. This is only used when RecentPage.filter_active is true.
Friend{} friends	A mapping from friend username to color association information. There will only be keys for friends whose entries are in the entries array.
string friends_mode	The 'mode' of this view. An empty string indicates a normal friends view, while 'network' indicates the network view.
string friends_subtitle	A user-selected subtitle for their friends page. (Read-only)
string friends_title	A user-selected title for their friends page. (Read-only)
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
RecentNav nav
StickyEntry stickyentry	Entry shown on top of the Recent Entries page
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_sticky_entry(StickyEntry s) : void	function to print the sticky entry
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

Icon Class

Represents a single icon

Members

bool active	If this icon is active (Read-only)
string comment	Comment text (Read-only)
bool default	If this icon is the default (Read-only)
string description	Description text (Read-only)
Image image	Information about the icon (Read-only)
string[] keywords	All keywords (Read-only)
string link_url	URL this image links to when clicked (Read-only)

Methods

print() : void

Prints the icon

IconsPage Class

Child class of Page. A detail page listing a user's icons.

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
bool can_manage	Can the current user manage these icons. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
Icon[] icons	List of the icons on the current page. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
ItemRange pages	All pages (Read-only)
string[] sort_keyseq	A list of sort orders, indicated by key. (Read-only)
string{} sort_urls	An associative array of link for various sort orders. (Read-only)
string sortorder	Current sort order. Can be 'upload' or 'keyword'. (Read-only)
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_icon_manage_link() : void	Prints out a link to the icon management page, if the viewer can manage icons.
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

Image Class

Represents an image.

Members

string alttext	Default alternative text for image
string{} extra	Extra params for img tag (Read-only)
int height	Height in pixels
string url	URL of the image (Read-only)
int width	Width in pixels

Methods

as_string() : string	Return the HTML tag for this image
as_string(string alttext) : string	Return an HTML tag for this Image with given alttext
as_string(string{} opts) : string	Return the HTML for an image, Supported keys are 'href' to create a link to the image source and 'a_attr' which adds attributes to the anchor tag if a link is to be printed.
print() : void	Print an HTML tag for this Image
print(string alttext) : void	Print an HTML tag for this Image with given alttext
print(string{} opts) : void	Print the HTML for an image, Supported keys are 'href' to create a link to the image source and 'a_attr' which adds attributes to the anchor tag if a link is to be printed.
set_url(string url) : void	Sets the URL, doing any necessary escaping.

int Class

An integer number. This isn't really a class, as suggested by its lower-case name. Parameters of type int pass by value, unlike all variables of real object types, which pass by reference. Instead, this is just a pseudo-class which provides convenience methods on instances of integers. The other pseudo-class is string.

Methods

compare(int n) : int	Compare one integer with another. Returns a negative number if n is less than the subject, positive if greater or zero if the two are numerically equal.
zeropad(int digits) : string	Return the integer as a string formatted at least $digits characters long, left-padded with zeroes.

ItemRange Class

Represents a range of items which optionally contain items.

Members

bool all_subitems_displayed	True if the subitems in this range represent the entire set. In this case, all of the URL members are blank.
int current	The currently-active item.
int from_subitem	The index of the first subitem in this range.
int num_subitems_displayed	The number of subitems in this range.
int to_subitem	The index of the last subitem in this range.
int total	The total number of items that are navigable to.
int total_subitems	The number of subitems.
string url_all	URL to view all items. Blank if we don't support viewing all items for this. (Read-only)
string url_first	URL for the 'first' link. Blank if already on the first page. (Read-only)
string url_last	URL for the 'last' link. Blank if already on the last page. (Read-only)
string url_next	URL for the 'next' link. Blank if there isn't a next URL. (Read-only)
string url_prev	URL for the 'previous' link. Blank if there isn't a previous URL. (Read-only)

Methods

print() : void	Prints the item range links with a default anchor and CSS class.
print(string{} extra) : void	Prints the item range links with the given attributes. Accepts 'class' and 'anchor'
url_of(int n) : string	Returns the URL to use to link to the nth item

Link Class

A link or button

Members

string caption	The caption for the link (Read-only)
string{} extra	Extra attributes passed to the link (Read-only)
Image icon	A suggestion from the server as to which icon to use. layouts/users can override this of course. alt text works similarly to Link.caption.
string url	URL which the link points to (Read-only)

Methods

as_string() : string	Return the button HTML link.
print_button() : void	Output this Link as a clickable button using Link.icon

MessagePage Class

Child class of Page. A page showing an error or confirmation message.

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
string[] link_keyseq	A list of links, indicated by key, that should be displayed alongside this error. They should ideally be displayed in a similar way to the entry links displayed on the entry page.
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
Link{} links	An associative array of links to be displayed alongside this message. Iterate over MessagePage.link_keyseq to find the keys.
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
string message	The body of the message. Do not print this directly; use MessagePage.print_body() instead. (Read-only)
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string title	The title of the message. (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_links() : void	Print the links from the MessagePage.links and MessagePage.link_keyseq members. Layouts will probably want to override this.
print_message() : void	Print the message. Call this rather than printing MessagePage.message directly.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

MonthDay Class

Child class of YearDay. Summaries of entries on a given day on the MonthPage.

Members

Date date	Date of day
int day	Day of month number
Entry[] entries	Only populated on the month view. Entry text not present.
bool has_entries	True if there are entries on this day.
int num_entries	Number of entries made on this day
string url	A URL to view the day, if there are entries, else blank. (Read-only)

Methods

print_subjectlist() : void

Print a list of entry summaries including subjects

MonthEntryInfo Class

A month the user has journal entries, along with information to link to it.

Members

Date date	Date of month, with day of zero.
string redir_key	The 'redir_key' parameter for a Redirector instance. (Read-only)
string url	URL for the MonthPage month view. (Read-only)

MonthPage Class

Child class of Page. A page which contains a list of entries made in that month

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
Date date	Date of this month, with day of zero.
MonthDay[] days	One entry for each day of the month.
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
MonthEntryInfo[] months	Other months this journal has entries.
Date next_date	Date of next month, with day of zero, or null if none.
string next_url	URL of next month, or empty string if none. (Read-only)
Date prev_date	Date of previous month, with day of zero, or null if none.
string prev_url	URL of previous month, or empty string if none. (Read-only)
Redirector redir	Necessary to make a form which POSTs to a redirector
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

Page Class

Base template for all views

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

PalItem Class

A specification for a numbered palette index in a GIF or PNG to be changed to a certain color

Members

Color color	Color to put at specified index.
int index	Integer palette index.

RecentNav Class

Navigation position within a RecentPage or FriendsPage and URLs to move about.

Members

int backward_count	Number of items we'd be potentially seeing going backward.
int backward_skip	Number of items we'd be skipping going back more.
string backward_url	URL to go backward in time, or blank if furthest back server will allow. (Read-only)
int count	Indicates how many entries we're currently seeing
int forward_count	Number of items we'd be potentially seeing going forward.
int forward_skip	Number of items we'd be skipping going forward.
string forward_url	URL to go forward in time, or blank if furthest forward. (Read-only)
int skip	Indicates how many entries are being skipped back.
int version	Currently version 1. A new method of navigation has been frequently discussed, so this is planning for the future

RecentPage Class

Child class of Page. Most recent entries page, formerly known as the LASTN view in the previous style system

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
Entry[] entries	Array of entries available to be seen by the viewer of the page.
bool filter_active	If true, some kind of filter is in effect. If this filter has a name, it will be included in RecentPage.filter_name
string filter_name	The name of the filter in effect, if it has a name. This is only used when RecentPage.filter_active is true.
bool filter_tags	If true, the page is being filtered to only entries tagged with a specific tag. This is only used when RecentPage.filter_active is true.
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
RecentNav nav
StickyEntry stickyentry	Entry shown on top of the Recent Entries page
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_sticky_entry(StickyEntry s) : void	function to print the sticky entry
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

Redirector Class

A redirector makes either a GET URL which redirects to a pretty URL or an HTML form which posts to a URL that redirects to a pretty URL. This class exists because it's often desirable to use a form to end up at a URL, instead of doing a GET request. It's also used in cases where finding the previous or next URL would incur database overhead which would be wasteful, considering most people don't click previous/next links. Instead, the system will give you a Redirector object which has a URL that'll do the lookup for you later, followed by a redirect.

Members

string type	(Read-only)
string url	(Read-only)
string user	(Read-only)
string vhost	(Read-only)

Methods

end_form() : void	Prints a form close tag.
get_url(string redir_key) : void	Returns a GET URL, given a redir_key
print_hiddens() : void	Prints the necessary hidden elements for a form. Called automatically by Redirector.start_form().
start_form() : void	Starts an inline HTML form, then calls Redirector.print_hiddens(). You can also make it yourself, using Redirector.url, if you need special form attributes.

ReplyForm Class

This class will be used more in the future to set options on the reply form before it's printed out by the system. The system has to print it since it contains sensitive information which can't be made available to S2.

Members

bool subj_icons

Whether user has enabled subject icons or not. Currently read-only until policy is decided on whether layers should be able to change it (rather than changing it in the user preferences) (Read-only)

Methods

print() : void

Prints the reply form

ReplyPage Class

Child class of Page. A page to reply to a journal entry or comment

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
Entry entry	The journal entry for this talk page
ReplyForm form	The reply form.
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
bool isedit	True if we are editing a comment, false if writing a new one
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
EntryLite replyto	The object which is being replied to, either the entry or a comment
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_comment(Comment comment) : void	Prints a full comment
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

StickyEntry Class

Child class of Entry. An entry that is shown on top of the journal's recent entries page

Members

bool admin_post	Indicates if this is an official post to this community (Read-only)
Image adult_content_icon	A little icon which should be displayed somewhere on an entry to represent the adult content level
string adult_content_level	The adult content level ('NSFW', '18'), or blank if unrestricted. (Read-only)
CommentInfo comments	Comment information on this entry
int depth	Visual depth of entry. Top-level journal entries are always depth zero. Comments have a depth greater than or equal to one, depending on where the thread is rooted at.
string dom_id	The DOM 'id' attribute you should put on your outer-most element (Read-only)
string echi	The Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool end_day	Is this the last entry of a day?
bool hidden_child	Indicates if the child is hidden by default. (Read-only)
bool hide_children	Indicates we are hiding the children of this comment (Read-only)
int itemid	Server stored ID number for this entry
UserLite journal	Journal the entry has been posted to
string[] link_keyseq	An array of keys which you should pass to EntryLite.get_link(string key) to produce an entry 'toolbar'. Does not contain nav_next and nav_prev for entries; you should retrieve those separately and put them somewhere appropriate for your layout.
string{} metadata	Post metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
Image mood_icon	Mood icon, or null.
bool new_day	Is this entry on a different day to the previous one?
string permalink_url	A URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite poster	Author of the entry, or null if an anonymous comment
string security	The security level of the entry ('private', 'protected'), or blank if public. (Read-only)
Image security_icon	A little icon which should be displayed somewhere on an entry to represent the security setting
Image sticky_entry_icon	A little icon displayed next to the subject of a sticky entry post
string subject	Subject. May contain HTML. Don't do substring chops on this. (Read-only)
DateTime system_time	The system time (in GMT) this entry or comment was posted.
Tag tagnav	Which tag to apply to the intra-tag navigation links.
Tag[] tags	Array of tags applied to this entry. (Read-only)
string text	Entry Text; Use EntryLite.print_text() to print this so that the entry's trust level is not affected by your layer's trust level. (Read-only)
bool text_must_print_trusted	Indicates that this entry's text contains some content that must be printed trusted, with EntryLite.print_text(), rather than printed directly from an untrusted context. Use this to fall back to a plain trusted print if you are doing something unusual with EntryLite.text. Most layers can just ignore this and always use EntryLite.print_text(). (Read-only)
DateTime time	The user-specified time of the post, or the GMT time if it's a comment.
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpic	The userpic selected to relate to this entry.

Methods

formatted_subject(string{} opts) : string	formats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : Link	Get a link to some action related to this entry or comment. You can iterate over EntryLite.link_keyseq to get keys to pass in here to produce a 'toolbar' of links.
get_plain_subject() : string	For Entries that can contain HTML subjects, this returns the subject without HTML. Comments can't have HTML in subjects, so this is equivalent to just using $.subject. The returned 'plain' subject may still contain HTML entities, so don't do substring chops on it either.
get_tags_text() : string	Returns a string containing a div of class 'ljtags' with the tags for the entry. If there are no tags on the entry, returns a blank string. The string is formatted according to the 'text_tags' property.
plain_subject() : string	Return entry's subject as plain text, with all HTML removed.
print_admin_post_icon() : void	prints the icon into the subject line
print_ebox() : void	Prints a small horizontal bar of site-specific content between entries in a journal.
print_interaction_links() : void	Print the links to interact with this entry or comment. (Post a comment etc)
print_interaction_links(string target) : void	Print the links to interact with this entry or comment, with target.
print_link_next() : void	Print the link to the next entry in this journal.
print_link_prev() : void	Print the link to the previous entry in this journal.
print_link_tag_next() : void	Print the link to the next entry in this journal with this tag
print_link_tag_prev() : void	Print the link to the previous entry in this journal with this tag
print_management_links() : void	Print the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : void	Print the metadata associated with this entry or comment
print_metatypes() : void	Print the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_metatypes(bool icon, bool info) : void	Print the metatype information for this entry
print_poster() : void	Print the poster of the entry or comment (user or user in journal, etc)
print_reply_container() : void	Prints the area in which the quickreply box will go. If no container is available, quickreply will not work.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. You may 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, and the link CSS class in 'class'. You may also specify the url of an image to use as a button in 'img_url'.
print_sticky_icon() : void	prints the icon into the subject line
print_subject() : void	Print the formatted subject for this entry or comment
print_subject(string{} opts) : void	Print the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_tags() : void	Print the tags for this entry.
print_text() : void	Print the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : void	Print the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : void	Print the time of the post, with customized date/time formats.
print_userpic() : void	Print the userpic for this entry or comment
print_wrapper_end() : void	End the wrapper for this entry or comment.
print_wrapper_start() : void	Start the wrapper for this entry or comment; includes anchor and classes
time_display() : string	Show the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : string	time_display, with customized date/time formats.
viewer_sees_ebox() : bool	True if opaque horizontal site-specific content boxes between entries should be displayed to the user.

string Class

A series of characters. This isn't really a class, as suggested by its lower-case name. Parameters of type string pass by value, unlike all variables of real object types, which pass by reference. Instead, this is just a pseudo-class which provides convenience methods on instances of strings. The other pseudo-class is int.

Methods

compare(string s) : int	Compare one string with another. Returns a negative number if n is alphabetically before the subject, positive if greater or zero if the two are equal. Note that this function currently does a simple ASCII compare, not a proper unicode-aware sort.
contains(string sub) : bool	Return true if string contains $sub
css_divide_length(int divisor) : string	If the string contains a valid CSS length value, returns the value divided by the divisor with the unit appended. Otherwise, an empty string is returned
css_keyword() : string	If the string is syntactically valid as a CSS keyword (only letters and spaces) returns it, else returns an empty string.
css_keyword(string[] allowed) : string	Same as string.css_keyword() except also imposes a whitelist of valid keywords given in $allowed.
css_keyword_list() : string	Analyses the string as a space-separated list of CSS keywords and returns a string containing the items that are syntactically acceptable.
css_keyword_list(string[] allowed) : string	Same as string.css_keyword_list() except also imposes a whitelist of valid keywords given in $allowed.
css_length_value() : string	If the string contains a valid CSS length value, returns a canonical version. Else returns an empty string.
css_multiply_length(int multiplier) : string	If the string contains a valid CSS length value, returns the value multiplied by the multiplier with the unit appended. Otherwise, an empty string is returned
css_string() : string	Returns the string escaped and quoted as a CSS string literal, safe for insertion into a stylesheet.
css_url_value() : string	If the string contains a valid HTTP or HTTPS URL it is returned. Otherwise, an empty string is returned.
ends_with(string sub) : bool	Returns true if string ends in $sub
index(string sub) : int	Returns the index of the first instance of $sub in string.
index(string sub, int position) : int	Returns the index of the first instance of $sub in string, starting from $position
length() : int	Return the number of characters in the string.
lower() : string	Returns string in lower case.
repeat(int n) : string	Returns the string repeated n times
replace(string find, string replace) : string	Replace all instances of $find with $replace. Case sensitive.
split(string sub) : string[]	Return an array of strings split by $sub
starts_with(string sub) : bool	Returns true if string begins with $sub
substr(int start, int length) : string	Returns up to $length characters from string, skipping $start characters from the beginning.
upper() : string	Returns string in upper case
upperfirst() : string	Return string with the first character capitalized.

SubscriptionFilter Class

Members

string name	The name of the filter.
bool public	Whether the filter is publicly accessible.
int sortorder	Which order this filter is in compared to others.
string url	A link to the filtered reading page.

Tag Class

Represents a tag in its most basic form.

Members

string name	Textual representation of this tag. (Read-only)
string url	URL to view entries with this tag. (Read-only)

TagDetail Class

Child class of Tag. A rich structure with lots of information about a Tag.

Members

string name	Textual representation of this tag. (Read-only)
int{} security_counts	How many times this tag has used this security. The keys are which security, one of: public, protected, private, group. The value is the count of times the tag is used on entries with that security level. If the current user does not have access to that security level, the value is undefined. The group level is only available if the current user is the journal owner. (Read-only)
string url	URL to view entries with this tag. (Read-only)
int use_count	Count of approximately how many times this tag has been used in posts that the viewer has access to. (Read-only)
string visibility	The visibility level for this tag. Equal to the least restrictive security level that it's used on. Can be one of: public, protected, private, group. (Read-only)

TagsPage Class

Child class of Page. A detail page listing a user's tags.

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
TagDetail[] tags	List of tags visible to the user viewing the page.
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

User Class

Child class of UserLite. A more information-rich userinfo structure

Members

Link{} data_link	Links to various machine-readable data sources relating to this user
string[] data_links_order	An array of data views which can be used to order the data_link hash
Image default_pic	Information about default userpic
string journal_type	Type of account: P (personal), C (community), Y (syndicated), I (external identity) etc (Read-only)
string[] link_keyseq	Array of keys which can be passed into the get_link
string name	User's formatted name, ex: John Q. Public (Read-only)
string user	Backend Username: should match username for registered journals, external identities will be represented as ext_XXX instead (Read-only)
string username	Canonical Username, ex: johnqpub. Note that if journal_type is an external identity, there will be no username, so this field will be a display version of their URL, longer than 25 characters, and with characters other than a-z, 0-9 and underscore. (Read-only)
string userpic_listing_url	URL of a page listing this user's userpics (Read-only)
string website_name	'pretty' name of user's website (Read-only)
string website_url	URL pointer to user's website (Read-only)

Methods

as_string() : string
base_url() : string	Returns URL of user's journal.
equals(UserLite u) : bool	Returns true if the two user objects refer to the same user. Use this rather than comparing usernames, since usernames aren't globally unique.
get_link(string key) : Link	Returns a link based on the given key, or null if the link is unavailable
icon_manage_url() : string	Returns URL to user's icon management page.
linklist_manage_url() : string	Returns URL to user's tag management page.
ljuser() : string	Returns an LJ user tag for the user.
ljuser(Color link_color) : string	Returns an LJ user tag for the user. The color of the link will be link_color.
print() : void
print_interaction_links() : void	Print the interaction links for this user/journal.
print_userpic() : void	Print the userpic for this user
subscriptionfilters_manage_url() : string	Returns URL to user's subscription filter page.
tag_manage_url() : string	Returns URL to user's tag management page.

UserLink Class

A user-defined link to an outside resource.

Members

UserLink[] children	Not Implemented: An array of child UserLink objects. (Read-only)
string hover	The hover text for the link (Read-only)
bool is_heading	Is this link a heading or category name? If so, it has no url and a list of children. (Read-only)
string title	The title or label for the link (Read-only)
string url	The url to which the link points (Read-only)

UserLite Class

A 'lite' version of a User which the system often has more readily-available than a full version.

Members

Link{} data_link	Links to various machine-readable data sources relating to this user
string[] data_links_order	An array of data views which can be used to order the data_link hash
string journal_type	Type of account: P (personal), C (community), Y (syndicated), I (external identity) etc (Read-only)
string[] link_keyseq	Array of keys which can be passed into the get_link
string name	User's formatted name, ex: John Q. Public (Read-only)
string user	Backend Username: should match username for registered journals, external identities will be represented as ext_XXX instead (Read-only)
string username	Canonical Username, ex: johnqpub. Note that if journal_type is an external identity, there will be no username, so this field will be a display version of their URL, longer than 25 characters, and with characters other than a-z, 0-9 and underscore. (Read-only)
string userpic_listing_url	URL of a page listing this user's userpics (Read-only)

Methods

as_string() : string
base_url() : string	Returns URL of user's journal.
equals(UserLite u) : bool	Returns true if the two user objects refer to the same user. Use this rather than comparing usernames, since usernames aren't globally unique.
get_link(string key) : Link	Returns a link based on the given key, or null if the link is unavailable
icon_manage_url() : string	Returns URL to user's icon management page.
linklist_manage_url() : string	Returns URL to user's tag management page.
ljuser() : string	Returns an LJ user tag for the user.
ljuser(Color link_color) : string	Returns an LJ user tag for the user. The color of the link will be link_color.
print() : void
print_interaction_links() : void	Print the interaction links for this user/journal.
subscriptionfilters_manage_url() : string	Returns URL to user's subscription filter page.
tag_manage_url() : string	Returns URL to user's tag management page.

YearDay Class

Information on how to link to a day in the year archive

Members

Date date	Date of day
int day	Day of month number
int num_entries	Number of entries made on this day
string url	A URL to view the day, if there are entries, else blank. (Read-only)

YearMonth Class

A month on the YearPage.

Members

bool has_entries	If this is false, you probably don't want to display this month.
int month	The number of the month
Date next_date	Date of next month, with day of zero, or null if none.
string next_url	A url to link to in order to view the next month. (Read-only)
Date prev_date	Date of previous month, with day of zero, or null if none.
string prev_url	A url to link to in order to view the previous month. (Read-only)
string url	A url to link to in order to view this month. (Read-only)
YearWeek[] weeks	An array of the weeks of the month (for ease of building a row-per-week calendar)
int year	The number of the year

Methods

month_format() : string	Returns month formatted long (February 1980) /// SeeAlso: siteapi.core1.dateformats
month_format(string fmt) : string	Returns time formatted as indicated by $fmt, or 'long' if blank. /// SeeAlso: siteapi.core1.dateformats
month_format(string fmt, bool link) : string	Returns time formatted in the same way as calling month_format(string fmt), but with month and year as links to the corresponding archive pages.

YearPage Class

Child class of Page. Entire calendar page for a single year.

Members

Entry[] activeentries	Array of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} args	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
string base_url	The base URL of the journal being viewed. (Read-only)
string customtext_content	Content of customtext module (Read-only)
string customtext_title	Header of customtext module (Read-only)
string customtext_url	URL for header of customtext module (Read-only)
Link{} data_link	Links to various machine-readable data sources relating to this page
string[] data_links_order	An array of data views which can be used to order the data_link hash
string global_subtitle	A sub-title selected by the user for their whole journal. (Read-only)
string global_title	A title selected by the user for their whole journal. (Read-only)
bool has_activeentries	So we don't try to load the activeentries array when there are no entries to display
string head_content	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
bool include_meta_viewport	Whether we should print the meta viewport tag or not, based on the viewer's preferences (Read-only)
User journal	User whose journal is being viewed
string journal_type	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string layout_name	Name of the style being used in the journal you're viewing (Read-only)
string layout_url	URL of the style being used in the journal you're viewing (Read-only)
UserLink[] linklist	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_time	A DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
YearMonth[] months	12 months objects, even if no entries are in that month.
string stylesheet_url	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
string theme_name	Name of the theme being used in the journal you're viewing (Read-only)
DateTime time	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24	Indicates whether the time should be displayed in 24-hour format (Read-only)
string view	The view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_url	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
string[] views_order	An array of view identifiers which can be used to order the views hash. (Read-only)
int year	The year being viewed
YearYear[] years	Information for linking to other years

Methods

get_latest_month() : YearMonth	Returns information about the latest month the user posted (or the current month, if no entries), so that the page may include a mini-calendar or similar features.
print() : void	The main entry point that Dreamwidth calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
print_body() : void	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
print_contextual_stylesheet() : void	Prints the layout's default stylesheet for contextual popups.
print_control_strip() : void	Prints a control strip for the user's convenience
print_custom_head() : void	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
print_default_stylesheet() : void	Prints the layout's base default stylesheet.
print_default_stylesheets() : void	Prints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : void	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
print_entry_footer(Entry e) : void	Close up the entry
print_global_subtitle() : void
print_global_title() : void
print_head() : void	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
print_head_title() : void	Print the title for this particular page, as in print_title, formatted with <title> and the journal username
print_header() : void	Print information that should go in the page header such as page title and subtitle
print_linklist() : void	Print the list of UserLink objects specified by the user.
print_meta_tags() : void	Print meta tags. Needs to be within the first 512 bytes to work.
print_module_jump_link() : void	Print a link to jump to modules below the entries
print_module_section(string section_name) : void	Prints a module section, given a group name
print_month(YearMonth m) : void	Print the calendar cell for the given month
print_navigation() : void	Print out the page navigation links.
print_navigation(string{} opts) : void	Print out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : void	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
print_reply_link(string{} opts) : void	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
print_stylesheets() : void	Prints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : void	Prints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : void	Print the time when the page was created.
print_time(string datefmt, string timefmt) : void	Print the time when the page was created, with customized date/time formats.
print_title() : void	Print the title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
print_trusted(string key) : void	Prints a trusted string by key.
print_wrapper_end() : void	End the body wrapper for this entry or comment.
print_wrapper_start() : void	Start the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : void	Start the body wrapper for this page; includes default classes and takes a hash using the key 'class'
print_year_links() : void	Print the navigation links to move between years
title() : string	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
view_title() : string	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
visible_tag_list() : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed.
visible_tag_list(int limit) : TagDetail[]	Returns an array of tags that the logged in user can see for the journal being viewed, limited to the top $limit tags by number of uses.

YearWeek Class

Represents a week on the YearMonth on the YearPage.

Members

YearDay[] days	An array of the days of the week (0=sunday)
int post_empty	How many days at the end of the week are blank? (From next month)
int pre_empty	How many days at the start of the week are blank? (From previous month)

Methods

print() : void

Print formatted week

YearYear Class

Information on how to link to a year in the year archive

Members

bool displayed	If this is the year currently being displayed, this will be true.
string url	URL to link to for this year. (Read-only)
int year	Number of the year, eg 2001.