Dreamwidth S2 Core, v2

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

Layer Info

author_emailwebmaster@dreamwidth.org
author_nameDreamwidth Webmaster
majorversion2
nameDreamwidth S2 Core, v2
redist_uniqcore2
typecore

Properties Set

all_commentsubjects0
all_entrysubjects1
color_comment_bar  #d0d0ff
comment_date_formatiso
comment_datetime_format_group[
  • comment_date_format,
  • comment_time_format,
]
comment_management_linksicons
comment_page_next&gt;&gt
comment_page_prev&lt;&lt
comment_time_formatshort
comment_userpic_style(empty)
custom_background_element(empty)
custom_colors_template(empty)
custom_control_strip_colorsoff
custom_css(empty)
custom_foreground_element(empty)
entry_date_formatmed
entry_datetime_format_group[
  • entry_date_format,
  • entry_time_format,
]
entry_management_linksicons
entry_metadata_positionbottom
entry_time_formatshort
entry_userpic_style(empty)
external_stylesheet1
font_base(empty)
font_fallback(empty)
icons_page_sortupload
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_stylesheet1
lang_currenten
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_support1
margins_size0
margins_unitem
module_active_group[
  • module_active_show,
  • module_active_order,
  • module_active_section,
]
module_active_order8
module_active_sectionone
module_active_show1
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_order3
module_calendar_sectionone
module_calendar_show1
module_credit_group[
  • module_credit_show,
  • module_credit_order,
  • module_credit_section,
]
module_credit_order14
module_credit_sectionone
module_credit_show1
module_customtext_group[
  • module_customtext_show,
  • module_customtext_order,
  • module_customtext_section,
]
module_customtext_order13
module_customtext_sectionone
module_customtext_show0
module_cuttagcontrols_group[
  • module_cuttagcontrols_show,
  • module_cuttagcontrols_order,
  • module_cuttagcontrols_section,
]
module_cuttagcontrols_order16
module_cuttagcontrols_sectionone
module_cuttagcontrols_show1
module_layout_sectionsnone|(none)|one|Main Module Section|two|Second Module Section
module_links_group[
  • module_links_show,
  • module_links_order,
  • module_links_section,
]
module_links_order4
module_links_sectionone
module_links_show1
module_navlinks_group[
  • module_navlinks_show,
  • module_navlinks_order,
  • module_navlinks_section,
]
module_navlinks_order2
module_navlinks_sectionone
module_navlinks_show1
module_pagesummary_group[
  • module_pagesummary_show,
  • module_pagesummary_order,
  • module_pagesummary_section,
  • module_pagesummary_opts_group,
]
module_pagesummary_opts_comments_tooltip1
module_pagesummary_opts_group[
  • module_pagesummary_opts_comments_tooltip,
]
module_pagesummary_order7
module_pagesummary_sectionone
module_pagesummary_show1
module_poweredby_group[
  • module_poweredby_show,
  • module_poweredby_order,
  • module_poweredby_section,
]
module_poweredby_order12
module_poweredby_sectiontwo
module_poweredby_show1
module_search_group[
  • module_search_show,
  • module_search_order,
  • module_search_section,
]
module_search_order15
module_search_sectionone
module_search_show1
module_syndicate_group[
  • module_syndicate_show,
  • module_syndicate_order,
  • module_syndicate_section,
]
module_syndicate_order5
module_syndicate_sectionone
module_syndicate_show1
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_limit50
module_tags_opts_type(empty)
module_tags_order6
module_tags_sectionone
module_tags_show1
module_time_group[
  • module_time_show,
  • module_time_order,
  • module_time_section,
]
module_time_order11
module_time_sectiontwo
module_time_show1
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_name1
module_userprofile_opts_userpic1
module_userprofile_opts_website1
module_userprofile_order1
module_userprofile_sectionone
module_userprofile_show1
num_items_icons0
num_items_reading20
num_items_recent20
reg_firstdayofweeksunday
reverse_sortorder_day0
reverse_sortorder_group[
  • reverse_sortorder_day,
  • reverse_sortorder_year,
]
reverse_sortorder_reading1
reverse_sortorder_recent1
reverse_sortorder_year0
separator_image_group[
  • separator_image_url,
  • separator_image_repeat,
  • separator_image_position,
]
show_userpics_comments1
show_userpics_entry1
show_userpics_group[
  • show_userpics_recent,
  • show_userpics_reading,
  • show_userpics_entry,
  • show_userpics_comments,
]
show_userpics_reading1
show_userpics_recent1
sidebar_width(empty)
sidebar_width_doubled(empty)
tags_aware1
tags_page_count_type(empty)
tags_page_typemulti
text_base_layout_authorsBase style:
text_calendar_num_entries1 entry // # entries
text_comment_dateDate:
text_comment_edittimeEdited
text_comment_expandExpand
text_comment_fromFrom:
text_comment_frozenFrozen
text_comment_hideHide 1 comment // Hide # comments
text_comment_ipaddrIP Address:
text_comment_linkLink
text_comment_parentParent
text_comment_postedComment successfully posted.
text_comment_replyReply
text_comment_threadThread
text_comment_threadrootThread from start
text_comment_unhideShow 1 comment // Show # comments
text_comments_disabled_maintainerComments disabled by a maintainer of this community
text_cuttagcontrols_nocuttagsNo cut tags
text_day_nextNext Day
text_day_prevPrevious Day
text_default_separator |
text_deleted(deleted comment)
text_edit_entryEdit Entry
text_edit_tagsEdit Tags
text_entry_nextNext Entry
text_entry_prevPrevious Entry
text_fromsuspended(reply from suspended user)
text_frozen(frozen)
text_generated_onPage generated
text_icon_alt_18[18+]
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_manageManage Icons
text_icons_commentComment:
text_icons_defaultDefault
text_icons_descriptionDescription:
text_icons_inactiveInactive
text_icons_keyword_sep,
text_icons_keywordsKeywords:
text_icons_page_empty_headerNo Icons
text_icons_page_headerCurrent Icons
text_icons_sort_keywordKeyword Order
text_icons_sort_uploadUpload Order
text_layout_authorsStyle:
text_layout_resourcesResources:
text_linklist_manageManage Links
text_max_commentsMaximum comments reached
text_mem_addAdd Memory
text_meta_groupsCustom Access Groups
text_meta_locationCurrent Location
text_meta_moodCurrent Mood
text_meta_musicCurrent Music
text_meta_xpostCrossposts
text_module_active_entriesActive Entries
text_module_creditStyle Credit
text_module_customtextCustom Text
text_module_customtext_content(empty)
text_module_customtext_url(empty)
text_module_cuttagcontrolsExpand Cut Tags
text_module_linksLinks
text_module_pagesummaryPage Summary
text_module_popular_tagsMost Popular Tags
text_module_syndicateSyndicate
text_module_tagsTags
text_month_form_btnView
text_month_screened_commentsw/ Screened
text_multiform_btnPerform Action
text_multiform_checkSelect:
text_multiform_conf_deleteDelete selected comments?
text_multiform_desMass action on selected comments:
text_multiform_opt_deleteDelete
text_multiform_opt_deletespamDelete as Spam
text_multiform_opt_editEdit
text_multiform_opt_freezeFreeze
text_multiform_opt_screenScreen
text_multiform_opt_trackTrack This
text_multiform_opt_unfreezeUnfreeze
text_multiform_opt_unscreenUnscreen
text_multiform_opt_unscreen_to_replyUnscreen to reply
text_multiform_opt_untrackUntrack This
text_noentries_dayThere were no entries on this day.
text_noentries_readThere are no earlier entries to display. This page displays only the most recent 1000 entries posted within the last 14 days.
text_noentries_recentThere are no entries to display.
text_nosubject(no subject)
text_nosubject_screenreaderno subject
text_openid_fromfrom
text_page_topTop of page
text_permalinkLink
text_post_commentReply
text_post_comment_friendsReply
text_poster_anonymous(Anonymous)
text_posting_in posting in
text_powered_byPowered by
text_read_comments1 comment // # comments
text_read_comments_friends1 comment // # comments
text_read_comments_threads1 response // # responses
text_reply_backRead Comments
text_reply_nocommentsComments have been disabled for this post.
text_reply_nocomments_headerComments Disabled:
text_replyform_headerComment Form
text_screened(screened comment)
text_skiplinks_backPrevious #
text_skiplinks_forwardNext #
text_stickyentry_subjectSticky:
text_tag_uses1 use // # uses
text_tagsTags:
text_tags_item_sep,
text_tags_manageManage Tags
text_tags_page_headerVisible Tags
text_tagsmultilevel_delimiter:
text_tell_friendShare This Entry
text_theme_authorsTheme:
text_unwatch_commentsUntrack This
text_user_manage_membershipMembership
text_user_memoriesMemories
text_user_messageSend Message
text_user_post_entryPost
text_user_tell_friendShare Journal Link
text_user_trackTrack Entries
text_user_trustManage Access
text_user_watchManage Subscription
text_view_archiveArchive
text_view_friendsReading
text_view_friends_commMember Posts
text_view_friends_filterReading (Custom filter)
text_view_iconsIcons
text_view_memoriesMemories
text_view_monthView Subjects
text_view_networkNetwork
text_view_network_filterNetwork (Custom filter)
text_view_recentRecent Entries
text_view_recent_taggedEntries tagged with
text_view_tagsTags
text_view_userinfoProfile
text_watch_commentsTrack This
text_website_default_nameMy Website
theme_authors[]
time_ago_days1 day // # days
time_ago_hours1 hour // # hours
time_ago_minutes1 minute // # minutes
time_ago_seconds1 second // # seconds
use_custom_friend_colors0
use_journalstyle_entry_page1
use_journalstyle_icons_page0
use_shared_pic0
userlite_interaction_linksicons
userpics_positionleft
userpics_style_group[
  • entry_userpic_style,
  • comment_userpic_style,
]

