Difference between revisions of "Hierarchy"

From Dreamwidth Notes
Jump to: navigation, search
(Fixed formatting, removed problem functions for further bewilderment)
m (→‎Layout Functions)
Line 108: Line 108:
 
===== Layout Functions =====
 
===== Layout Functions =====
  
−
This is the layout of your entire dw journal.
+
This is the layout of your entire dw journal. 
 +
 
 +
Note: Divs are breaking formatting.  Work out how to fix that.
  
 
     function Page::print()
 
     function Page::print()
 
     {
 
     {
−
     """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n<head profile="http://www.w3.org/2006/03/hcard http://purl.org/uF/hAtom/0.1/ http://gmpg.org/xfn/11">\n""";
+
     """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n
 +
    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n
 +
    <head profile="http://www.w3.org/2006/03/hcard http://purl.org/uF/hAtom/0.1/ http://gmpg.org/xfn/11">\n""";
 
     $this->print_head();
 
     $this->print_head();
 
     $this->print_stylesheets();
 
     $this->print_stylesheets();
Line 119: Line 123:
 
     $this->print_wrapper_start();
 
     $this->print_wrapper_start();
 
     $this->print_control_strip();
 
     $this->print_control_strip();
−
     """
+
     """<div id="canvas">
−
    <div id="canvas">
+
    <div class="inner">
−
        <div class="inner">
+
    <div id="header">
−
            <div id="header">
+
    <div class="inner">""";
−
                <div class="inner">
+
    $this->print_global_title();
−
                    """;
+
    $this->print_global_subtitle();
−
                    $this->print_global_title();
+
    $this->print_title();
−
                    $this->print_global_subtitle();
+
     """</div><!-- end header>inner -->
−
                    $this->print_title();
+
−
     """
+
−
                </div><!-- end header>inner -->
+
 
             </div><!-- end header -->
 
             </div><!-- end header -->
 
             <div id="content">
 
             <div id="content">
Line 136: Line 137:
 
                         """;  
 
                         """;  
 
                         $this->print_body();
 
                         $this->print_body();
−
     """
+
     """</div></div><!-- end primary and primary>inner -->
−
                    </div></div><!-- end primary and primary>inner -->
+
                     <div id="secondary"><div class="inner">""";
−
                     <div id="secondary"><div class="inner">
+
−
                        """;
+
 
                         $this->print_module_section("one");
 
                         $this->print_module_section("one");
−
     """
+
     """</div></div><!--  end secondary and secondary>inner -->
−
                    </div></div><!--  end secondary and secondary>inner -->
+
                     <div id="tertiary"><div class="inner">""";
−
                     <div id="tertiary"><div class="inner">
+
−
                        """;
+
 
                         $this->print_module_section("two");
 
                         $this->print_module_section("two");
−
     """
+
     """</div></div><!-- end tertiary and tertiary>inner -->
−
                    </div></div><!-- end tertiary and tertiary>inner -->
+
 
                 </div><!-- end content>inner -->
 
                 </div><!-- end content>inner -->
 
             </div> <!-- end content -->
 
             </div> <!-- end content -->
−
         </div> <!-- end canvas>inner -->  
+
         </div> <!-- end canvas>inner -->""";
−
    """;
+
 
      
 
      
−
     """
+
     """<div id="footer">
−
    <div id="footer">
+
         <div class="inner">""";
−
         <div class="inner">
+
      print safe """<div class="page-top"><a href="#">$*text_page_top</a></div>
−
            """;
+
−
            print safe """
+
−
                <div class="page-top"><a href="#">$*text_page_top</a></div>
+
 
         </div><!-- end footer>inner -->
 
         </div><!-- end footer>inner -->
 
     </div><!-- end footer -->
 
     </div><!-- end footer -->
−
   
+
     </div> <!-- end canvas -->""";
−
     </div> <!-- end canvas -->
+
−
    """;
+
 
     $this->print_wrapper_end();
 
     $this->print_wrapper_end();
 
     """</html>""";
 
     """</html>""";
Line 176: Line 166:
 
     """</div>\n</div><div class="separator separator-after"><div class="inner"></div></div>\n</div>""";
 
     """</div>\n</div><div class="separator separator-after"><div class="inner"></div></div>\n</div>""";
 
     }
 
     }
−
 
  
 
===== Date Functions =====
 
===== Date Functions =====

Revision as of 05:52, 4 May 2009

There are three components to core2 styles: classes, properties, and functions. This will be a short overview of the hierarchy of the view-related functions and how they associate with each other.

Below are the tables of core2 functions associated with view. Each child is listed below and to the right of the parent.

Table of View-Related Functions

Page
TagsPage
MessagePage
RecentPage
FriendsPage
DayPage
YearPage
MonthPage
EntryPage
ReplyPage
MonthDay
YearWeek
Comment
CommentInfo
Entry

Explanation of View-Related Functions

Paste this in tomorrow.

Page View

Page is the center of core2 design. Changes to anything in a Page function affects all layouts unless they are edited separately. Below is a list of all functions and properties associated with Page.

In each function associated with View, there's a function View::xfunction. This is to tell xfunction what View it is affecting.

Page View Functions

CSS Functions

This adds CSS to all layouts in your theme. 

   function Page::print_default_stylesheet()
   {
   """<style type="text/css">""";
   start_css();
   end_css();
   """</style>\n""";
   }

