Difference between revisions of "S2 properties"

From Dreamwidth Notes
Jump to: navigation, search
(→‎Text)
Line 101: Line 101:
  
 
FIXME: figure out which props are wizard-ui-ish and which aren't
 
FIXME: figure out which props are wizard-ui-ish and which aren't
 +
 +
- quick list of wizard/ui-ish properties - needs clean-up -
 +
 +
* '''Name:''' text_meta_location
 +
* '''Description:''' Current Location
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_meta_mood
 +
* '''Description:''' Current Mood
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_meta_music
 +
* '''Description:''' Current Music
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_module_links
 +
* '''Description:''' Links
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_module_pagesummary
 +
* '''Description:''' Page Summary
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_module_syndicate
 +
* '''Description:''' Syndicate
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_module_tags
 +
* '''Description:''' Tags
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_noentries_day
 +
* '''Description:''' There were no entries on this day.
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_noentries_recent
 +
* '''Description:''' There are no entries to display.
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_nosubject
 +
* '''Description:''' (no subject)
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_post_comment
 +
* '''Description:''' Leave a comment
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_post_comment_friends
 +
* '''Description:''' Leave a comment
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_read_comments
 +
* '''Description:''' 1 comment // # comments
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_read_comments_friends
 +
* '''Description:''' 1 comment // # comments
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_reply_back
 +
* '''Description:''' Read Comments
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_skiplinks_back
 +
* '''Description:''' Previous #
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_skiplinks_forward
 +
* '''Description:''' Next #
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_tag_uses
 +
* '''Description:''' 1 use // # uses
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_tags
 +
* '''Description:''' Tags:
 +
* '''Other info:'''
 +
 +
 +
* '''Name:''' text_view_archive
 +
* '''Description:''' Archive
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_view_friends
 +
* '''Description:''' Reading
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_view_friends_comm
 +
* '''Description:''' Reading
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_view_friends_filter
 +
* '''Description:''' Reading (Custom filter)
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_view_friendsfriends
 +
* '''Description:''' Network
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_view_friendsfriends_filter
 +
* '''Description:''' Network (Custom filter)
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_view_memories
 +
* '''Description:''' Memories
 +
* '''Other info:'''
 +
 +
 +
* '''Name:''' text_view_recent
 +
* '''Description:''' Recent Entries
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_view_userinfo
 +
* '''Description:''' Profile
 +
* '''Other info:'''
 +
 +
* '''Name:''' text_website_default_name
 +
* '''Description:''' My Website
 +
* '''Other info:'''
  
 
== Custom CSS ==
 
== Custom CSS ==

Revision as of 00:24, 23 April 2009

Information

This page will have a list of all properties used by Core2. Note that individual layouts may define extra properties beyond those in Core2.

Property types can be bool (true/false), int (numbers), or strings (text)

Wizard properties

Display

(this wizard option does not involve properties; this is where mood themes and navigation strip preferences are set.)

Presentation

  • num_items_recent - "Number of journal entries to show on recent entries page"
    • int: the maximum number of entries (1-50) to show at a time on the recent entries page
  • num_items_reading - "Number of journal entries to show on reading page"
    • int: the maximum number of entries (1-50) to show at a time on the reading page
  • use_custom_friend_colors - "Use my custom friend colors"
    • bool: whether or not to use customized friend colors on the reading page as chosen via the manage circle options. Currently not supported by any system styles regardless of selected choice.
  • use_journalstyle_entry_page - "Show entry pages in my journal style rather than the app style"
    • bool: whether to use styled entry pages (true), or sitescheme entry pages (false).
  • use_shared_pic - "Use community userpics instead of poster's userpic."
    • bool: whether community entries on the reading page display with the community's default icon or the individual poster's specified icon

Colors

All color properties are of the form color_[area]_[class] (for example, color_entry_background or color_subject_text). They are all strings, designed to take color codes. Available classes are:

  • background: defines the background color
  • bar: defines the header bar color
  • border: defines the border color
  • interaction_links: defines colors used for interaction links
  • link: defines the link color; subclasses are link_active, link_hover, link_visited
  • text: defines the color of non-link text
  • title: defines the color of the title text