Global Functions

PalItem(int index, Color c) : PalItemConvenience constructor to make populating an array of PalItems (like in palimg_modify(string,PalItem[])) easy.
UserLite(string username) : UserLiteConstructor for making a UserLite object from a username
alternate(string a, string b) : stringWith 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) : stringProvide 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) : stringReturns 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() : stringReturns CSS for the loggedout_userpic div in the logged out version of the control strip.
control_strip_logged_out_userpic_css() : stringReturns CSS for the userpic div in the logged out version of the control strip.
ehtml(string s) : stringEscapes all HTML tags and entities from the text
end_css() : voidDeclare that you're done printing CSS and the output thus buffered should be cleaned and printed.
etags(string s) : stringEscapes all HTML tags (but not entities) from text
eurl(string s) : stringURL escape
generate_background_css(string background_image, string background_image_repeat, string background_image_position, Color background_color) : stringTake 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) : stringTake 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) : stringTake an image property and append static diretory path if not given absolute path
get_image(string key) : ImageGiven 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() : PageGets the top-level Page instance that Dreamwidth ran the Page.print() method on.
get_plural_phrase(int n, string prop) : stringPicks 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) : stringReturns 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) : stringReturns 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) : stringIf 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) : stringIf the value isn't blank, return in HTML attribute format with a leading space. HTML of name is not escaped.
int(string s) : intConvert the string to an integer and return
journal_current_datetime() : DateTimeReturns the current datetime in the timezone of the journal being viewed.
keys_alpha(string{} elements) : string[]Return the keys of the array in alphabetically sorted order.
lang_at_datetime(DateTime d) : stringReturns 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) : stringGet 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) : intThis 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) : stringGet 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) : stringMake an ordinal number from a cardinal number. Override only for language layers.
lang_ordinal(string num) : stringMake 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) : stringThis function returns the current page number as well as number of available pages. Override for language layers.
lang_user_wrote(UserLite u) : stringReturns 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) : stringOverriding 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() : voidThis function sets up the modules. It is called immediately after prop_init.
open_module(string intname, string title, string headlink_url) : voidOpens up a module for printing, using the appropriate HTML/CSS.
open_module(string intname, string title, string headlink_url, bool nocontent) : voidOpens up a module for printing, using the appropriate HTML/CSS.
pageview_unique_string() : stringReturns a unique string for the remote user.
palimg_gradient(string filename, PalItem start, PalItem end) : stringReturn 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) : stringReturn 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) : stringReturn 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) : stringReturn 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) : voidPrints 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() : voidPrints 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() : voidPrints out a link to the links list management page, if the viewer can manage the list.
print_list_tags(TagDetail[] tagslist, string{} opts) : voidPrints 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) : voidTakes a straight list of strings, prints them out as a list for a module
print_module_list(string{}[] list) : voidTakes 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_syndicate() : void 
print_module_tags() : void 
print_module_time() : void 
print_module_userprofile() : void 
print_multilevel_tags(TagDetail[] tagslist) : voidPrints out a list of multilevel tags. Takes as arguments the taglist.
print_multilevel_tags(TagDetail[] tagslist, string{} opts) : voidPrints 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) : voidPrints a search form, with the button text as the label to the submit button.
print_stylesheet() : voidPrints 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_tag_manage_link() : voidPrints out a link to the tag management page, if the viewer can manage tags.
prop_init() : voidThis 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) : intReturns a random integer between 1 and $high, inclusive.
rand(int low, int high) : intReturns a random integer between $low and $high, inclusive.
secs_to_string(int sec) : string 
server_sig() : voidProvides the site branding for each page.
set_content_type(string text) : voidSet 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() : voidDeclare 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) : stringReturn the given integer as a string
striphtml(string s) : stringSimilar to ehtml, but the HTML tags are stripped rather than escaped.
style_is_active() : boolReturns 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) : ImagePrints 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() : boolReturns true if the user viewing the page can add, edit, and delete tags on the journal being viewed.
viewer_can_search() : boolReturns true if the user viewing the page is logged in and can search that journal.
viewer_has_access() : boolReturns 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() : boolReturns true if the user viewing a community is logged in and is an admin of the community.
viewer_is_friend() : boolReturns 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() : boolReturns 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() : boolReturns true if the user viewing a community is logged in and a moderator of the community.
viewer_is_owner() : boolReturns 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() : boolReturns true if the user viewing the page is logged in and subscribes to the journal being viewed.
viewer_logged_in() : boolReturns 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() : boolReturns 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) : stringReturns the number padded with zeroes so it has the amount of digits indicated.
zeropad(string n, int digits) : stringReturns the number padded with zeroes so it has the amount of digits indicated.

