Difference between revisions of "S2 properties"

From Dreamwidth Notes
Jump to: navigation, search
m (Style Sheets)
Line 1: Line 1:
'''S2 properties'''
+
= Information =
  
= 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:
+
 
+
<pre><nowiki>= propgroup name =
+
 
+
== property name=
+
 
+
* '''Name:''' the in-code name for the property
+
* '''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.}}
+
  
 +
= Wizard properties =
  
 +
== Display ==
  
 +
(this wizard option does not involve properties; this is where mood themes and navigation strip preferences are set.)
  
 +
== Presentation ==
  
 +
* <strong>num_items_recent</strong> - "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
  
 +
* <strong>num_items_reading</strong> - "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
  
 +
* <strong>use_custom_friend_colors</strong> - "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.
  
 +
* <strong>use_journalstyle_entry_page</strong> - "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).
  
= Style =
+
* <strong>use_shared_pic</strong> - "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 ==
 
== Colors ==
  
* '''Name:''' color_archivemonth_background 
+
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:
* '''Description:'''
+
* '''Other info:'''
+
   
+
* '''Name:''' color_archivemonth_border   
+
* '''Description:'''
+
* '''Other info:'''
+
  
* '''Name:''' color_archivemonth_title   
+
* <strong>background:</strong> defines the background color
* '''Description:'''
+
* <strong>bar:</strong> defines the header bar color
* '''Other info:'''
+
* <strong>border:</strong> defines the border color
 +
* <strong>interaction_links:</strong> defines colors used for interaction links
 +
* <strong>link:</strong> defines the link color; subclasses are link_active, link_hover, link_visited
 +
* <strong>text:</strong> defines the color of non-link text
 +
* <strong>title:</strong> defines the color of the title text
  
* '''Name:''' color_archivemonth_title_background
+
Available areas:
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' color_archivemonth_title_border 
+
* '''Description:'''
+
* '''Other info:'''
+
  
 +
* <strong>comment</strong> - colors used for comments (but not entries)
 +
** classes: bar
  
* '''Name:''' color_comment_bar 
+
* <strong>entry</strong> - colors used for entries and comments
* '''Description:''' Comment bar color
+
** classes: background, border, interaction_links, link (and all subclasses), text, title
* '''Other info:''' The default color for the comment bar on custom comment pages.
+
  
* '''Name:''' color_comments_form_border
+
* <strong>module</strong> - colors used for header/footer/sidebar modules
* '''Description:'''
+
** classes: background, border, link (and all subclasses), text, title
* '''Other info:'''
+
  
 +
* <strong>page</strong> - colors used for other elements on the page
 +
** classes: background, link, text, title
  
* '''Name:''' color_entry_background
+
== Modules ==
* '''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_background_alt
+
All module properties are of the form module_[type]_[setting] (for example, module_userpic_show or module_tags_opts_type).  The available settings are:
* '''Description:'''
+
* '''Other info:'''
+
  
* '''Name:''' color_entry_border
+
* <strong>show</strong> - whether to use that module
* '''Description:''' Entry border color
+
* <strong>section</strong> - which area the module appears in (eg header / sidebar / footer)
* '''Other info:''' The default color of the border around all of the entry boxes on the page.
+
* <strong>order</strong> - display order for the module within its section
 +
* <strong>opts_[option]</strong> - options for that particular module
  
* '''Name:''' color_entry_border_alt
+
Available module types:
* '''Description:'''
+
* '''Other info:'''
+
  
* '''Name:''' color_entry_interaction_links
+
* <strong>userprofile</strong> - Basic Journal Info
* '''Description:''' Color of interaction links and text
+
** information about the journal such as username
* '''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'.
+
** options: userpic (show default userpic); name (show display name); website (show link to defined website)
  
* '''Name:''' color_entry_link   
+
* <strong>calendar</strong> - Calendar
* '''Description:''' Entry link color
+
** Current month's calendar, showing when entries were posted
* '''Other info:''' The default color of links within the entry text.
+
** options: type (standard table display vs horizontal strip)
  
* '''Name:''' color_entry_link_alt
+
* <strong>customtext</strong> - Custom Text
* '''Description:'''
+
** User-defined custom text area
* '''Other info:'''
+
  
* '''Name:''' color_entry_link_active 
+
* <strong>links</strong> - Link List
* '''Description:''' Entry link active
+
** User-defined Links list
* '''Other info:''' The default color of links within the entry text before the link is hovered over or visited.
+
  
* '''Name:''' color_entry_link_hover
+
* <strong></strong> - Navigation
* '''Description:''' Entry link hover
+
** Links to navigate to other areas of the journal (eg Reading page or Tags page)
* '''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_subject_alt 
+
* <strong>pagesummary</strong> - Page Summary
* '''Description:'''
+
** A summary of elements on the page (eg entries, for Recent Entries or Reading pages, or comments, for Entry pages)
* '''Other info:'''
+
  