Available areas:

  • comment - colors used for comments (but not entries)
    • classes: bar
  • entry - colors used for entries and comments
    • classes: background, border, interaction_links, link (and all subclasses), text, title
  • module - colors used for header/footer/sidebar modules
    • classes: background, border, link (and all subclasses), text, title
  • page - colors used for other elements on the page
    • classes: background, link, text, title

Modules

All module properties are of the form module_[type]_[setting] (for example, module_userpic_show or module_tags_opts_type). The available settings are:

  • show - whether to use that module
  • section - which area the module appears in (eg header / sidebar / footer)
  • order - display order for the module within its section
  • opts_[option] - options for that particular module

Available module types:

  • userprofile - Basic Journal Info
    • information about the journal such as username
    • options: userpic (show default userpic); name (show display name); website (show link to defined website)
  • calendar - Calendar
    • Current month's calendar, showing when entries were posted
    • options: type (standard table display vs horizontal strip)
  • customtext - Custom Text
    • User-defined custom text area
  • links - Link List
    • User-defined Links list
  • - Navigation
    • Links to navigate to other areas of the journal (eg Reading page or Tags page)
  • pagesummary - Page Summary
    • A summary of elements on the page (eg entries, for Recent Entries or Reading pages, or comments, for Entry pages)
  • poweredby - Powered By
    • An indication of what site the journal is on
  • syndicate - Syndication
    • Links to the journal's syndicated feed
  • tags - Tags
    • List of the journal's tags
    • options: limit (maximum number of tags to display in the module), type (list vs multi-level list vs cloud)
  • time - Time Loaded
    • Timestamp for when the page was loaded

Text

FIXME: figure out which props are wizard-ui-ish and which aren't

- quick list of wizard/ui-ish properties - needs clean-up -

  • Name: text_meta_location
  • Description: Current Location
  • Other info:
  • Name: text_meta_mood
  • Description: Current Mood
  • Other info:
  • Name: text_meta_music
  • Description: Current Music
  • Other info:
  • Name: text_module_links
  • Description: Links
  • Other info:
  • Name: text_module_pagesummary
  • Description: Page Summary
  • Other info:
  • Name: text_module_syndicate
  • Description: Syndicate
  • Other info:
  • Name: text_module_tags
  • Description: Tags
  • Other info:
  • Name: text_noentries_day
  • Description: There were no entries on this day.
  • Other info:
  • Name: text_noentries_recent
  • Description: There are no entries to display.
  • Other info:
  • Name: text_nosubject
  • Description: (no subject)
  • Other info:
  • Name: text_post_comment
  • Description: Leave a comment
  • Other info:
  • Name: text_post_comment_friends
  • Description: Leave a comment
  • Other info:
  • Name: text_read_comments
  • Description: 1 comment // # comments
  • Other info:
  • Name: text_read_comments_friends
  • Description: 1 comment // # comments
  • Other info:
  • Name: text_reply_back
  • Description: Read Comments
  • Other info:
  • Name: text_skiplinks_back
  • Description: Previous #
  • Other info:
  • Name: text_skiplinks_forward
  • Description: Next #
  • Other info:
  • Name: text_tag_uses
  • Description: 1 use // # uses
  • Other info:
  • Name: text_tags
  • Description: Tags:
  • Other info:


  • Name: text_view_archive
  • Description: Archive
  • Other info:
  • Name: text_view_friends
  • Description: Reading
  • Other info:
  • Name: text_view_friends_comm
  • Description: Reading
  • Other info:
  • Name: text_view_friends_filter
  • Description: Reading (Custom filter)
  • Other info:
  • Name: text_view_friendsfriends
  • Description: Network
  • Other info:
  • Name: text_view_friendsfriends_filter
  • Description: Network (Custom filter)
  • Other info:
  • Name: text_view_memories
  • Description: Memories
  • Other info:


  • Name: text_view_recent
  • Description: Recent Entries
  • Other info:
  • Name: text_view_userinfo
  • Description: Profile
  • Other info:
  • Name: text_website_default_name
  • Description: My Website
  • Other info:

Custom CSS

  • custom_css - Use embedded CSS
    • string: user-provided CSS information
  • include_default_stylesheet - Use layout's stylesheet(s)
    • bool: include the layout's standard CSS information
  • linked_stylesheet - Use an external stylesheet
    • string: URL of an external CSS file to use


Other / unclassified

Dates/Time and Date/Time Formats

  • Name: comment_date_format short
  • Name: comment_datetime_format_group
  • Name: comment_date_format
  • Name: comment_time_format
  • Name: comment_time_format short
  • Name: comment_userpic_style
  • Name: entry_date_format short
  • Name: entry_datetime_format_group
  • Name: entry_date_format
  • Name: entry_time_format
  • Name: entry_time_format short
  • Name: lang_dayname_long
  • Name: lang_dayname_short
  • Name: lang_dayname_shorter
  • Name: lang_fmt_date_long
  • Name: lang_fmt_date_long_day
  • Name: lang_fmt_date_med
  • Name: lang_fmt_date_med_day
  • Name: lang_fmt_date_short
  • Name: lang_fmt_month_long
  • Name: lang_fmt_month_med
  • Name: lang_fmt_month_short
  • Name: lang_fmt_time_short
  • Name: lang_monthname_long
  • Name: lang_monthname_short

Display

  • Name: lang_current
  • Other info: Sets the default language for the page layout.
  • Name: reverse_sortorder_group
  • Other info: This is the top-level item that includes the options for '_sortorder_day' and '_sortorder_year'
  • Name: reverse_sortorder_day
  • Name: reverse_sortorder_year
  • Name: reverse_sortorder_reading
  • Name: reverse_sortorder_recent
  • Name: show_userpics_group
  • Other info: This is the top-level item that includes the options for '_recent', '_reading', '_entry', and '_comments'.
  • Name: show_userpics_recent
  • Name: show_userpics_reading
  • Name: show_userpics_entry
  • Name: show_userpics_comments

Images

  • Name: background_image_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_image_url', '_image_repeat', and '_image_position'.
  • Name: background_image_url
  • Description: Background image URL textbox
  • Other info: This is where the user inputs the URL for the background image to be used on the layout
  • Name: background_image_repeat
  • Description: Background image repeat
  • Other info: This determines if the background image repeats vertically, horizontally or not at all.
  • Name: background_image_position
  • Description: Background image position
  • Other info: This determines the positioning of the background image - top, center, bottom, left, right, etc.


  • Name: header_image_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_image_url', '_image_repeat', and '_image_position'.
  • Name: header_image_url
  • Description: Header image URL textbox
  • Other info: This is where the user inputs the URL for the header image to be used on the layout
  • Name: header_image_repeat
  • Description: Header image repeat
  • Other info: This determines if the header image repeats vertically, horizontally or not at all.
  • Name: header_image_position
  • Description: Header image position
  • Other info: This determines the positioning of the header image - top, center, bottom, left, right, etc.


  • Name: separator_image_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_image_url', '_image_repeat', and '_image_position'.
  • Name: separator_image_url
  • Description: Separator image URL textbox
  • Other info: This is where the user inputs the URL for the separator image to be used on the layout
  • Name: separator_image_repeat
  • Description: Separator image repeat
  • Other info: This determines if the separator image repeats vertically, horizontally or not at all.
  • Name: separator_image_position
  • Description: Separator image position
  • Other info: This determines the positioning of the separator image - top, center, bottom, left, right, etc.