Classes

AlphabeticalHierarchical

Color Class

Represents a color.

Members

string as_stringHTML hex encoded: #rrggbb
int bBlue value, 0-255. (Read-only)
int gGreen value, 0-255. (Read-only)
int rRed value, 0-255. (Read-only)

Methods

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

Comment Class

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

Members

string anchorDirect link to comment, via HTML name anchors (Read-only)
bool comment_postedTrue if comment was just posted by the current user. (Read-only)
bool deletedTrue if comment has been deleted. Deleted comments still show up if they are the parent of a thread. (Read-only)
int depthVisual 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_idThe DOM 'id' attribute you should put on your outer-most element (Read-only)
string echiThe Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool editedTrue if the comment has been edited. (Read-only)
string editreasonThe reason this comment was last edited (Read-only)
DateTime edittimeThe GMT time the comment was edited. Or undef if the comment hasn't been edited. (Read-only)
DateTime edittime_posterThe 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_remoteThe 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 fromsuspendedTrue if comment's author has been suspended. (Read-only)
bool frozenTrue if comment is in frozen state. (Read-only)
bool fullTrue if all information is available for this comment. False if only the subject, poster, and date are available. (collapsed threads)
bool hidden_childIndicates if the child is hidden by default. (Read-only)
bool hide_childrenIndicates we are hiding the children of this comment (Read-only)
UserLite journalJournal the entry has been posted to
string[] link_keyseqAn 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{} metadataPost metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
string parent_urlURL to parent comment, or blank if a top-level comment. (Read-only)
string permalink_urlA URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite posterAuthor of the entry, or null if an anonymous comment
Comment[] repliesComments replying to this comment.
string reply_urlURL to reply to this comment. (Read-only)
bool screenedTrue if comment is in screened state. (Read-only)
bool screened_noshowTrue if comment is in screened state and user isn't allowed to see it. (Read-only)
int seconds_since_entryThe number of elapsed seconds from the time of the journal entry until the comment was initially posted. (Read-only)
string subjectSubject. May contain HTML. Don't do substring chops on this. (Read-only)
Image subject_iconSubject icon, or null.
DateTime system_timeThe system time (in GMT) this entry or comment was posted.
Tag[] tagsArray of tags applied to this entry. (Read-only)
int talkidServer stored ID number for this comment.
string textEntry 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_trustedIndicates 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_urlURL to view threaded rooted at this comment, or blank if comment has no children. (Read-only)
string threadroot_urlURL to view the entire thread this comment is part of, or blank if a top-level comment. (Read-only)
DateTime timeThe user-specified time of the post, or the GMT time if it's a comment.
DateTime time_posterThe 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_remoteThe 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 timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpicThe userpic selected to relate to this entry.

Methods

