Difference between revisions of "S2 properties"

From Dreamwidth Notes
Jump to: navigation, search
m (s2 category)
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''S2 properties'''
+
= Overview =
  
= Information and Template =
+
This page will have a list of all properties used by Core2.  Note that individual layouts may define extra properties beyond those in Core2.
  
This page will have a list of all properties used by Core2.
+
Property types can be bool (true/false), int (numbers), or strings (text)
  
Template to use:
+
= Wizard properties =
  
<pre><nowiki>= propgroup name =
+
* [[S2 properties: Presentation]]
 +
* [[S2 properties: Colors]]
 +
* [[S2 properties: Images]]
 +
* [[S2 properties: Modules]]
 +
* [[S2 properties: Text]]
 +
* [[S2 properties: Custom CSS]]
  
== property name=
+
= Other / unclassified =
  
* '''Name:''' the in-code name for the property
+
* [[S2 properties: Unclassified]]
* '''Description:''' the in-code description (how it's labeled on the wizard)
+
* '''Other info:''' if needed, further descriptioning.
+
</nowiki></pre>
+
  
{{Note|text=Propgroups only need to be listed once; all of the properties in that group can be added under the one header.}}
+
= Non-wizard Properties =
  
 +
These can be used/changed by layouts, but are not user-facing choices
  
 +
* [[S2 properties: Date Time]]
 +
* [[S2 properties: Modules NW]]
 +
* [[S2 properties: Text NW]]
  
 
+
[[Category: S2]]
 
+
 
+
 
+
 
+
 
+
= Style =
+
 
+
== Colors ==
+
 
+
* '''Name:''' color_comment_bar 
+
* '''Description:''' Comment bar color
+
* '''Other info:''' The default color for the comment bar on custom comment pages.
+
 
+
* '''Name:''' color_entry_background
+
* '''Description:''' Entry background color
+
* '''Other info:''' The default background color for all entry boxes on the page.  This should be a contrasting color to the entry text and the entry link colors.
+
 
+
* '''Name:''' color_entry_border
+
* '''Description:''' Entry border color
+
* '''Other info:''' The default color of the border around all of the entry boxes on the page.
+
 
+
* '''Name:''' color_entry_interaction_links
+
* '''Description:''' Color of interaction links and text
+
* '''Other info:''' The default color of the user-interaction links at the bottom of each entry for navigations such as 'reply to entry' or 'read comments'.
+
 
+
* '''Name:''' color_entry_link   
+
* '''Description:''' Entry link color
+
* '''Other info:''' The default color of links within the entry text.
+
 
+
* '''Name:''' color_entry_link_active 
+
* '''Description:''' Entry link active
+
* '''Other info:''' The default color of links within the entry text before the link is hovered over or visited.
+
 
+
* '''Name:''' color_entry_link_hover
+
* '''Description:''' Entry link hover
+
* '''Other info:''' The default color of links within the entry text when the user hovers the mouse over the link.
+
+
* '''Name:''' color_entry_link_visited 
+
* '''Description:''' Entry link visited
+
* '''Other info:''' The default color of links within the entry text when the user has clicked on the link and visited the referred to page.
+
+
* '''Name:''' color_entry_text 
+
* '''Description:''' Entry foreground color
+
* '''Other info:''' The default color of all of the text within the entry boxes that is not a link.
+
 
+
* '''Name:''' color_entry_title
+
* '''Description:''' Entry title color
+
* '''Other info:''' The default color used for each entry's title or subject line.
+
 
+
* '''Name:''' color_module_background 
+
* '''Description:''' Module background color
+
* '''Other info:''' The background color for all module boxes in the page sidebar.  This should be a contrasting color to the module text and the module link colors.
+
 
+
* '''Name:''' color_module_border 
+
* '''Description:''' Module border color
+
* '''Other info:''' The color of the border around all of the module boxes on the page sidebar.
+
 
+
* '''Name:''' color_module_link 
+
* '''Description:''' Module link color
+
* '''Other info:''' The color of links within the module boxes on the page sidebar.
+
 
+
* '''Name:''' color_module_link_active   
+
* '''Description:''' Module link active
+
* '''Other info:''' The default color of links within the module boxes before the link is hovered over or visited.
+
 
+
* '''Name:''' color_module_link_hover   
+
* '''Description:''' Module link hover
+
* '''Other info:''' The color of links within the module boxes when the user hovers the mouse over the link.
+
 
+
* '''Name:''' color_module_link_visited
+
* '''Description:''' Module link visited
+
* '''Other info:''' The default color of links within the module boxes when the user has clicked on the link and visited the referred to page.
+
 
+
* '''Name:''' color_module_text   
+
* '''Description:''' Module foreground color
+
* '''Other info:''' The color of the text within the module boxes that is not a link.
+
 
+
* '''Name:''' color_module_title 
+
* '''Description:''' Module title color
+
* '''Other info:''' The color of the titles of the module boxes in the page sidebar.
+
 
+
* '''Name:''' color_page_background   
+
* '''Description:''' Page background color
+
* '''Other info:''' The color that will display behind all of the other elements on the page
+
 
+
* '''Name:''' color_page_link   
+
* '''Description:''' Page link color
+
* '''Other info:''' The color for all links listed on the page, usually in the navigation areas.
+
 
+
* '''Name:''' color_page_text 
+
* '''Description:''' Page foreground/text color
+
* '''Other info:''' The color for all text listed on the page that is not a link.
+
 
+
 
+
== Dates/Time and Date/Time Formats ==
+
 
+
* '''Name:''' comment_date_format short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' comment_datetime_format_group
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' comment_date_format
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' comment_time_format
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' comment_time_format short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' comment_userpic_style
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
* '''Name:''' entry_date_format short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' entry_datetime_format_group
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' entry_date_format
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' entry_time_format
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' entry_time_format short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
* '''Name:''' lang_dayname_long
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_dayname_short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_dayname_shorter
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_date_long
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_date_long_day
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_date_med
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_date_med_day
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_date_short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_month_long
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_month_med
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_month_short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_fmt_time_short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_monthname_long
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' lang_monthname_short
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
== Display ==
+
 
+
* '''Name:''' lang_current
+
* '''Description:'''
+
* '''Other info:''' Sets the default language for the page layout.
+
 
+
* '''Name:''' num_items_recent 
+
* '''Description:''' Number of journal entries to show on recent entries page
+
* '''Other info:''' Indicates the number of entries that will display on the 'recent entries' page of user's journal
+
 
+
* '''Name:''' num_items_reading
+
* '''Description:''' Number of journal entries to show on reading page
+
* '''Other info:''' Indicates the number of entries that will display on the 'reading' page of user's journal
+
 
+
* '''Name:''' use_custom_friend_colors
+
*'''Description:'''
+
*'''Other info:''' Displays customized friend colors on the reading page as chosen via the manage circle options.
+
 
+
* '''Name:''' use_journalstyle_entry_page
+
* '''Description:''' TIckbox with: Show entry pages in my journal style rather than the app style
+
* '''Other info:''' Will display any accounts entry pages in the user's own journal style
+
 
+
* '''Name:''' use_shared_pic
+
* '''Description:''' Use community userpics instead of poster's userpic.
+
* '''Other info:''' Will use, if supplied, the userpic of a given community rather than the individual account's userpics
+
 
+
 
+
* '''Name:''' reverse_sortorder_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_sortorder_day' and '_sortorder_year'
+
 
+
* '''Name:''' reverse_sortorder_day
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' reverse_sortorder_year
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' reverse_sortorder_reading
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' reverse_sortorder_recent
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
+
* '''Name:''' show_userpics_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_recent', '_reading', '_entry', and '_comments'.
+
 
+
* '''Name:''' show_userpics_recent
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' show_userpics_reading
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' show_userpics_entry
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' show_userpics_comments
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
== 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.
+
 
+
 
+
 
+
== Modules ==
+
 
+
* '''Name:''' module_layout_sections 
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
 
+
* '''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_show
+
* '''Description:''' The tickbox next to 'Calendar'
+
* '''Other info:'''  Determines whether or not to display the calendar.
+
 