* '''Name:''' color_entry_subject_alt_background 
+
* <strong>poweredby</strong> - Powered By
* '''Description:'''
+
** An indication of what site the journal is on
* '''Other info:'''
+
+
* '''Name:''' color_entry_subject_alt_border 
+
* '''Description:'''
+
* '''Other info:'''
+
+
* '''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_text_alt
+
* <strong>syndicate</strong> - Syndication
* '''Description:'''
+
** Links to the journal's syndicated feed
* '''Other info:'''
+
  
* '''Name:''' color_entry_title
+
* <strong>tags</strong> - Tags
* '''Description:''' Entry title color
+
** List of the journal's tags
* '''Other info:''' The default color used for each entry's title or subject line.
+
** options: limit (maximum number of tags to display in the module), type (list vs multi-level list vs cloud)
  
* '''Name:''' color_entry_title_background
+
* <strong>time</strong> - Time Loaded
* '''Description:'''
+
** Timestamp for when the page was loaded
* '''Other info:'''
+
  
* '''Name:''' color_entry_title_border
+
== Text ==
* '''Description:'''
+
* '''Other info:'''
+
  
 +
FIXME: figure out which props are wizard-ui-ish and which aren't
  
* '''Name:''' color_footer_background 
+
== Custom CSS ==
* '''Description:'''
+
* '''Other info:'''
+
  
* '''Name:''' color_footer_link 
+
* <strong>custom_css</strong> - Use embedded CSS
* '''Description:'''
+
** string: user-provided CSS information
* '''Other info:'''
+
  
* '''Name:''' color_footer_text   
+
* <strong>include_default_stylesheet</strong> - Use layout's stylesheet(s)
* '''Description:'''
+
** bool: include the layout's standard CSS information
* '''Other info:'''
+
  
 +
* <strong>linked_stylesheet</strong> - Use an external stylesheet
 +
** string: URL of an external CSS file to use
  
* '''Name:''' color_header_background   
 
* '''Description:'''
 
* '''Other info:'''
 
  
* '''Name:''' color_header_hover   
+
= Other / unclassified =
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' color_header_hover_background 
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
* '''Name:''' color_header_text 
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
* '''Name:''' color_main_background
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
* '''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_module_title_background 
+
* '''Description:'''
+
* '''Other info:''' 
+
 
+
* '''Name:''' color_module_title_border
+
* '''Description:'''
+
* '''Other info:'''
+
 
+
 
+
* '''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 ==
 
== Dates/Time and Date/Time Formats ==
  
 
* '''Name:''' comment_date_format short  
 
* '''Name:''' comment_date_format short  
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' comment_datetime_format_group
 
* '''Name:''' comment_datetime_format_group
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' comment_date_format
 
* '''Name:''' comment_date_format
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' comment_time_format
 
* '''Name:''' comment_time_format
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' comment_time_format short  
 
* '''Name:''' comment_time_format short  
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' comment_userpic_style
 
* '''Name:''' comment_userpic_style
* '''Description:'''
 
* '''Other info:'''
 
 
 
 
* '''Name:''' entry_date_format short  
 
* '''Name:''' entry_date_format short  
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' entry_datetime_format_group
 
* '''Name:''' entry_datetime_format_group
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' entry_date_format
 
* '''Name:''' entry_date_format
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' entry_time_format
 
* '''Name:''' entry_time_format
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' entry_time_format short  
 
* '''Name:''' entry_time_format short  
* '''Description:'''
 
* '''Other info:'''
 
 
 
 
* '''Name:''' lang_dayname_long
 
* '''Name:''' lang_dayname_long
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_dayname_short
 
* '''Name:''' lang_dayname_short
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_dayname_shorter
 
* '''Name:''' lang_dayname_shorter
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_date_long
 
* '''Name:''' lang_fmt_date_long
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_date_long_day
 
* '''Name:''' lang_fmt_date_long_day
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_date_med
 
* '''Name:''' lang_fmt_date_med
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_date_med_day
 
* '''Name:''' lang_fmt_date_med_day
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_date_short
 
* '''Name:''' lang_fmt_date_short
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_month_long
 
* '''Name:''' lang_fmt_month_long
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_month_med
 
* '''Name:''' lang_fmt_month_med
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_month_short
 
* '''Name:''' lang_fmt_month_short
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_fmt_time_short
 
* '''Name:''' lang_fmt_time_short
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_monthname_long  
 
* '''Name:''' lang_monthname_long  
* '''Description:'''
 
* '''Other info:'''
 
 
 
* '''Name:''' lang_monthname_short
 
* '''Name:''' lang_monthname_short
* '''Description:'''
 
* '''Other info:'''
 
 
  
 
== Display ==
 
== Display ==
  
 
* '''Name:''' lang_current  
 
* '''Name:''' lang_current  
* '''Description:'''
 
 
* '''Other info:''' Sets the default language for the page layout.
 
* '''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  
 