edittime_display() : stringShow 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) : stringedittime_display, with customized date/time formats.
expand_link() : stringReturns 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) : stringReturns 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) : stringformats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : LinkGet 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() : stringFor 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() : stringReturns 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_edit_text() : voidPrint the text that says when this comment was edited.
print_edittime() : voidPrint 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) : voidprint_edittime, with customized date/time formats.
print_expand_link() : stringPrints a link to expand a collapsed comment. Uses the value of the 'text_comment_expand' property as the text.
print_expand_link(string{} opts) : stringPrints a link to expand a collapsed comment. Can pass options 'text', 'title', 'class', and 'img_url' (and other 'img_*' options).
print_hide_link() : stringPrints a link to hide a comment thread. Uses the value of the 'text_comment_hide' property as the text.
print_hide_link(string{} opts) : stringPrints a link to hide a comment. Can pass options 'text', 'title', 'class', and 'img_url' (and other 'img_*' options).
print_interaction_links() : voidPrint the links to interact with this entry or comment. (Post a comment etc)
print_management_links() : voidPrint the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : voidPrint the metadata associated with this entry or comment
print_metatypes() : voidPrint the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_multiform_check() : voidPrints 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() : voidPrint the poster of the entry or comment (user or user in journal, etc)
print_reply_container() : voidPrints the area in which the quickreply box will go. If no container is available, quickreply will not work.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrint the formatted subject for this entry or comment
print_subject(string{} opts) : voidPrint the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_text() : voidPrint the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : voidPrint the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : voidPrint the time of the post, with customized date/time formats.
print_time(string datefmt, string timefmt, bool edittime) : voidSame as EntryLite::print_time, except can pass in if we want the edit time or not.
print_unhide_link() : stringPrints a link to unhide a comment thread. Uses the value of the 'text_comment_unhide' property as the text.
print_unhide_link(string{} opts) : stringPrints a link to hide a comment. Can pass options 'text', 'title', 'class', and 'img_url' (and other 'img_*' options).
print_userpic() : voidPrint the userpic for this entry or comment
print_wrapper_end() : voidEnd the wrapper for this entry or comment.
print_wrapper_start() : voidStart the wrapper for this entry or comment; includes anchor and classes
time_display() : stringShow the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : stringtime_display, with customized date/time formats.
time_display(string datefmt, string timefmt, bool edittime) : stringSame 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_maintainerSet to true if the comments on this entry were disabled by a community maintainer
int countCurrent number of comments available to be read by the viewer.
bool enabledSet to false if comments disabled journal-wide or just on this item.
bool maxcommentsSet to true if entry has reached a comment maximum.
string permalink_urlPermanent URL for the entry. (Read-only)
string post_urlURL pointer to the 'Post Comments' view. (Read-only)
string read_urlURL pointer to the 'Read Comments' view. (Read-only)
bool screenedSet to true if there are screened comments and remote user can unscreen them.
bool show_postlinkIndicates whether the Post Comment link for this entry should be shown.
bool show_readlinkIndicates whether the Read Comments link for this entry should be shown.

Methods

print() : voidPrint all comment related links
print_postlink() : voidPrint the formatted link to the 'Post Comments' view
print_readlink() : voidPrint the formatted link to the 'Read Comments' view

CommentNav Class

Represents the comment navigation bar.

Members

int current_pageThe currently displayed page
bool filterTrue if the current view is filtered.
bool show_expand_allTrue if we should show the expand_all option.
string urlThe url for this entry page, complete with style argument if present.
string view_modeThe current view mode (threaded, flat, top-only).

Methods

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

Date Class

Represents a date.

Members

int dayDay; 1-31.
int monthMonth; 1-12.
int yearYear; 4 digits.

Methods

compare(Date d) : intCompare 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) : intCompare 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() : stringReturns date formatted as normal. /// SeeAlso: siteapi.core1.dateformats
date_format(string fmt) : stringReturns 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) : stringReturns 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() : intReturns 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 dayDay; 1-31.
int hourHour; 0-23.
int minMinute; 0-59.
int monthMonth; 1-12.
int secSecond; 0-59.
int yearYear; 4 digits.

Methods