+
* '''Name:''' module_calendar_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the calendar will display in the layout.
+
 
+
* '''Name:''' module_calendar_section 
+
* '''Description:''' Calendar with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the calendar is located on the page layout.
+
 
+
* '''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_calendar_opts_type 
+
* '''Description:''' Type of calendar display: Table or Horizontal
+
* '''Other info:''' This determines if the calendar is in a table-block style or a horizontal list of date numbers.
+
 
+
 
+
 
+
* '''Name:''' module_customtext_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_show', '_order' and '_section'.
+
 
+
* '''Name:''' module_customtext_show
+
* '''Description:''' The tickbox next to 'Custom Text'
+
* '''Other info:''' Determines whether or not to display the Custom Text.
+
 
+
* '''Name:''' module_customtext_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the custom text will display in the layout.
+
 
+
* '''Name:''' module_customtext_section
+
* '''Description:'''
+
* '''Other info:''' This determines where the custom text is located on the page layout.
+
 
+
 
+
 
+
* '''Name:''' module_links_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_show', '_order' and '_section'.
+
 
+
* '''Name:''' module_links_show
+
* '''Description:''' The tickbox next to 'Links List'
+
* '''Other info:''' Determines whether or not to display the Links List.
+
 
+
* '''Name:''' module_links_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the link list will display in the layout.
+
 
+
* '''Name:''' module_links_section
+
* '''Description:''' Link List with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the Link List is located on the page layout.
+
 
+
 
+
* '''Name:''' module_navlinks_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_show', '_order' and '_section'.
+
 
+
* '''Name:''' module_navlinks_show
+
* '''Description:''' The tickbox next to 'Navigation'
+
* '''Other info:''' Determines whether or not to display the Navigation Links.
+
 
+
* '''Name:''' module_navlinks_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the navigation links will display in the layout.
+
 
+
* '''Name:''' module_navlinks_section
+
* '''Description:''' Navigation with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the navigation links are located on the page layout.
+
 
+
 
+
 
+
* '''Name:''' module_pagesummary_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_show', '_order' and '_section'.
+
 
+
* '''Name:''' module_pagesummary_show
+
* '''Description:''' The tickbox next to 'Page Summary'
+
* '''Other info:''' Determines whether or not to display the Page Summary.
+
 
+
* '''Name:''' module_pagesummary_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the page summary will display in the layout.
+
 
+
* '''Name:''' module_pagesummary_section
+
* '''Description:''' Page Summary with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the page summary is located on the page layout.
+
 
+
 
+
 
+
* '''Name:''' module_poweredby_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_show', '_order' and '_section'.
+
 
+
* '''Name:''' module_poweredby_show
+
* '''Description:''' The tickbox next to 'Powered By'
+
* '''Other info:''' Determines whether or not to display the Powered By indicator.
+
 
+
* '''Name:''' module_poweredby_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the powered by indicator will display in the layout.
+
 
+
* '''Name:''' module_poweredby_section
+
* '''Description:''' Powered By with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the 'powered by' identifier is located on the page layout.
+
 
+
 
+
 
+
* '''Name:''' module_syndicate_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_show', '_order' and '_section'.
+
 
+
* '''Name:''' module_syndicate_show
+
* '''Description:''' The tickbox next to 'Syndication'
+
* '''Other info:''' Determines whether or not to display the Syndication icons.
+
 
+
* '''Name:''' module_syndicate_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the syndication icons will display in the layout.
+
 
+
* '''Name:''' module_syndicate_section
+
* '''Description:''' Syndication with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the syndication link icons are located on the page layout.
+
 
+
 
+
 
+
* '''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_show
+
* '''Description:''' The tickbox next to 'Tags'
+
* '''Other info:''' Determines whether or not to display the Tags list.
+
 