Text

  • Name: text_comment_date
  • Description:
  • Other info:
  • Name: text_comment_edittime
  • Description: Edited at
  • Other info:
  • Name: text_comment_expand
  • Description: Expand
  • Other info:
  • Name: text_comment_from
  • Description: From:
  • Other info:
  • Name: text_comment_frozen n
  • Description: Froze
  • Other info:
  • Name: text_comment_ipaddr
  • Description: IP Address:
  • Other info:
  • Name: text_comment_parent
  • Description: Parent
  • Other info:
  • Name: text_comment_posted
  • Description: Comment successfully posted.
  • Other info:
  • Name: text_comment_reply
  • Description: Reply
  • Other info:
  • Name: text_comment_thread
  • Description: Thread
  • Other info:
  • Name: text_day_next
  • Description: Next Day
  • Other info:
  • Name: text_day_prev
  • Description: Previous Day
  • Other info:
  • Name: text_default_separator
  • Description: |
  • Other info:
  • Name: text_edit_entry
  • Description: Edit Entry
  • Other info:
  • Name: text_edit_tags
  • Description: Edit Tags
  • Other info:
  • Name: text_entry_next
  • Description: Next Entry
  • Other info:
  • Name: text_entry_prev
  • Description: Previous Entry
  • Other info:
  • Name: text_generated_on
  • Description: Page generated
  • Other info:
  • Name: text_icon_alt_18
  • Description: [18+]
  • Other info:
  • Name: text_icon_alt_groups
  • Description: [custom friends groups post]
  • Other info:
  • Name: text_icon_alt_nsfw
  • Description: [NSFW]
  • Other info:
  • Name: text_icon_alt_private
  • Description: [private post]
  • Other info:
  • Name: text_icon_alt_protected
  • Description: [protected post]
  • Other info:
  • Name: text_max_comments
  • Description: Maximum comments reached
  • Other info:
  • Name: text_mem_add
  • Description: Add to Memories
  • Other info:
  • Name: text_meta_groups
  • Description: Custom Friends Groups
  • Other info:
  • Name: text_meta_location
  • Description: Current Location
  • Other info:
  • Name: text_meta_mood
  • Description: Current Mood
  • Other info:
  • Name: text_meta_music
  • Description: Current Music
  • Other info:
  • Name: text_module_links
  • Description: Links
  • Other info:
  • Name: text_module_pagesummary
  • Description: Page Summary
  • Other info:
  • Name: text_module_syndicate
  • Description: Syndicate
  • Other info:
  • Name: text_module_tags
  • Description: Tags
  • Other info:
  • Name: text_month_form_btn
  • Description: View
  • Other info:
  • Name: text_month_screened_comments
  • Description: w/ Screened
  • Other info:
  • Name: text_multiform_btn
  • Description: Perform Action
  • Other info:
  • Name: text_multiform_check
  • Description: Select:
  • Other info:
  • Name: text_multiform_conf_delete
  • Description: Delete selected comments?
  • Other info:
  • Name: text_multiform_des
  • Description: Mass action on selected comments:
  • Other info:
  • Name: text_multiform_opt_delete
  • Description: Delete
  • Other info:
  • Name: text_multiform_opt_deletespam
  • Description: Delete as Spam
  • Other info:
  • Name: text_multiform_opt_edit
  • Description: Edit
  • Other info:
  • Name: text_multiform_opt_freeze
  • Description: Freeze
  • Other info:
  • Name: text_multiform_opt_screen
  • Description: Screen
  • Other info:
  • Name: text_multiform_opt_track
  • Description: Track This
  • Other info:
  • Name: text_multiform_opt_unfreeze
  • Description: Unfreeze
  • Other info:
  • Name: text_multiform_opt_unscreen
  • Description: Unscreen
  • Other info:
  • Name: text_multiform_opt_unscreen_to_reply
  • Description: Unscreen to reply
  • Other info:
  • Name: text_multiform_opt_untrack
  • Description: Untrack This
  • Other info:
  • Name: text_noentries_day
  • Description: There were no entries on this day.
  • Other info:
  • Name: text_noentries_recent
  • Description: There are no entries to display.
  • Other info:
  • Name: text_nosubject
  • Description: (no subject)
  • Other info:
  • Name: text_openid_from
  • Description: from
  • Other info:
  • Name: text_page_top
  • Description: Top of page
  • Other info:
  • Name: text_permalink
  • Description: Link
  • Other info:
  • Name: text_post_comment
  • Description: Leave a comment
  • Other info:
  • Name: text_post_comment_friends
  • Description: Leave a comment
  • Other info:
  • Name: text_poster_anonymous
  • Description: (Anonymous)
  • Other info:
  • Name: text_posting_in
  • Description: posting in
  • Other info:
  • Name: text_powered_by
  • Description: Powered by
  • Other info:
  • Name: text_read_comments
  • Description: 1 comment // # comments
  • Other info:
  • Name: text_read_comments_friends
  • Description: 1 comment // # comments
  • Other info:
  • Name: text_reply_back
  • Description: Read Comments
  • Other info:
  • Name: text_reply_nocomments
  • Description: Comments have been disabled for this post.
  • Other info:
  • Name: text_reply_nocomments_header
  • Description: Comments Disabled:
  • Other info:
  • Name: text_replyform_header
  • Description: Comment Form
  • Other info:
  • Name: text_screened
  • Description: screened
  • Other info:
  • Name: text_skiplinks_back
  • Description: Previous #
  • Other info:
  • Name: text_skiplinks_forward
  • Description: Next #
  • Other info:
  • Name: text_tag_uses
  • Description: 1 use // # uses
  • Other info:
  • Name: text_tags
  • Description: Tags:
  • Other info:
  • Name: text_tags_manage
  • Description: Manage Tags
  • Other info:
  • Name: text_tags_page_header
  • Description: Visible Tags
  • Other info:
  • Name: text_tagsmultilevel_delimiter
  • Description:  :
  • Other info:
  • Name: text_tell_friend
  • Description: Tell a Friend
  • Other info:
  • Name: text_unwatch_comments
  • Description: Untrack This
  • Other info:
  • Name: text_view_archive
  • Description: Archive
  • Other info:
  • Name: text_view_friends
  • Description: Reading
  • Other info:
  • Name: text_view_friends_comm
  • Description: Reading
  • Other info:
  • Name: text_view_friends_filter
  • Description: Reading (Custom filter)
  • Other info:
  • Name: text_view_friendsfriends
  • Description: Network
  • Other info:
  • Name: text_view_friendsfriends_filter
  • Description: Network (Custom filter)
  • Other info:
  • Name: text_view_memories
  • Description: Memories
  • Other info:
  • Name: text_view_month
  • Description: View Subjects
  • Other info:
  • Name: text_view_recent
  • Description: Recent Entries
  • Other info:
  • Name: text_view_userinfo
  • Description: Profile
  • Other info:
  • Name: text_watch_comments
  • Description: Track This
  • Other info:
  • Name: text_website_default_name
  • Description: My Website
  • Other info:


Miscellaneous

  • Name: all_commentsubjects
  • Description:
  • Other info:
  • Name: all_entrysubjects
  • Description:
  • Other info:
  • Name: linklist_support
  • Description:
  • Other info:
  • Name: reg_firstdayofweek
  • Description: Sets the first day of the week for the user, typically either Sunday or Monday.
  • Other info:
  • Name: tags_aware
  • Description:
  • Other info:

Non-wizard Properties

These can be used/changed by layouts, but are not user-facing choices

Modules

  • Name: module_layout_sections
  • Description:
  • Other info: (noui, but layouts can override)
  • Name: module_calendar_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section', as well as '_opts_group', that contains '_opts_type'.
  • Name: module_calendar_opts_group
  • Description:
  • Other info: This is a second tier top-level item that includes the options for '_opts_type'.
  • Name: module_customtext_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section'.
  • Name: module_links_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section'.
  • Name: module_navlinks_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section'.
  • Name: module_pagesummary_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section'.
  • Name: module_poweredby_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section'.
  • Name: module_syndicate_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section'.
  • Name: module_tags_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section', as well as '_opts_group', that contains '_opts_limit' and '_opts_type'.
  • Name: module_tags_opts_group
  • Description:
  • Other info: This is a second tier top-level item that includes the options for '_opts_limit' and '_opts_type'.
  • Name: module_time_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section'.
  • Name: module_userprofile_group
  • Description:
  • Other info: This is the top-level item that includes the options for '_show', '_order' and '_section', as well as '_opts_group', that contains '_opts_userpic', '_opts_name', and '_opts_website'.
  • Name: module_userprofile_opts_group
  • Description:
  • Other info: This is a second tier top-level item that includes the options for '_opts_userpic', '_opts_name' and '_opts_website'.
Retrieved from "http://wiki.dreamwidth.net/wiki/index.php?title=S2_properties&oldid=4275"