compare(Date d) : intCompare 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) : intCompare 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() : stringReturns date formatted as normal. /// SeeAlso: siteapi.core1.dateformats
date_format(string fmt) : stringReturns 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) : stringReturns 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() : intReturns the day of the week this date falls on, from Sunday=1 to Saturday=7
time_format() : stringReturns time formatted as normal. /// SeeAlso: siteapi.core1.dateformats
time_format(string fmt) : stringReturns 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[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Date dateDate of the current day
Entry[] entriesArray of entries available to be seen by the viewer of the page
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
bool has_entriesTrue if there are entries on the specified day
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
Date next_dateNext day
string next_urlURL to next day (Read-only)
Date prev_datePrevious day
string prev_urlURL to previous day (Read-only)
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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

Image adult_content_iconA little icon which should be displayed somewhere on an entry to represent the adult content level
string adult_content_levelThe adult content level ('NSFW', '18'), or blank if unrestricted. (Read-only)
CommentInfo commentsComment information on this entry
int depthVisual 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_idThe DOM 'id' attribute you should put on your outer-most element (Read-only)
string echiThe Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool end_dayIs this the last entry of a day?
bool hidden_childIndicates if the child is hidden by default. (Read-only)
bool hide_childrenIndicates we are hiding the children of this comment (Read-only)
int itemidServer stored ID number for this entry
UserLite journalJournal the entry has been posted to
string[] link_keyseqAn 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{} metadataPost metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
Image mood_iconMood icon, or null.
bool new_dayIs this entry on a different day to the previous one?
string permalink_urlA URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite posterAuthor of the entry, or null if an anonymous comment
string securityThe security level of the entry ('private', 'protected'), or blank if public. (Read-only)
Image security_iconA little icon which should be displayed somewhere on an entry to represent the security setting
string subjectSubject. May contain HTML. Don't do substring chops on this. (Read-only)
DateTime system_timeThe system time (in GMT) this entry or comment was posted.
Tag[] tagsArray of tags applied to this entry. (Read-only)
string textEntry 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_trustedIndicates 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 timeThe user-specified time of the post, or the GMT time if it's a comment.
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpicThe userpic selected to relate to this entry.

Methods

formatted_subject(string{} opts) : stringformats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : LinkGet 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() : stringFor 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() : stringReturns 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() : stringReturn entry's subject as plain text, with all HTML removed.
print_ebox() : voidPrints a small horizontal bar of site-specific content between entries in a journal.
print_interaction_links() : voidPrint the links to interact with this entry or comment. (Post a comment etc)
print_interaction_links(string target) : voidPrint the links to interact with this entry or comment, with target.
print_link_next() : voidPrint the link to the next entry in this journal.
print_link_prev() : voidPrint the link to the previous entry in this journal.
print_management_links() : voidPrint the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : voidPrint the metadata associated with this entry or comment
print_metatypes() : voidPrint the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_metatypes(bool icon, bool info) : voidPrint the metatype information for this entry
print_poster() : voidPrint the poster of the entry or comment (user or user in journal, etc)
print_subject() : voidPrint the formatted subject for this entry or comment
print_subject(string{} opts) : voidPrint the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_tags() : voidPrint the tags for this entry.
print_text() : voidPrint the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : voidPrint the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : voidPrint the time of the post, with customized date/time formats.
print_userpic() : voidPrint the userpic for this entry or comment
print_wrapper_end() : voidEnd the wrapper for this entry or comment.
print_wrapper_start() : voidStart the wrapper for this entry or comment; includes anchor and classes
time_display() : stringShow the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : stringtime_display, with customized date/time formats.
viewer_sees_ebox() : boolTrue 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

int depthVisual 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_idThe DOM 'id' attribute you should put on your outer-most element (Read-only)
string echiThe Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool hidden_childIndicates if the child is hidden by default. (Read-only)
bool hide_childrenIndicates we are hiding the children of this comment (Read-only)
UserLite journalJournal the entry has been posted to
string[] link_keyseqAn 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{} metadataPost metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
string permalink_urlA URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite posterAuthor of the entry, or null if an anonymous comment
string subjectSubject. May contain HTML. Don't do substring chops on this. (Read-only)
DateTime system_timeThe system time (in GMT) this entry or comment was posted.
Tag[] tagsArray of tags applied to this entry. (Read-only)
string textEntry 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_trustedIndicates 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 timeThe user-specified time of the post, or the GMT time if it's a comment.
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpicThe userpic selected to relate to this entry.

Methods

formatted_subject(string{} opts) : stringformats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : LinkGet 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() : stringFor 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() : stringReturns 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_interaction_links() : voidPrint the links to interact with this entry or comment. (Post a comment etc)
print_management_links() : voidPrint the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : voidPrint the metadata associated with this entry or comment
print_metatypes() : voidPrint the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_poster() : voidPrint the poster of the entry or comment (user or user in journal, etc)
print_subject() : voidPrint the formatted subject for this entry or comment
print_subject(string{} opts) : voidPrint the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_text() : voidPrint the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : voidPrint the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : voidPrint the time of the post, with customized date/time formats.
print_userpic() : voidPrint the userpic for this entry or comment
print_wrapper_end() : voidEnd the wrapper for this entry or comment.
print_wrapper_start() : voidStart the wrapper for this entry or comment; includes anchor and classes
time_display() : stringShow the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : stringtime_display, with customized date/time formats.

EntryPage Class

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

Members

Entry[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
CommentNav comment_navThe comment navigation bar
ItemRange comment_pagesRepresents what comment page is being displayed.
Comment[] commentsComments to journal entry, or at least some of them.
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Entry entryJournal entry being viewed
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
bool multiform_onSet to true if the multi-action is to be printed, which requires both comments and applicable permissions for the remote user.
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_threadTrue 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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) : voidPrints a full comment
print_comment_partial(Comment comment) : voidPrints a collapsed comment
print_comment_section(Entry entry) : voidPrints comment section
print_comments(Comment[] comments) : voidPrints comments
print_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_multiform_actionline() : voidPrints the line of the multiform giving instructions, options, and the submit button, using the text of the different $*text_multiform_ properties.
print_multiform_end() : voidPrints end of form tag to do a multi-comment action.
print_multiform_start() : voidPrints start of form tag and hidden elements to do a multi-comment action (multiple delete, screen, unscreen, etc...)
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
CommentNav comment_navThe comment navigation bar
ItemRange comment_pagesRepresents what comment page is being displayed.
Comment[] commentsComments to journal entry, or at least some of them.
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Entry entryJournal entry being viewed
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
bool multiform_onSet to true if the multi-action is to be printed, which requires both comments and applicable permissions for the remote user.
string preview_warn_textText to display instead of management controls for previews
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_threadTrue 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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) : voidPrints a full comment
print_comment_partial(Comment comment) : voidPrints a collapsed comment
print_comment_section(Entry entry) : voidPrints comment section
print_comments(Comment[] comments) : voidPrints comments
print_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_multiform_actionline() : voidPrints the line of the multiform giving instructions, options, and the submit button, using the text of the different $*text_multiform_ properties.
print_multiform_end() : voidPrints end of form tag to do a multi-comment action.
print_multiform_start() : voidPrints start of form tag and hidden elements to do a multi-comment action (multiple delete, screen, unscreen, etc...)
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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) : voidPrints a standout box containing a message
print_stylesheets() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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 bgcolorBackground color selected for friend
Link{} data_linkLinks to various machine-readable data sources relating to this user
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Color fgcolorForeground color selected for friend
string journal_typeType of account: P (personal), C (community), Y (syndicated), I (external identity) etc (Read-only)
string[] link_keyseqArray of keys which can be passed into the get_link
string nameUser's formatted name, ex: John Q. Public (Read-only)
string usernameCanonical 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_urlURL of a page listing this user's userpics (Read-only)

Methods

as_string() : string 
base_url() : stringReturns URL of user's journal.
equals(UserLite u) : boolReturns 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) : LinkReturns a link based on the given key, or null if the link is unavailable
icon_manage_url() : stringReturns URL to user's icon management page.
linklist_manage_url() : stringReturns URL to user's tag management page.
ljuser() : stringReturns an LJ user tag for the user.
ljuser(Color link_color) : stringReturns an LJ user tag for the user. The color of the link will be link_color.
print() : void 
print_interaction_links() : voidPrint the interaction links for this user/journal.
tag_manage_url() : stringReturns URL to user's tag management page.

FriendsPage Class

Child class of RecentPage. Friends most recent entries

Members

Entry[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Entry[] entriesArray of entries available to be seen by the viewer of the page.
bool filter_activeIf true, some kind of filter is in effect. If this filter has a name, it will be included in RecentPage.filter_name
string filter_nameThe name of the filter in effect, if it has a name. This is only used when RecentPage.filter_active is true.
bool filter_tagsIf 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{} friendsA mapping from friend username to color association information. There will only be keys for friends whose entries are in the entries array.
string friends_modeThe 'mode' of this view. An empty string indicates a normal friends view, while 'network' indicates the network view.
string friends_subtitleA user-selected subtitle for their friends page. (Read-only)
string friends_titleA user-selected title for their friends page. (Read-only)
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
RecentNav nav 
StickyEntry stickyentryEntry shown on top of the Recent Entries page
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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) : voidfunction to print the sticky entry
print_stylesheets() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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 activeIf this icon is active (Read-only)
string commentComment text (Read-only)
bool defaultIf this icon is the default (Read-only)
string descriptionDescription text (Read-only)
Image imageInformation about the icon (Read-only)
string[] keywordsAll keywords (Read-only)
string link_urlURL this image links to when clicked (Read-only)