+
* '''Name:''' module_tags_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the tags list will display in the layout.
+
 
+
* '''Name:''' module_tags_section
+
* '''Description:''' Tags with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the tags list is located on the page layout.
+
 
+
* '''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_tags_opts_limit
+
* '''Description:''' Text entry box for inputting a number.
+
* '''Other info:''' This determines how many tags will be displayed on the page.
+
 
+
* '''Name:''' module_tags_opts_type
+
* '''Description:''' Type of Tags Display with drop-down box for List, Cloud, Multi-level.
+
* '''Other info:''' This determines how the tags will display on the page, either in a list, a multi-level list or a cloud.
+
 
+
 
+
* '''Name:''' module_time_group
+
* '''Description:'''
+
* '''Other info:''' This is the top-level item that includes the options for '_show', '_order' and '_section'.
+
 
+
* '''Name:''' module_time_show
+
* '''Description:''' The tickbox next to 'Time Loaded'
+
* '''Other info:''' Determines whether or not to display the Time Loaded information.
+
 
+
* '''Name:''' module_time_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the time loaded indicator will display in the layout.
+
 
+
* '''Name:''' module_time_section
+
* '''Description:''' Time Loaded with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the 'time loaded' indicator is located on the page layout.
+
 
+
+
* '''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_show
+
* '''Description:''' The tickbox next to 'Basic Journal Info'
+
* '''Other info:''' Determines whether or not to display the User Profile.
+
 
+
* '''Name:''' module_userprofile_order
+
* '''Description:''' Text entry box for a number.
+
* '''Other info:''' Determines in what order the user profile information will display in the layout.
+
 
+
* '''Name:''' module_userprofile_section
+
* '''Description:''' Basic Journal Info with drop-down box for (none), Sidebar, Header, Footer
+
* '''Other info:''' This determines where the user profile information is located on the page layout.
+
 
+
* '''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'.
+
 
+
* '''Name:''' module_userprofile_opts_userpic
+
* '''Description:''' Tickbox with 'Default Userpic' text.
+
* '''Other info:''' This determines whether or not to display the Default Userpic in the user profile section..
+
 
+
* '''Name:''' module_userprofile_opts_name
+
* '''Description:''' Tickbox with 'Dispaly Name' text.
+
* '''Other info:''' This determines whether or not to display the Display Name in the user profile section.
+
 
+
* '''Name:''' module_userprofile_opts_website
+
* '''Description:''' Tickbox with 'Website' text.
+
* '''Other info:''' This determines whether or not to display the user's Website in the user profile section.
+
 
+
 
+
== Style Sheets ==
+
 
+
* '''Name:''' custom_css
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' external_stylesheet
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' include_default_stylesheet
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' linked_stylesheet
+
* '''Description:'''
+
* '''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:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' tags_aware
+
* '''Description:'''
+
* '''Other info:'''
+

Latest revision as of 03:01, 4 May 2009

Overview

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

Other / unclassified

Non-wizard Properties

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