Difference between revisions of "S2 properties"

From Dreamwidth Notes
Jump to: navigation, search
m (Modules)
(Modules)
Line 122: Line 122:
  
 
== Modules ==
 
== Modules ==
 +
 +
* '''Name:''' module_layout_sections 
 +
* '''Description:'''
 +
* '''Other info:'''
 +
 +
  
 
* '''Name:''' module_calendar_group  
 
* '''Name:''' module_calendar_group  
 
* '''Description:'''  
 
* '''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'.
+
* '''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
 
* '''Name:''' module_calendar_show
Line 141: Line 149:
 
* '''Name:''' module_calendar_opts_group
 
* '''Name:''' module_calendar_opts_group
 
* '''Description:'''  
 
* '''Description:'''  
* '''Other info:''' This is a second tier top-level item that includes the options for '_opts_type'.
+
* '''Other info:''' This is a second tier top-level item that includes the options for  
 +
 
 +
'_opts_type'.
  
 
* '''Name:''' module_calendar_opts_type   
 
* '''Name:''' module_calendar_opts_type   
 
* '''Description:''' Type of calendar display: Table or Horizontal
 
* '''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.
+
* '''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  
 
* '''Name:''' module_customtext_section  
 
* '''Description:'''  
 
* '''Description:'''  
* '''Other info:'''  
+
* '''Other info:''' This determines where the custom text is located on the page layout.
  
* '''Name:''' module_layout_sections 
+
 
 +
 
 +
* '''Name:''' module_links_group
 
* '''Description:'''  
 
* '''Description:'''  
* '''Other info:'''  
+
* '''Other info:''' This is the top-level item that includes the options for '_show',
  
* '''Name:''' module_links_section
+
'_order' and '_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_section
+
* '''Name:''' module_links_show
* '''Description:''' Navigation with drop-down box for (none), Sidebar, Header, Footer
+
* '''Description:''' The tickbox next to 'Links List'
* '''Other info:''' This determines where the navigation links are located on the page layout.
+
* '''Other info:''' Determines whether or not to display the Links List.
  
* '''Name:''' module_pagesummary_section  
+
* '''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  
 
* '''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.
 
* '''Other info:''' This determines where the page summary is located on the page 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_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_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
 
* '''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.
+
* '''Other info:''' This determines where the syndication link icons are located on the page 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_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
 
* '''Name:''' module_time_section
* '''Description:''' Time Loaded with drop-down box for (none), Sidebar, Header, Footer
+
* '''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.
+
* '''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  
 
* '''Name:''' module_userprofile_section  
* '''Description:''' Basic Journal Info with drop-down box for (none), Sidebar, Header, Footer
+
* '''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.
+
* '''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.
  
[[Category: Styles]]
+
* '''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.

Revision as of 22:17, 21 April 2009

S2 properties

Information and Template

This page will have a list of all properties used by Core2.

Template to use:

= 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.
Note: Propgroups only need to be listed once; all of the properties in that group can be added under the one header.





Style

Colors

  • 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_hover
  • Description:
  • 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:
  • 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:
  • Other info:
  • 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_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.

Text

  • Name: comment_management_links
  • Description:
  • Other info:
  • Name: entry_management_links
  • Description:
  • Other info:
  • Name: font_base
  • Description:
  • Other info:
  • Name: font_fallback
  • Description:
  • Other info:


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.