Methods

print() : voidPrints the icon

IconsPage Class

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

Members

Entry[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
bool can_manageCan the current user manage these icons. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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[] iconsList of the icons on the current page. (Read-only)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
ItemRange pagesAll pages (Read-only)
string[] sort_keyseqA list of sort orders, indicated by key. (Read-only)
string{} sort_urlsAn associative array of link for various sort orders. (Read-only)
string sortorderCurrent sort order. Can be 'upload' or 'keyword'. (Read-only)
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_icon_manage_link() : voidPrints out a link to the icon management page, if the viewer can manage icons.
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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 alttextDefault alternative text for image
string{} extraExtra params for img tag (Read-only)
int heightHeight in pixels
string urlURL of the image (Read-only)
int widthWidth in pixels

Methods

as_string() : stringReturn the HTML tag for this image
as_string(string alttext) : stringReturn an HTML tag for this Image with given alttext
as_string(string{} opts) : stringReturn 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() : voidPrint an HTML tag for this Image
print(string alttext) : voidPrint an HTML tag for this Image with given alttext
print(string{} opts) : voidPrint 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) : voidSets 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) : intCompare 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) : stringReturn 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_displayedTrue if the subitems in this range represent the entire set. In this case, all of the URL members are blank.
int currentThe currently-active item.
int from_subitemThe index of the first subitem in this range.
int num_subitems_displayedThe number of subitems in this range.
int to_subitemThe index of the last subitem in this range.
int totalThe total number of items that are navigable to.
int total_subitemsThe number of subitems.
string url_allURL to view all items. Blank if we don't support viewing all items for this. (Read-only)
string url_firstURL for the 'first' link. Blank if already on the first page. (Read-only)
string url_lastURL for the 'last' link. Blank if already on the last page. (Read-only)
string url_nextURL for the 'next' link. Blank if there isn't a next URL. (Read-only)
string url_prevURL for the 'previous' link. Blank if there isn't a previous URL. (Read-only)

Methods

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

Link Class

A link or button

Members

string captionThe caption for the link (Read-only)
string{} extraExtra attributes passed to the link (Read-only)
Image iconA 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 urlURL which the link points to (Read-only)

Methods