If you have specific CSS to code onto all themes using this layout, override print_default_stylesheet. If you have specific CSS to code into this theme, set the external_stylesheet property or override the print_stylesheet function. An end user can choose to link to an off-site stylesheet using the linked_stylesheet property and/or use the custom_css property. Overriding this function is NOT RECOMMENDED. Overriding this function could prevent sitewide improvements to styles, accessibility, or other functionality from operating in your layout. 

   function Page::print_stylesheets()
   {
   if ($*include_default_stylesheet) {
       $this->print_default_stylesheet();
       if ($*external_stylesheet) {
           println safe """<link rel="stylesheet" href="$.stylesheet_url" type="text/css" />""";
       }
       else {
           println """<style type="text/css">""";
           start_css();
           print_stylesheet();
           end_css();
           println """</style>""";
       }
   }

   if ($*linked_stylesheet != "") {
       println safe """<link rel="stylesheet" href="$*linked_stylesheet" type="text/css" />""";
   }

   if ($*custom_css != "") {
       println """<style type="text/css">""";
       start_css();
       println safe $*custom_css;
       end_css();
       println """</style>""";
   }
   }


Title Functions

Using standard CSS, print the journal title. If you want to change the way this looks, modify the CSS.

Removed until I fix the problem with global breaking the formatting.

Wrapper Functions
   function Page::print_wrapper_start() 
   {
   $this->print_wrapper_start( { "" => "" } );
   }

   function Page::print_wrapper_start(string{} opts) 
   {

   var string class = $opts{"class"} ? """class="$opts{"class"}" """ : "";
   """<body class="page-$.view $*layout_type $class">\n""";
   }

"This function concludes the wrapper to the page. Overriding this function is NOT RECOMMENDED. Overriding this function could prevent sitewide improvements to styles, accessibility, or other functionality from operating in your layout." 

   function Page::print_wrapper_end() 
   {
   """</body>""";
   }


Layout Functions

This is the layout of your entire dw journal.

Note: Divs are breaking formatting. Work out how to fix that. 

   function Page::print()
   {
   """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n
   <head profile="http://www.w3.org/2006/03/hcard http://purl.org/uF/hAtom/0.1/ http://gmpg.org/xfn/11">\n""";
   $this->print_head();
   $this->print_stylesheets();
   $this->print_head_title();
   """</head>""";
   $this->print_wrapper_start();
   $this->print_control_strip();
"""
                       """; 
                       $this->print_body();
"""
"""; 
                       $this->print_module_section("one");
"""
"""; 
                       $this->print_module_section("two");
"""
"""; """
"""; 
   $this->print_wrapper_end();
   """</html>""";
   }

   function Page::print_body()
   Add this back in when reason it breaks formatting is found.

   function Page::print_module_section ( string section_name ) {
"""
\n
\n
"""; 
   handle_module_group_array( $*module_sections{$section_name} );
"""
\n
\n
"""; 
   }
Date Functions
   function Page::print_time() {
   $this->print_time("","");
   }

   function Page::print_time(string datefmt, string timefmt) {
   if ($datefmt == "") {
       $datefmt = "med";
   }
   if ($timefmt == "") {
       $timefmt = "short";
   }

   var string ret;
   if ($datefmt != "none") { $ret = $ret + $this.local_time->date_format($datefmt); }
   if ($datefmt != "none" and $timefmt != "none") { $ret = $ret + " "; }
   if ($timefmt != "none") { $ret = $ret + $this.local_time->time_format($timefmt); }

   print safe """$*text_generated_on $ret""";
   }
Page Navigation Function
   function Page::print_navigation() {}
Head Functions
   function Page::print_head() {
   print $.head_content;
   $this->print_custom_head();
   }

   function Page::print_custom_head() {
   # blank
   }

   function Page::print_linklist() {
   if (size $.linklist <= 0) {
       return;
   } elseif (not $*linklist_support) {
       return;
   }

   foreach var UserLink l ($.linklist) {
       if ($l.title) {
           if ($l.is_heading) {
               "$l.title";
           } else {
               "<a href='$l.url'>$l.title</a>";
           }
       }
       "
";
   }
   }
Print Entry

This is how all the functions used for a basic layout fit together. This function will affect how you see your Recent Entries, your Reading Page, and your individual entry page. 

   function Page::print_entry(Entry e) 
   {
   $e->print_wrapper_start();
"""
\n"""; 
   $e->print_subject();
   $e->print_metatypes();
   $e->print_time();
"""
\n"""; """
\n"""; """
\n"""; """
\n"""; 
   $e->print_userpic();
   $e->print_poster();
   $e->print_text();
   $e->print_metadata();
"""
\n"""; """
\n"""; """
\n"""; """
\n"""; """
\n"""; 
   $e->print_tags();
   $e->print_management_links();
   if ($this isa EntryPage) {
"""
"""; 
       $e->print_interaction_links("topcomment");
       $this->print_reply_container({ "target" => "topcomment" });
"""
"""; 
   }
   else {
       $e->print_interaction_links();
   }
"
\n
\n"; 
   $e->print_wrapper_end();

}

Page View Properties

Paste Property explantion here and link to Properties page.

Page View Classes

Paste Class explanation here and link to Class page.

Retrieved from "http://wiki.dreamwidth.net/wiki/index.php?title=Hierarchy&oldid=4806"