* '''Name:''' reverse_sortorder_group  
* '''Description:'''
 
 
* '''Other info:''' This is the top-level item that includes the options for '_sortorder_day' and '_sortorder_year'
 
* '''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_day
* '''Description:'''
 
* '''Other info:'''
 
  
 
* '''Name:''' reverse_sortorder_year
 
* '''Name:''' reverse_sortorder_year
* '''Description:'''
 
* '''Other info:'''
 
  
 
* '''Name:''' reverse_sortorder_reading  
 
* '''Name:''' reverse_sortorder_reading  
* '''Description:'''
 
* '''Other info:'''
 
  
 
* '''Name:''' reverse_sortorder_recent  
 
* '''Name:''' reverse_sortorder_recent  
* '''Description:'''
 
* '''Other info:'''
 
  
 
 
 
* '''Name:''' show_userpics_group
 
* '''Name:''' show_userpics_group
* '''Description:'''
 
 
* '''Other info:''' This is the top-level item that includes the options for '_recent', '_reading', '_entry', and '_comments'.
 
* '''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_recent
* '''Description:'''
 
* '''Other info:'''
 
  
 
* '''Name:''' show_userpics_reading
 
* '''Name:''' show_userpics_reading
* '''Description:'''
 
* '''Other info:'''
 
  
 
* '''Name:''' show_userpics_entry
 
* '''Name:''' show_userpics_entry
* '''Description:'''
 
* '''Other info:'''
 
  
 
* '''Name:''' show_userpics_comments
 
* '''Name:''' show_userpics_comments
* '''Description:'''
 
* '''Other info:'''
 
 
  
 
== Images ==
 
== Images ==
Line 452: Line 227:
  
  
== 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:''' Use embedded CSS
 
* '''Other info:''' Textarea for adding customized CSS rather than linking to an external style sheet.
 
 
* '''Name:''' external_stylesheet
 
* '''Description:''' Custom external stylesheet URL
 
* '''Other info:''' Textbox for including a URL for an external style sheet of customized CSS.
 
 
* '''Name:''' include_default_stylesheet
 
* '''Description:''' Use layout's stylesheet(s)
 
* '''Other info:''' Determines if the layout's default stylesheet(s) is used when adding customized CSS.
 
 
* '''Name:''' linked_stylesheet
 
* '''Description:'''
 
* '''Other info:'''
 
  
 
== Text ==
 
== Text ==
Line 1,043: Line 581:
 
* '''Description:''' My Website
 
* '''Description:''' My Website
 
* '''Other info:'''
 
* '''Other info:'''
 
 
  
  
Line 1,062: Line 598:
  
 
* '''Name:''' reg_firstdayofweek  
 
* '''Name:''' reg_firstdayofweek  
* '''Description:'''
+
* '''Description:''' Sets the first day of the week for the user, typically either Sunday or Monday.
* '''Other info:''' Sets the first day of the week for the user, typically either Sunday or Monday.
+
* '''Other info:'''
  
 
* '''Name:''' tags_aware
 
* '''Name:''' tags_aware
Line 1,069: Line 605:
 
* '''Other info:'''
 
* '''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'.
  
 
[[Category: Styles]]
 
[[Category: Styles]]

Revision as of 00:06, 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

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'.