as_string() : stringReturn the button HTML link.
print_button() : voidOutput 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[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
string[] link_keyseqA 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[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
Link{} linksAn associative array of links to be displayed alongside this message. Iterate over MessagePage.link_keyseq to find the keys.
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
string messageThe body of the message. Do not print this directly; use MessagePage.print_body() instead. (Read-only)
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string titleThe title of the message. (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_links() : voidPrint the links from the MessagePage.links and MessagePage.link_keyseq members. Layouts will probably want to override this.
print_message() : voidPrint the message. Call this rather than printing MessagePage.message directly.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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 dateDate of day
int dayDay of month number
Entry[] entriesOnly populated on the month view. Entry text not present.
bool has_entriesTrue if there are entries on this day.
int num_entriesNumber of entries made on this day
string urlA URL to view the day, if there are entries, else blank. (Read-only)

Methods

print_subjectlist() : voidPrint 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 dateDate of month, with day of zero.
string redir_keyThe 'redir_key' parameter for a Redirector instance. (Read-only)
string urlURL 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[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Date dateDate of this month, with day of zero.
MonthDay[] daysOne entry for each day of the month.
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
MonthEntryInfo[] monthsOther months this journal has entries.
Date next_dateDate of next month, with day of zero, or null if none.
string next_urlURL of next month, or empty string if none. (Read-only)
Date prev_dateDate of previous month, with day of zero, or null if none.
string prev_urlURL of previous month, or empty string if none. (Read-only)
Redirector redirNecessary to make a form which POSTs to a redirector
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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 colorColor to put at specified index.
int indexInteger palette index.

RecentNav Class

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

Members

int backward_countNumber of items we'd be potentially seeing going backward.
int backward_skipNumber of items we'd be skipping going back more.
string backward_urlURL to go backward in time, or blank if furthest back server will allow. (Read-only)
int countIndicates how many entries we're currently seeing
int forward_countNumber of items we'd be potentially seeing going forward.
int forward_skipNumber of items we'd be skipping going forward.
string forward_urlURL to go forward in time, or blank if furthest forward. (Read-only)
int skipIndicates how many entries are being skipped back.
int versionCurrently 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[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Entry[] entriesArray of entries available to be seen by the viewer of the page.
bool filter_activeIf true, some kind of filter is in effect. If this filter has a name, it will be included in RecentPage.filter_name
string filter_nameThe name of the filter in effect, if it has a name. This is only used when RecentPage.filter_active is true.
bool filter_tagsIf 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_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
RecentNav nav 
StickyEntry stickyentryEntry shown on top of the Recent Entries page
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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) : voidfunction to print the sticky entry
print_stylesheets() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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() : voidPrints a form close tag.
get_url(string redir_key) : voidReturns a GET URL, given a redir_key
print_hiddens() : voidPrints the necessary hidden elements for a form. Called automatically by Redirector.start_form().
start_form() : voidStarts 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_iconsWhether 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() : voidPrints the reply form

ReplyPage Class

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

Members

Entry[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Entry entryThe journal entry for this talk page
ReplyForm formThe reply form.
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
EntryLite replytoThe object which is being replied to, either the entry or a comment
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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) : voidPrints a full comment
print_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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

Image adult_content_iconA little icon which should be displayed somewhere on an entry to represent the adult content level
string adult_content_levelThe adult content level ('NSFW', '18'), or blank if unrestricted. (Read-only)
CommentInfo commentsComment information on this entry
int depthVisual 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_idThe DOM 'id' attribute you should put on your outer-most element (Read-only)
string echiThe Explicit Comment Hierarchy Indicator, if enabled by user. (Read-only)
bool end_dayIs this the last entry of a day?
bool hidden_childIndicates if the child is hidden by default. (Read-only)
bool hide_childrenIndicates we are hiding the children of this comment (Read-only)
int itemidServer stored ID number for this entry
UserLite journalJournal the entry has been posted to
string[] link_keyseqAn 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{} metadataPost metadata. Keys: 'music', 'mood', 'location', 'groups', 'xpost'. Comment metadata. Key: 'poster_ip' (Read-only)
Image mood_iconMood icon, or null.
bool new_dayIs this entry on a different day to the previous one?
string permalink_urlA URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite posterAuthor of the entry, or null if an anonymous comment
string securityThe security level of the entry ('private', 'protected'), or blank if public. (Read-only)
Image security_iconA little icon which should be displayed somewhere on an entry to represent the security setting
Image sticky_entry_iconA little icon displayed next to the subject of a sticky entry post
string subjectSubject. May contain HTML. Don't do substring chops on this. (Read-only)
DateTime system_timeThe system time (in GMT) this entry or comment was posted.
Tag[] tagsArray of tags applied to this entry. (Read-only)
string textEntry 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_trustedIndicates 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 timeThe user-specified time of the post, or the GMT time if it's a comment.
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
Image userpicThe userpic selected to relate to this entry.

Methods

formatted_subject(string{} opts) : stringformats subject - outputs subject as html-link, gets hash of attributes - class and(or) style
get_link(string key) : LinkGet 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() : stringFor 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() : stringReturns 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() : stringReturn entry's subject as plain text, with all HTML removed.
print_ebox() : voidPrints a small horizontal bar of site-specific content between entries in a journal.
print_interaction_links() : voidPrint the links to interact with this entry or comment. (Post a comment etc)
print_interaction_links(string target) : voidPrint the links to interact with this entry or comment, with target.
print_link_next() : voidPrint the link to the next entry in this journal.
print_link_prev() : voidPrint the link to the previous entry in this journal.
print_management_links() : voidPrint the links to manage this entry or comment. (Screen, freeze, track, etc)
print_metadata() : voidPrint the metadata associated with this entry or comment
print_metatypes() : voidPrint the metatype icons for this entry (security, age restriction) or comment (subject icon)
print_metatypes(bool icon, bool info) : voidPrint the metatype information for this entry
print_poster() : voidPrint the poster of the entry or comment (user or user in journal, etc)
print_sticky_icon() : voidprints the icon into the subject line
print_subject() : voidPrint the formatted subject for this entry or comment
print_subject(string{} opts) : voidPrint the formatted subject for this entry or comment, gets hash of attributes - class and(or) style
print_tags() : voidPrint the tags for this entry.
print_text() : voidPrint the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
print_time() : voidPrint the time of this post, with most useful information for user, and with tooltip for more.
print_time(string datefmt, string timefmt) : voidPrint the time of the post, with customized date/time formats.
print_userpic() : voidPrint the userpic for this entry or comment
print_wrapper_end() : voidEnd the wrapper for this entry or comment.
print_wrapper_start() : voidStart the wrapper for this entry or comment; includes anchor and classes
time_display() : stringShow the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : stringtime_display, with customized date/time formats.
viewer_sees_ebox() : boolTrue 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) : intCompare 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) : boolReturn true if string contains $sub
css_keyword() : stringIf the string is syntactically valid as a CSS keyword (only letters and spaces) returns it, else returns an empty string.
css_keyword(string[] allowed) : stringSame as string.css_keyword() except also imposes a whitelist of valid keywords given in $allowed.
css_keyword_list() : stringAnalyses 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) : stringSame as string.css_keyword_list() except also imposes a whitelist of valid keywords given in $allowed.
css_length_value() : stringIf the string contains a valid CSS length value, returns a canonical version. Else returns an empty string.
css_string() : stringReturns the string escaped and quoted as a CSS string literal, safe for insertion into a stylesheet.
css_url_value() : stringIf the string contains a valid HTTP or HTTPS URL it is returned. Otherwise, an empty string is returned.
ends_with(string sub) : boolReturns true if string ends in $sub
index(string sub) : intReturns the index of the first instance of $sub in string.
index(string sub, int position) : intReturns the index of the first instance of $sub in string, starting from $position
length() : intReturn the number of characters in the string.
lower() : stringReturns string in lower case.
repeat(int n) : stringReturns the string repeated n times
replace(string find, string replace) : stringReplace all instances of $find with $replace. Case sensitive.
split(string sub) : string[]Return an array of strings split by $sub
starts_with(string sub) : boolReturns true if string begins with $sub
substr(int start, int length) : stringReturns up to $length characters from string, skipping $start characters from the beginning.
upper() : stringReturns string in upper case
upperfirst() : stringReturn string with the first character capitalized.

Tag Class

Represents a tag in its most basic form.

Members

string nameTextual representation of this tag. (Read-only)
string urlURL 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 nameTextual representation of this tag. (Read-only)
int{} security_countsHow many times this tag has used this security. The keys are which security, one of: public, private, friends, group. The value is the count of times the tag is used on entries with that security level. (Read-only)
string urlURL to view entries with this tag. (Read-only)
int use_countCount of how many times this tag has been used. (Read-only)
string visibilityThe visibility level for this tag. Based on the entries it's used on. Can be one of: public, private, friends, group. (Read-only)

TagsPage Class

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

Members

Entry[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
TagDetail[] tagsList of tags visible to the user viewing the page.
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
title() : stringReturn 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() : stringReturn 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_linkLinks to various machine-readable data sources relating to this user
string[] data_links_orderAn array of data views which can be used to order the data_link hash
Image default_picInformation about default userpic
string journal_typeType of account: P (personal), C (community), Y (syndicated), I (external identity) etc (Read-only)
string[] link_keyseqArray of keys which can be passed into the get_link
string nameUser's formatted name, ex: John Q. Public (Read-only)
string usernameCanonical 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_urlURL of a page listing this user's userpics (Read-only)
string website_name'pretty' name of user's website (Read-only)
string website_urlURL pointer to user's website (Read-only)

Methods

as_string() : string 
base_url() : stringReturns URL of user's journal.
equals(UserLite u) : boolReturns 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) : LinkReturns a link based on the given key, or null if the link is unavailable
icon_manage_url() : stringReturns URL to user's icon management page.
linklist_manage_url() : stringReturns URL to user's tag management page.
ljuser() : stringReturns an LJ user tag for the user.
ljuser(Color link_color) : stringReturns an LJ user tag for the user. The color of the link will be link_color.
print() : void 
print_interaction_links() : voidPrint the interaction links for this user/journal.
print_userpic() : voidPrint the userpic for this user
tag_manage_url() : stringReturns URL to user's tag management page.

UserLink Class

A user-defined link to an outside resource.

Members

UserLink[] childrenNot Implemented: An array of child UserLink objects. (Read-only)
bool is_headingIs this link a heading or category name? If so, it has no url and a list of children. (Read-only)
string titleThe title or label for the link (Read-only)
string urlThe 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_linkLinks to various machine-readable data sources relating to this user
string[] data_links_orderAn array of data views which can be used to order the data_link hash
string journal_typeType of account: P (personal), C (community), Y (syndicated), I (external identity) etc (Read-only)
string[] link_keyseqArray of keys which can be passed into the get_link
string nameUser's formatted name, ex: John Q. Public (Read-only)
string usernameCanonical 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_urlURL of a page listing this user's userpics (Read-only)

Methods

as_string() : string 
base_url() : stringReturns URL of user's journal.
equals(UserLite u) : boolReturns 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) : LinkReturns a link based on the given key, or null if the link is unavailable
icon_manage_url() : stringReturns URL to user's icon management page.
linklist_manage_url() : stringReturns URL to user's tag management page.
ljuser() : stringReturns an LJ user tag for the user.
ljuser(Color link_color) : stringReturns an LJ user tag for the user. The color of the link will be link_color.
print() : void 
print_interaction_links() : voidPrint the interaction links for this user/journal.
tag_manage_url() : stringReturns URL to user's tag management page.

YearDay Class

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

Members

Date dateDate of day
int dayDay of month number
int num_entriesNumber of entries made on this day
string urlA URL to view the day, if there are entries, else blank. (Read-only)

YearMonth Class

A month on the YearPage.

Members

bool has_entriesIf this is false, you probably don't want to display this month.
int monthThe number of the month
Date next_dateDate of next month, with day of zero, or null if none.
string next_urlA url to link to in order to view the next month. (Read-only)
Date prev_dateDate of previous month, with day of zero, or null if none.
string prev_urlA url to link to in order to view the previous month. (Read-only)
string urlA url to link to in order to view this month. (Read-only)
YearWeek[] weeksAn array of the weeks of the month (for ease of building a row-per-week calendar)
int yearThe number of the year

Methods

month_format() : stringReturns month formatted long (February 1980) /// SeeAlso: siteapi.core1.dateformats
month_format(string fmt) : stringReturns time formatted as indicated by $fmt, or 'long' if blank. /// SeeAlso: siteapi.core1.dateformats
month_format(string fmt, bool link) : stringReturns 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[] activeentriesArray of recently active entries available to be seen by the viewer of the page. (Read-only)
string{} argsArguments 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_urlThe base URL of the journal being viewed. (Read-only)
Link{} data_linkLinks to various machine-readable data sources relating to this page
string[] data_links_orderAn array of data views which can be used to order the data_link hash
string global_subtitleA sub-title selected by the user for their whole journal. (Read-only)
string global_titleA title selected by the user for their whole journal. (Read-only)
bool has_activeentriesSo we don't try to load the activeentries array when there are no entries to display
string head_contentExtra 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)
User journalUser whose journal is being viewed
string journal_typeJournal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
UserLink[] linklistAn array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
DateTime local_timeA DateTime object filled with the time (in the viewer's timezone) when the page was created. (Read-only)
YearMonth[] months12 months objects, even if no entries are in that month.
string stylesheet_urlThe URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
DateTime timeA DateTime object filled with the time (GMT) when the page was created. (Read-only)
bool timeformat24Indicates whether the time should be displayed in 24-hour format (Read-only)
string viewThe view type (recent, friends, archive, month, day, entry) (Read-only)
string{} view_urlLinks 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_orderAn array of view identifiers which can be used to order the views hash. (Read-only)
int yearThe year being viewed
YearYear[] yearsInformation for linking to other years

Methods

get_latest_month() : YearMonthReturns 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() : voidThe 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() : voidCall 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_control_strip() : voidPrints a control strip for the user's convenience
print_custom_head() : voidLayers 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() : voidPrints the layout's base default stylesheet.
print_default_stylesheets() : voidPrints stylesheets defined by the layout, including any additional CSS defined by the theme.
print_entry(Entry e) : voidOutput 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) : voidClose up the entry
print_global_subtitle() : void 
print_global_title() : void 
print_head() : voidPrint 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() : voidPrint the title for this particular page, as in print_title, formatted with <title> and the journal username
print_linklist() : voidPrint the list of UserLink objects specified by the user.
print_module_section(string section_name) : voidPrints a module section, given a group name
print_month(YearMonth m) : voidPrint the calendar cell for the given month
print_navigation() : voidPrint out the page navigation links.
print_navigation(string{} opts) : voidPrint out the page navigation links. Accepts 'class', an additional CSS class for this container.
print_reply_container(string{} opts) : voidPrints 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) : voidPrints 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() : voidPrints all defined stylesheets, including default and user-defined ones.
print_theme_stylesheet() : voidPrints theme-specific CSS. Should be overwritten by themes that include CSS not part of the layout's default stylesheet.
print_time() : voidPrint the time when the page was created.
print_time(string datefmt, string timefmt) : voidPrint the time when the page was created, with customized date/time formats.
print_title() : voidPrint 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) : voidPrints a trusted string by key.
print_wrapper_end() : voidEnd the body wrapper for this entry or comment.
print_wrapper_start() : voidStart the body wrapper for this page; includes default classes
print_wrapper_start(string{} opts) : voidStart the body wrapper for this page; includes default classes and takes a hash using the key 'class'
print_year_links() : voidPrint the navigation links to move between years
title() : stringReturn 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() : stringReturn 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[] daysAn array of the days of the week (0=sunday)
int post_emptyHow many days at the end of the week are blank? (From next month)
int pre_emptyHow many days at the start of the week are blank? (From previous month)

Methods

print() : voidPrint formatted week

YearYear Class

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

Members

bool displayedIf this is the year currently being displayed, this will be true.
string urlURL to link to for this year. (Read-only)
int yearNumber of the year, eg 2001.