| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,973 @@ |
| 1 |
+<html> |
|
| 2 |
+ |
|
| 3 |
+<head> |
|
| 4 |
+<meta http-equiv="Content-Language" content="en-us"> |
|
| 5 |
+<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> |
|
| 6 |
+<meta name="ProgId" content="FrontPage.Editor.Document"> |
|
| 7 |
+<meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> |
|
| 8 |
+<title>Creating Skins</title> |
|
| 9 |
+<style type="text/css"> |
|
| 10 |
+<!-- |
|
| 11 |
+.sample {
|
|
| 12 |
+ background-color: #CCCCCC; |
|
| 13 |
+ margin: 1em; |
|
| 14 |
+ border: 1px solid #000000; |
|
| 15 |
+ padding: 1ex; |
|
| 16 |
+} |
|
| 17 |
+.sampleLabel {
|
|
| 18 |
+ margin-bottom: -1em; |
|
| 19 |
+ margin-left: 1em; |
|
| 20 |
+ font-weight: bold; |
|
| 21 |
+} |
|
| 22 |
+--> |
|
| 23 |
+</style> |
|
| 24 |
+</head> |
|
| 25 |
+ |
|
| 26 |
+<body> |
|
| 27 |
+ |
|
| 28 |
+<h2 align="center">Creating Skins - WIP</h2> |
|
| 29 |
+<p>In theory, there is no limit to the number of skins you can create for your |
|
| 30 |
+site. If you have created skins for eFiction 1.1, you won't find many differences. The number and names of the .tpl files have changed |
|
| 31 |
+some though. |
|
| 32 |
+A complete skin will include the following files.</p> |
|
| 33 |
+<div align="center"> |
|
| 34 |
+ <center> |
|
| 35 |
+ <table border="1" cellpadding="5" cellspacing="0" |
|
| 36 |
+ style="border-collapse: collapse" bordercolor="#111111"> |
|
| 37 |
+ <tr> |
|
| 38 |
+ <th width="50%">.tpl file</th> |
|
| 39 |
+ <th width="50%">Related pages</th> |
|
| 40 |
+ </tr> |
|
| 41 |
+ <tr> |
|
| 42 |
+ <td><a href="#browse">browse.tpl</a></td> |
|
| 43 |
+ <td>Browse Pages</td> |
|
| 44 |
+ </tr> |
|
| 45 |
+ <tr> |
|
| 46 |
+ <td><a href="#categories">categories.tpl</a></td> |
|
| 47 |
+ <td>Browse Categories</td> |
|
| 48 |
+ </tr> |
|
| 49 |
+ <tr> |
|
| 50 |
+ <td><p><a href="#comments">comments.tpl</a></p></td> |
|
| 51 |
+ <td>News</td> |
|
| 52 |
+ </tr> |
|
| 53 |
+ <tr> |
|
| 54 |
+ <td><a href="#default">default.tpl</a></td> |
|
| 55 |
+ <td>Most pages</td> |
|
| 56 |
+ </tr> |
|
| 57 |
+ <tr> |
|
| 58 |
+ <td><a href="#favcomment">favcomment.tpl</a></td> |
|
| 59 |
+ <td>Favorites Lists</td> |
|
| 60 |
+ </tr> |
|
| 61 |
+ <tr> |
|
| 62 |
+ <td><a href="#footer">footer.tpl</a></td> |
|
| 63 |
+ <td>All pages</td> |
|
| 64 |
+ </tr> |
|
| 65 |
+ <tr> |
|
| 66 |
+ <td><a href="#header">header.tpl</a></td> |
|
| 67 |
+ <td>All pages</td> |
|
| 68 |
+ </tr> |
|
| 69 |
+ <tr> |
|
| 70 |
+ <td><a href="#index">index.tpl</a></td> |
|
| 71 |
+ <td>Index</td> |
|
| 72 |
+ </tr> |
|
| 73 |
+ <tr> |
|
| 74 |
+ <td><a href="#listings">listings.tpl</a></td> |
|
| 75 |
+ <td>Any page listing stories or series</td> |
|
| 76 |
+ </tr> |
|
| 77 |
+ <tr> |
|
| 78 |
+ <td><a href="#newsbox">newsbox.tpl</a></td> |
|
| 79 |
+ <td>News & news block</td> |
|
| 80 |
+ </tr> |
|
| 81 |
+ <tr> |
|
| 82 |
+ <td><a href="#printstory">printstory.tpl</a></td> |
|
| 83 |
+ <td>View Story (Printable)</td> |
|
| 84 |
+ </tr> |
|
| 85 |
+ <tr> |
|
| 86 |
+ <td><a href="#profile">profile.tpl</a></td> |
|
| 87 |
+ <td>User Profile</td> |
|
| 88 |
+ </tr> |
|
| 89 |
+ <tr> |
|
| 90 |
+ <td><a href="#reviewblock">reviewblock.tpl</a></td> |
|
| 91 |
+ <td>Reviews</td> |
|
| 92 |
+ </tr> |
|
| 93 |
+ <tr> |
|
| 94 |
+ <td><a href="#reviews">reviews.tpl</a></td> |
|
| 95 |
+ <td>Reviews</td> |
|
| 96 |
+ </tr> |
|
| 97 |
+ <tr> |
|
| 98 |
+ <td><a href="#seriestitle">series_title.tpl</a></td> |
|
| 99 |
+ <td>View Series</td> |
|
| 100 |
+ </tr> |
|
| 101 |
+ <tr> |
|
| 102 |
+ <td><a href="#storyindex">storyindex.tpl</a></td> |
|
| 103 |
+ <td>Story Table of Contents</td> |
|
| 104 |
+ </tr> |
|
| 105 |
+ <tr> |
|
| 106 |
+ <td><a href="#user">user.tpl</a></td> |
|
| 107 |
+ <td>User Profile/Info</td> |
|
| 108 |
+ </tr> |
|
| 109 |
+ <tr> |
|
| 110 |
+ <td><a href="#viewstory">viewstory.tpl</a></td> |
|
| 111 |
+ <td>View Story</td> |
|
| 112 |
+ </tr> |
|
| 113 |
+ </table> |
|
| 114 |
+ </center> |
|
| 115 |
+</div> |
|
| 116 |
+<p>Now, to quote Douglas Adams...Don't Panic! That's the most number of |
|
| 117 |
+ files a skin would use. Most skins will consist of quite a few less. |
|
| 118 |
+ If you install add-on modules, those modules may require additional .tpl files |
|
| 119 |
+ which will be included with the module. </p> |
|
| 120 |
+<p>Within the script files is a folder called default_tpls. It includes |
|
| 121 |
+ a very basic complete skin that will be used if for whatever reason your site's |
|
| 122 |
+ default skin or your member's chosen skin are missing. If any of these |
|
| 123 |
+ .tpl files (except for header.tpl and footer.tpl) are missing the script will |
|
| 124 |
+ fall back on the files in the default_tpls folder. Many of the tpl files |
|
| 125 |
+ are generic enough that they can easily be left to the ones in default_tpls |
|
| 126 |
+ and styled using CSS. In addition to the .tpl files you will have a style.css |
|
| 127 |
+ file and optionally, a variables.php file. The variables.php file allows |
|
| 128 |
+ you to override certain universal settings for this skin such as where blocks |
|
| 129 |
+ load and the graphics used for your ratings and featured stories.</p> |
|
| 130 |
+<p>A fewimportant things to pay attention to when modifying the template files:</p> |
|
| 131 |
+<ol> |
|
| 132 |
+ <li><b>Variables</b>: Items in curly brackets are variables, i.e. {output} or
|
|
| 133 |
+ {authors}. This contains the actual content that will be printed out on the
|
|
| 134 |
+ page. You can surround these attributes with any kind of html that you want |
|
| 135 |
+ -- font tags, tables, whatever. Some variables are required on some of the |
|
| 136 |
+ template pages and some are optional. </li> |
|
| 137 |
+ <li><b>Blocks</b>: These are items that generate multiple instances of content |
|
| 138 |
+ in a loop -- for example, in your index.tpl template file, you only need to |
|
| 139 |
+ indicate where the news items should display on the page with the following:<br> |
|
| 140 |
+ <!-- INCLUDE BLOCK : newsbox --><br> |
|
| 141 |
+ This line is telling the script to include the newsbox.tpl file, and the template |
|
| 142 |
+ files will understand that it should print out several news stories in a loop, |
|
| 143 |
+ with just that one line of code. Another kind of block you may see is the |
|
| 144 |
+ following:<br> |
|
| 145 |
+ <!-- START BLOCK : categoriesblock --><br> |
|
| 146 |
+ <br> |
|
| 147 |
+ Content goes here, which will also include attributes, such as {category}
|
|
| 148 |
+ or {description}<br>
|
|
| 149 |
+ <br> |
|
| 150 |
+ <!-- END BLOCK : categoriesblock --><br> |
|
| 151 |
+ This is similar to the included block, except that rather than pulling in |
|
| 152 |
+ the block from another file, as in the case of the newsbox.tpl, this one is |
|
| 153 |
+ just defining the block at this very moment. As you read through the individual |
|
| 154 |
+ template file instructions below and look at the actual templates, all of |
|
| 155 |
+ this will make more sense. <b> Block declarations should go on lines |
|
| 156 |
+ by themselves.</b></li> |
|
| 157 |
+ <li><b>Blocks vs. Blocks: </b>The template blocks in the .tpl files are |
|
| 158 |
+ not the same as the blocks you configure in the admin panel. The blocks |
|
| 159 |
+ in the admin panel are "blocks" of code that generate content they |
|
| 160 |
+ place inside template variables. The blocks in the .tpl files are "blocks" |
|
| 161 |
+ of content. While there is some overlap, thinking of them as being separate |
|
| 162 |
+ from each other will help you keep things straight. Each "code |
|
| 163 |
+ block" will generate two "content blocks": {blockname_title}
|
|
| 164 |
+ and {blockname_content}. You may or may not include the {blockname_title}
|
|
| 165 |
+ variable in your skin. It's up to you. However, using the {blockname_title}
|
|
| 166 |
+ in your skin means if you ever want to change the title of the block you only |
|
| 167 |
+ have to do it in one place instead of in each skin. You assign where |
|
| 168 |
+ the block will be assigned to in the admin panel. There are 3 choices: |
|
| 169 |
+ <br> |
|
| 170 |
+ |
|
| 171 |
+ <div align="center"> |
|
| 172 |
+ <center> |
|
| 173 |
+ <table border="1" cellpadding="5" cellspacing="0" |
|
| 174 |
+ style="border-collapse: collapse" bordercolor="#111111"> |
|
| 175 |
+ <tr> |
|
| 176 |
+ <th width="50%">Status</th> |
|
| 177 |
+ <th width="50%"> Associated .tpl file</th> |
|
| 178 |
+ </tr> |
|
| 179 |
+ <tr> |
|
| 180 |
+ <td width="50%">Inactive</td> |
|
| 181 |
+ <td width="50%">The block is off. </td> |
|
| 182 |
+ </tr> |
|
| 183 |
+ <tr> |
|
| 184 |
+ <td width="50%">Active</td> |
|
| 185 |
+ <td width="50%">The block is on. Can appear on every page.</td> |
|
| 186 |
+ </tr> |
|
| 187 |
+ <tr> |
|
| 188 |
+ <td width="50%">Index Only</td> |
|
| 189 |
+ <td width="50%">Appears on the index page only.</td> |
|
| 190 |
+ </tr> |
|
| 191 |
+ </table> |
|
| 192 |
+ </center> |
|
| 193 |
+ </div> |
|
| 194 |
+ <p>You may also override these settings for an individual skin by placing |
|
| 195 |
+ information for that block in the variables.php file. More on that later.</li> |
|
| 196 |
+ <li>The .tpl files do not have some of the usual tags at the beginning, such |
|
| 197 |
+ as <head> or <title>. That is because those tags are included |
|
| 198 |
+ in the header file. Most of the template files begin with the header block |
|
| 199 |
+ and end with the footer block except for a couple of the blocks (newsblock.tpl, |
|
| 200 |
+ comments.tpl and listings.tpl)</li> |
|
| 201 |
+ <li>Using "hooks" various 3rd party and included modules (such as |
|
| 202 |
+ challenges) can add their own variables to these templates. Check the documentation |
|
| 203 |
+ for the modules for specific additions. </li> |
|
| 204 |
+</ol> |
|
| 205 |
+<p>Feel free to use the files in the default_tpls/ folder as templates for your |
|
| 206 |
+ own skins. Copy the files into a new skin folder and modify them there. |
|
| 207 |
+ <strong><font color="#FF0000">Do not modify the files in default_tpls/ if at |
|
| 208 |
+ all possible. They're often used for diagnostic purposes if the site isn't functioning |
|
| 209 |
+ as expected.</font></strong> <u>Also, you are in no way limited to CSS |
|
| 210 |
+ for the layout of your skins. Feel free to use tables to your heart's |
|
| 211 |
+ content. </u></p> |
|
| 212 |
+<hr> |
|
| 213 |
+<p><a name="browse"></a>browse.tpl</p> |
|
| 214 |
+<p>This file controls the look of the browse pages (categories, classifications, |
|
| 215 |
+ etc.) The header, footer, and listing blocks are included in this file along |
|
| 216 |
+ with a block for the sort form that is displayed when there are story results. |
|
| 217 |
+ In addition you will want to include two other variables:</p> |
|
| 218 |
+<p>You will need to start by including the header block.</p> |
|
| 219 |
+<p class="sample"><!-- INCLUDE BLOCK : header --></p> |
|
| 220 |
+<p>And end by including the footer block.</p> |
|
| 221 |
+<p class="sample"> <!-- INCLUDE BLOCK : footer --></p> |
|
| 222 |
+<p>{output} - Miscellaneous information on the pages including the page title.<br>
|
|
| 223 |
+ {otherresults} - The list of other results (challenges, series, etc.) that fit
|
|
| 224 |
+ the criteria for the page.</p> |
|
| 225 |
+<p>Within the sort form the following variables are used:</p> |
|
| 226 |
+<p>{sortbegin} - the beginning of the sort menu form<br>
|
|
| 227 |
+ {charactermenu1} - A list of characters to choose from<br>
|
|
| 228 |
+ {charactermenu2} - A second list of characters<br>
|
|
| 229 |
+ {classmenu} - A dropdown list for each of the site's classification types (genres,
|
|
| 230 |
+ warnings, etc.)<br> |
|
| 231 |
+ {ratingmenu} - A list of ratings<br>
|
|
| 232 |
+ {sortmenu} - Choose how the stories will be sorted alphabetically or by most
|
|
| 233 |
+ recently updated<br> |
|
| 234 |
+ {completemenu} - Choose all stories or only completed stories<br>
|
|
| 235 |
+ {sortend} - the end of the sort menu form</p>
|
|
| 236 |
+<p>You may include all or none of these and in whatever order you wish, except |
|
| 237 |
+ the {sortbegin} and {sortend} variables must be at the beginning and end of
|
|
| 238 |
+ the list of variables in the form.</p> |
|
| 239 |
+<p class="sampleLabel">Sample: </p> |
|
| 240 |
+<p class="sample"><!-- INCLUDE BLOCK : header --><br> |
|
| 241 |
+ {output}{otherresults}<br>
|
|
| 242 |
+ <!-- START BLOCK : sortform --><br> |
|
| 243 |
+ <div id="sortform">{sortbegin}{categorymenu} {charactermenu1}
|
|
| 244 |
+ {charactermenu2} {ratingmenu} {classmenu} {sortmenu} {completemenu} {sortend}</div><br>
|
|
| 245 |
+ <!-- END BLOCK : sortform --><br> |
|
| 246 |
+ <!-- INCLUDE BLOCK : listings --><br> |
|
| 247 |
+ <!-- INCLUDE BLOCK : footer --></p> |
|
| 248 |
+<p><a name="categories"></a>categories.tpl</p> |
|
| 249 |
+<p>The categories.tpl controls the look of the individual category on the categories |
|
| 250 |
+ browse page. <strong>Note:</strong> The appearance of the categories block is |
|
| 251 |
+ controlled separately through the block's admin panel. </p> |
|
| 252 |
+<p>The block must start with:</p> |
|
| 253 |
+<p class="sample"><!-- START BLOCK : categoryblock --></p> |
|
| 254 |
+<p>and end with:</p> |
|
| 255 |
+<p class="sample"><!-- END BLOCK : categoryblock --></p> |
|
| 256 |
+<p>The following variables are available to use in the block:</p> |
|
| 257 |
+<p>{image} - The image associated with that category. Note: The name of the image
|
|
| 258 |
+ is set in the Categories admin panel. The image file must be in the skin's directory. |
|
| 259 |
+ If the script can't find the image it will display nothing. (In 1.1 a broken |
|
| 260 |
+ image was displayed.)<br> |
|
| 261 |
+ {link} - The link to the category's browse page.<br>
|
|
| 262 |
+ {count} - The count of stories within that category.<br>
|
|
| 263 |
+ {description} - The category's description.</p>
|
|
| 264 |
+<p class="sampleLabel">Sample:</p> |
|
| 265 |
+<p class="sample"><!-- START BLOCK : categoryblock --><br> |
|
| 266 |
+ {image} {link} {count} {description}<br>
|
|
| 267 |
+ <!-- END BLOCK : categoryblock --></p> |
|
| 268 |
+<p><a name="comments">comments.tpl</a></p> |
|
| 269 |
+<p>This block controls the display of comments on the news.php page for a single |
|
| 270 |
+ story. </p> |
|
| 271 |
+<p>You must start the file with:</p> |
|
| 272 |
+<p class="sample"><!-- START BLOCK : commentbox --></p> |
|
| 273 |
+<p>and end it with:</p> |
|
| 274 |
+<p class="sample"><!-- END BLOCK : commentbox --></p> |
|
| 275 |
+<p>This information should be placed on separate lines. Between these two |
|
| 276 |
+ lines the following variables should be included.</p> |
|
| 277 |
+<p>{comment} - The comment from the member.<br>
|
|
| 278 |
+ {uname} - The member's name as a hyperlink to their profile.<br>
|
|
| 279 |
+ {date} - The date the comment was made.<br>
|
|
| 280 |
+ {adminoptions} - Options visible to the administrator when viewing the page.</p>
|
|
| 281 |
+<p>The variable {oddeven} is optional, you can use it to assign alternating styles
|
|
| 282 |
+ to each comment.</p> |
|
| 283 |
+<p class="sampleLabel">Sample:</p> |
|
| 284 |
+<p class="sample"><!-- START BLOCK : commentbox --><br> |
|
| 285 |
+ <div class="comment {oddeven}"><br>
|
|
| 286 |
+ {comment}<br>
|
|
| 287 |
+ <div class="commentsig">- {uname} on {date}</div><br>
|
|
| 288 |
+ <div class="adminoptions"> {adminoptions}</div><br>
|
|
| 289 |
+ </div><br> |
|
| 290 |
+ <!-- END BLOCK : commentbox --></p> |
|
| 291 |
+<p><a name="default">default.tpl</a></p> |
|
| 292 |
+<p>The majority of pages use this for their layout. Most likely you won't |
|
| 293 |
+ need to include it in your skin at all.</p> |
|
| 294 |
+<p>You must include the <a href="#header">header</a>, <a href="#listings"> listings</a>, |
|
| 295 |
+ and <a href="#footer">footer</a> block as seen below and include the {output}
|
|
| 296 |
+ variable BEFORE the listings block. The {output} variable provides various
|
|
| 297 |
+ text like the page title and alphabet list for titles. You will probably not |
|
| 298 |
+ need to replicate this file in your skin since there's nothing much to change |
|
| 299 |
+ really.</p> |
|
| 300 |
+<p class="sampleLabel">Sample:</p> |
|
| 301 |
+<p class="sample"><!-- INCLUDE BLOCK : header --><br> |
|
| 302 |
+ {output}<br>
|
|
| 303 |
+ <!-- INCLUDE BLOCK : listings --><br> |
|
| 304 |
+ <!-- INCLUDE BLOCK : footer --></p> |
|
| 305 |
+<p></p> |
|
| 306 |
+<p><a name="favcomments"></a>favcomment.tpl</p> |
|
| 307 |
+<p>In eFiction 3.0 when favorites are turned on by the admin, members have the |
|
| 308 |
+ option of not only marking a story as a favorite, but also including a comment |
|
| 309 |
+ as to why it is their favorite. The favcomment.tpl us used to display these |
|
| 310 |
+ comments in the user's profile.</p> |
|
| 311 |
+<p>The block must start with:</p> |
|
| 312 |
+<p class="sample"><!-- START BLOCK : comment --></p> |
|
| 313 |
+<p>and end with:</p> |
|
| 314 |
+<p class="sample"><!-- END BLOCK : comment --></p> |
|
| 315 |
+<p>In addition the following variables can be used within the block:</p> |
|
| 316 |
+<p>{comment} - The member's comment<br>
|
|
| 317 |
+ {commentoptions} - Options concerning this comment for admin and the person
|
|
| 318 |
+ who commented<br> |
|
| 319 |
+ {oddeven} - This variable can be used to style alternating comments differently.</p>
|
|
| 320 |
+<p class="sampleLabel">Sample:</p> |
|
| 321 |
+<p class="sample"><!-- START BLOCK : comment --><br> |
|
| 322 |
+ <div class="comment{oddeven}"><br>
|
|
| 323 |
+ {comment}<br>
|
|
| 324 |
+ {commentoptions}<br>
|
|
| 325 |
+ </div><br> |
|
| 326 |
+ <!-- END BLOCK : comment --></p> |
|
| 327 |
+<p><a name="footer">footer.tpl</a></p> |
|
| 328 |
+<p>You must start the file with:</p> |
|
| 329 |
+<p class="sample"><!-- START BLOCK : footer --></p> |
|
| 330 |
+<p>and end it with:</p> |
|
| 331 |
+<p class="sample"><!-- END BLOCK : footer --></p> |
|
| 332 |
+<p>In addition to the <a href="#pagelinks">universal page links</a>, the footer.tpl |
|
| 333 |
+ also has one other variable assigned to it. </p> |
|
| 334 |
+<p>{footer} - Your copyright statement.</p>
|
|
| 335 |
+<p>Content assigned to the footer in the admin panel or in the skin's variables.php |
|
| 336 |
+ file will also be included here.</p> |
|
| 337 |
+<p class="sampleLabel">Sample: </p> |
|
| 338 |
+<p class="sample"><!-- START BLOCK : footer --><br> |
|
| 339 |
+ </div><br> |
|
| 340 |
+ <div id="footer">{footer}</div></div><br>
|
|
| 341 |
+ </body></html><br> |
|
| 342 |
+ <!-- END BLOCK : footer --></p> |
|
| 343 |
+<p></p> |
|
| 344 |
+<p><a name="header">header.tpl</a></p> |
|
| 345 |
+<p>You must start the file with:</p> |
|
| 346 |
+<p class="sample"><!-- START BLOCK : header --></p> |
|
| 347 |
+<p>and end it with:</p> |
|
| 348 |
+<p class="sample"><!-- END BLOCK : header --></p> |
|
| 349 |
+<p>In addition to the <a href="#pagelinks">universal page links</a>, the |
|
| 350 |
+header.tpl also has two other variables assigned to it. The use of these |
|
| 351 |
+variables is optional.</p> |
|
| 352 |
+<p>{sitename} - Your site name<br>
|
|
| 353 |
+{slogan} - Your site slogan</p>
|
|
| 354 |
+<p>Content assigned to the header in the admin panel or in the skin's |
|
| 355 |
+variables.php file will also be included here.</p> |
|
| 356 |
+<p class="sampleLabel">Sample: </p> |
|
| 357 |
+<p class="sample"><!-- START BLOCK : header --><br> |
|
| 358 |
+ <body><br> |
|
| 359 |
+ <div id="container"><br> |
|
| 360 |
+ <div id="banner"><div style="font-size: 40pt; font-style: |
|
| 361 |
+ oblique;">{sitename}</div><div style="font-size: 13pt;">{slogan}</div><div
|
|
| 362 |
+ id="skin">{skinchange_content}<div style="padding: 5px;">{rss}</div></div><br>
|
|
| 363 |
+ </div><br> |
|
| 364 |
+ {menu_content}<br>
|
|
| 365 |
+ <div id="mainpage"><br> |
|
| 366 |
+ <!-- END BLOCK : header --></p> |
|
| 367 |
+<p><a name="index">index.tpl</a></p> |
|
| 368 |
+<p>This file controls the look of your site's home/index page. </p> |
|
| 369 |
+<p>You will need to start by including the header block.</p> |
|
| 370 |
+<p class="sample"><!-- INCLUDE BLOCK : header --></p> |
|
| 371 |
+<p>And end by including the footer block.</p> |
|
| 372 |
+<p class="sample"> <!-- INCLUDE BLOCK : footer --></p> |
|
| 373 |
+<p>In addition to the <a href="#pagelinks">universal page links</a>, the |
|
| 374 |
+index.tpl also has one other variable assigned to it. </p> |
|
| 375 |
+<p>{welcome} - Your welcome message.</p>
|
|
| 376 |
+<p>Content assigned to "index only" in the admin panel or in the skin's |
|
| 377 |
+variables.php file will also be included here. The sample below creates a |
|
| 378 |
+two column index page via positioning. See the style.css in the |
|
| 379 |
+default_tpls for the leftindex and rightindex style declarations.</p> |
|
| 380 |
+<p class="sampleLabel">Sample: </p> |
|
| 381 |
+<p class="sample"><!-- INCLUDE BLOCK : header --><br> |
|
| 382 |
+<div style="padding: 1em 0; margin-bottom: -2em;" class="clearfix"><br> |
|
| 383 |
+<div id="leftindex"><br> |
|
| 384 |
+<div class="block"><br> |
|
| 385 |
+<div class="title">{info_title}</div><br>
|
|
| 386 |
+<div class="content">{welcome}{info_content}<br><div style="width: 130px;
|
|
| 387 |
+text-align: center; margin: 0 25px;">{login_content}</div></div><br>
|
|
| 388 |
+</div><br> |
|
| 389 |
+<div class="block"><br> |
|
| 390 |
+<div class="title">{random_title}</div><br>
|
|
| 391 |
+<div class="content">{random_content}</div><br>
|
|
| 392 |
+</div><br> |
|
| 393 |
+</div><br> |
|
| 394 |
+<div id="rightindex"><br> |
|
| 395 |
+<div class="block"><br> |
|
| 396 |
+<div class="title">{categories_title}</div><br>
|
|
| 397 |
+<div class="content"><div style="width: 95%">{categories_content}</div></div><br>
|
|
| 398 |
+</div><br> |
|
| 399 |
+<div class="block"><br> |
|
| 400 |
+<div class="title">{recent_title}</div><br>
|
|
| 401 |
+<div class="content">{recent_content}</div><br>
|
|
| 402 |
+</div><br> |
|
| 403 |
+<div class="block"><br> |
|
| 404 |
+<div class="title">{news_title}</div><br>
|
|
| 405 |
+<div class="content">{news_content}</div><br>
|
|
| 406 |
+</div><br> |
|
| 407 |
+</div><br> |
|
| 408 |
+</div><br> |
|
| 409 |
+<!-- INCLUDE BLOCK : footer --></p> |
|
| 410 |
+<p><a name="listings">listings.tpl</a></p> |
|
| 411 |
+<p>This block is included in all pages where stories or series are listed such |
|
| 412 |
+as titles, categories, user's profile page, search results, etc. It is an |
|
| 413 |
+expansion of storyblock.tpl from 1.1. </p> |
|
| 414 |
+<p>You must start the file with:</p> |
|
| 415 |
+<p class="sample"><!-- START BLOCK : listings --></p> |
|
| 416 |
+<p>and end it with:</p> |
|
| 417 |
+<p class="sample"><!-- END BLOCK : listings --></p> |
|
| 418 |
+<p> In addition, the following variable should be included just above the end |
|
| 419 |
+ line:</p> |
|
| 420 |
+<p>{pagelinks} - If the results for the page require pagination, this variable
|
|
| 421 |
+ will contain the list of page links.</p> |
|
| 422 |
+<p>This block contains 2 inner blocks that control the appearance of the |
|
| 423 |
+individual series and stories.</p> |
|
| 424 |
+<p>Both the seriesblock and storyblock should contain the following variables:</p> |
|
| 425 |
+<p>{title} - Title of the story/series<br>
|
|
| 426 |
+ {author} - Author (Owner if it's an open series) of the story/series<br>
|
|
| 427 |
+ {score} - The story/series rating by members like/dislike or stars<br>
|
|
| 428 |
+ {reviews} - A link to the reviews for the story/series<br>
|
|
| 429 |
+ {numreviews} - the number of reviews linked to a listing of reviews for the
|
|
| 430 |
+ story/series<br> |
|
| 431 |
+ {summary} - The summary for the story/series<br>
|
|
| 432 |
+ {category} - The categories for the story/series<br>
|
|
| 433 |
+ {classifications} - The list of classifications for the story/series (genres,
|
|
| 434 |
+ warnings, etc.)<br> |
|
| 435 |
+ {characters} - The characters for the story/series<br>
|
|
| 436 |
+ {reportthis} - A link to report problems, errors, etc. with this story/series<br>
|
|
| 437 |
+ {addtofaves} - The option to add the story/series to favorites.<br>
|
|
| 438 |
+ {comment} - Will be used for favorite stories and also in certain reviews pages
|
|
| 439 |
+ to display comments and reviews about the story/series</p> |
|
| 440 |
+<p>Optional for both seriesblock and storyblock is the variable {oddeven}.
|
|
| 441 |
+ This variable can be used to assign "odd" or "even" status |
|
| 442 |
+ to the block for CSS styling.</p> |
|
| 443 |
+<p>The seriesblock will have the following additional variables:</p> |
|
| 444 |
+<p> {adminoptions} - Options visible to the admin when viewing the page. <br>
|
|
| 445 |
+ {open} - Whether or not the series is open to contributions from others (like
|
|
| 446 |
+ a round robin)<br> |
|
| 447 |
+ {parentseries} - If the series is a sub-series of another, the parent series
|
|
| 448 |
+ will be listed here.<br> |
|
| 449 |
+ {numstories} - The number of stories within the series.<br>
|
|
| 450 |
+</p> |
|
| 451 |
+<p>The storyblock will have the following additional variables:</p> |
|
| 452 |
+<p>{adminlinks} - Options visible to the admin when viewing the page.<br>
|
|
| 453 |
+ {serieslinks} - If the story is part of a series this will contain a link to
|
|
| 454 |
+ those series.<br> |
|
| 455 |
+ {numchapters} - The number of chapters in the story.<br>
|
|
| 456 |
+ {completed} - Whether or not the story is complete.<br>
|
|
| 457 |
+ {wordcount} - The total number of words in the story (all chapters)<br>
|
|
| 458 |
+ {toc} - A link to the story's table of contents<br>
|
|
| 459 |
+ {count} - The count for the number of times the story has been viewed.<br>
|
|
| 460 |
+ {roundrobin} - If this story is a round robin an icon will be displayed showing
|
|
| 461 |
+ this.<br> |
|
| 462 |
+ {new} - If the site has set a "recent" date range new or updated stories
|
|
| 463 |
+ falling within that range will be flagged a "New!" using this variable.<br> |
|
| 464 |
+ {featuredstory} - If the story is listed as a featured story or a retired feature
|
|
| 465 |
+ story an icon will be displayed showing this status.<br> |
|
| 466 |
+ {published} - The date the story was published.<br>
|
|
| 467 |
+ {updated} - The date the story was last updated.</p>
|
|
| 468 |
+<p class="sampleLabel">Sample:</p> |
|
| 469 |
+<p class="sample"><!-- START BLOCK : listings --><br> |
|
| 470 |
+ <!-- START BLOCK : seriesblock --><br> |
|
| 471 |
+ <div class="listbox {oddeven}"><br>
|
|
| 472 |
+ <div class="title">{title} by {author}{score} [{reviews} - {numreviews}]</div><br>
|
|
| 473 |
+ <div class="content"><span class="label">Summary: |
|
| 474 |
+ </span>{summary}<br /><br>
|
|
| 475 |
+ <span class="label">Parent Series:</span> {parentseries}<br
|
|
| 476 |
+ /><br> |
|
| 477 |
+ <span class="label">Categories:</span> {category}<br
|
|
| 478 |
+ /><br> |
|
| 479 |
+ <span class="label">Characters: </span>{characters}<br
|
|
| 480 |
+ /><br> |
|
| 481 |
+ {classifications}<br>
|
|
| 482 |
+ <span class="label">Stories:</span> {numstories}<br
|
|
| 483 |
+ /><br> |
|
| 484 |
+ <span class="label">Open:</span> {open} {addtofaves} {reportthis}<br>
|
|
| 485 |
+ {adminoptions}</div><br>
|
|
| 486 |
+ </div><br> |
|
| 487 |
+ {comment}<br>
|
|
| 488 |
+ <!-- END BLOCK : seriesblock --><br> |
|
| 489 |
+ <!-- START BLOCK : storyblock --><br> |
|
| 490 |
+ <div class="listbox {oddeven}"><br>
|
|
| 491 |
+ <div class="title">{title} by {author} <span class="label">Rated:</span>
|
|
| 492 |
+ {rating} {roundrobin} {score} [{reviews} - {numreviews}] {new} </div><br>
|
|
| 493 |
+ <div class="content"><span class="label">Summary: |
|
| 494 |
+ </span>{featuredstory}{summary}<br /><br>
|
|
| 495 |
+ <span class="label">Categories:</span> {category} <br
|
|
| 496 |
+ /><br> |
|
| 497 |
+ <span class="label">Characters: </span> {characters}<br
|
|
| 498 |
+ /><br> |
|
| 499 |
+ {classifications}<br>
|
|
| 500 |
+ <span class="label">Series:</span> {serieslinks}<br
|
|
| 501 |
+ /><br> |
|
| 502 |
+ <span class="label">Chapters: </span> {numchapters} {toc}<br
|
|
| 503 |
+ /><br> |
|
| 504 |
+ <span class="label">Completed:</span> {completed} <br>
|
|
| 505 |
+ <span class="label">Word count:</span> {wordcount} <span
|
|
| 506 |
+ class="label">Read Count:</span> {count}<br>
|
|
| 507 |
+ {adminlinks}</div><br>
|
|
| 508 |
+ <div class="tail"><span class="label">{addtofaves}
|
|
| 509 |
+ {reportthis} Published: </span>{published} <span class="label">Updated:</span>
|
|
| 510 |
+ {updated}</div><br>
|
|
| 511 |
+ </div><br> |
|
| 512 |
+ {comment}<br>
|
|
| 513 |
+ <!-- END BLOCK : storyblock --><br> |
|
| 514 |
+ {pagelinks}<br>
|
|
| 515 |
+ <!-- END BLOCK : listings --></p> |
|
| 516 |
+<p><a name="newsbox">newsbox.tpl</a></p> |
|
| 517 |
+<p>This block displays one news story, and will be called by the news block and |
|
| 518 |
+ is also used in the news archive page.</p> |
|
| 519 |
+<p>You must start the file with:</p> |
|
| 520 |
+<p class="sample"><!-- START BLOCK : newsbox --></p> |
|
| 521 |
+<p>and end it with:</p> |
|
| 522 |
+<p class="sample"><!-- END BLOCK : newsbox --></p> |
|
| 523 |
+<p>At a minimum, the following variables should be included in the block. |
|
| 524 |
+</p> |
|
| 525 |
+<p>{newstitle} - The title of the news story<br>
|
|
| 526 |
+ {newsstory} - The content of the news story<br>
|
|
| 527 |
+ {newsauthor} - The author of the news story<br>
|
|
| 528 |
+ {newsdate} - The date the news item was added to the site<br>
|
|
| 529 |
+ {newscomments} - The number of comments the story has received with a link to
|
|
| 530 |
+ view the comments.</p> |
|
| 531 |
+<p>Additionally, if you wish administrator options to appear when an admin views |
|
| 532 |
+ the story you should include:</p> |
|
| 533 |
+<p>{adminoptions}</p>
|
|
| 534 |
+<p>Finally, if you want alternating stories to appear with different CSS options |
|
| 535 |
+ you can include:</p> |
|
| 536 |
+<p>{oddeven} - Where this variable is placed the word "even" will appear
|
|
| 537 |
+ in even numbered stories and the word "odd" will appear in odd numbered |
|
| 538 |
+ stories.</p> |
|
| 539 |
+<p class="sampleLabel">Sample:</p> |
|
| 540 |
+<p class="sample"><!-- START BLOCK : newsbox --><br> |
|
| 541 |
+ <div class="newsbox_{oddeven}"><br>
|
|
| 542 |
+ <div class="newstitle">{newstitle} {adminoptions}</div><br>
|
|
| 543 |
+ {newsstory}<br /><br /><br>
|
|
| 544 |
+ --{newsauthor} on {newsdate} {newscomments}<br>
|
|
| 545 |
+ </div><br> |
|
| 546 |
+ <!-- END BLOCK : newsbox --></p> |
|
| 547 |
+<p><a name="printstory"></a>printstory.tpl</p> |
|
| 548 |
+<p>This template is used when the print story function is used. Generally this |
|
| 549 |
+ is another block that you can probably leave to the default_tpls. The following |
|
| 550 |
+ variables should be included in this template:</p> |
|
| 551 |
+<p>{title} - The title of the story<br>
|
|
| 552 |
+ {author} - The author(s) of the story<br>
|
|
| 553 |
+ {featuredstory} - The featured/retired icon will be displayed here if the story
|
|
| 554 |
+ is featured.<br> |
|
| 555 |
+ {summary} - The summary of the story<br>
|
|
| 556 |
+ {category} - The story's categories<br>
|
|
| 557 |
+ {characters} - The story's character list<br>
|
|
| 558 |
+ {classifications} - The other classification information for the story (genres,
|
|
| 559 |
+ warnings, etc.)<br> |
|
| 560 |
+ {challengelinks} - The challenges to which this story is a response<br>
|
|
| 561 |
+ {serieslinks} - The list of series to which this story belongs<br>
|
|
| 562 |
+ {numchapters} - The number of chapters in the story<br>
|
|
| 563 |
+ {completed} - Whether or not the story is complete<br>
|
|
| 564 |
+ {wordcount} - The word count for the story<br>
|
|
| 565 |
+ {count} - The read count for the story<br>
|
|
| 566 |
+ {published} - The date the story was published<br>
|
|
| 567 |
+ {updated} - The date the story was updated<br>
|
|
| 568 |
+ {copyright} - The print version of the site's copyright notice<br>
|
|
| 569 |
+ {archivedat} - A statement of where the story is archived at.</p>
|
|
| 570 |
+<p>In addition to these variables there are several blocks included in this template. |
|
| 571 |
+ The storynotes block will be displayed if the story contains notes. It contains |
|
| 572 |
+ one variable, {storynotes}. The next block should be the storyindexblock. For
|
|
| 573 |
+ multi-chapter stories, this will be the table of contents. The storyindexblock |
|
| 574 |
+ will be one chapter's worth of information about the story. The following variables |
|
| 575 |
+ can be included in the storyindexblock:</p> |
|
| 576 |
+<p>{title} - The chapter's title<br>
|
|
| 577 |
+ {author} - The author of the chapter<br>
|
|
| 578 |
+ {chapternumber} - The chapter number.</p>
|
|
| 579 |
+<p>The next block will be the chapter information for each chapter. This block |
|
| 580 |
+ contains blocks inside it for the chapter notes and endnotes. The following |
|
| 581 |
+ variables can be included in the chapterblock:</p> |
|
| 582 |
+<p>{chaptertitle} - The title of the chapter<br>
|
|
| 583 |
+ {chapterauthor} - The author of the chapter<br>
|
|
| 584 |
+ {chaptertext} - The text of the chapter<br>
|
|
| 585 |
+ {back2top} - An anchor back to the top of the document.</p>
|
|
| 586 |
+<p>The notes block contains a single variable {notes} and the endnotes block contains
|
|
| 587 |
+ a single variable {endnotes}. These blocks plus the storynotes block are placed
|
|
| 588 |
+ in blocks so that html can be used around the blocks if the information is present |
|
| 589 |
+ and hidden when not.</p> |
|
| 590 |
+<p class="sampleLabel">Sample:</p> |
|
| 591 |
+<p class="sample"><div id="pagetitle">{title} by {author}</div><br>
|
|
| 592 |
+ <div class="infobox"><br> |
|
| 593 |
+ <div class="content">{featuredstory}<span class="label">Summary:
|
|
| 594 |
+ </span>{summary}<br /><br>
|
|
| 595 |
+ <span class="label">Categories:</span> {category} <span
|
|
| 596 |
+ class="label">Characters: </span> {characters}<br /><br>
|
|
| 597 |
+ {classifications}<br>
|
|
| 598 |
+ <span class="label">Challenges:</span> {challengelinks}<br
|
|
| 599 |
+ /> <span class="label">Series:</span> {serieslinks}<br
|
|
| 600 |
+ /><br> |
|
| 601 |
+ <span class="label">Chapters: </span> {numchapters} <span
|
|
| 602 |
+ class="label">Completed:</span> {completed} <br>
|
|
| 603 |
+ <span class="label">Word count:</span> {wordcount} <span
|
|
| 604 |
+ class="label">Read:</span> {count}<br>
|
|
| 605 |
+ <span class="label"> Published: </span>{published} <span
|
|
| 606 |
+ class="label">Updated:</span> {updated} </div><br>
|
|
| 607 |
+ </div><br> |
|
| 608 |
+ <!-- START BLOCK : storynotes --><br> |
|
| 609 |
+ <div class='notes'><div class='title'><span class='label'>Story |
|
| 610 |
+ Notes:</span></div><div class='noteinfo'>{storynotes}</div></div><br>
|
|
| 611 |
+ <!-- END BLOCK : storynotes --><br> |
|
| 612 |
+ <!-- START BLOCK : storyindexblock --><br> |
|
| 613 |
+ <p><b>{chapternumber}.</b> {title} by {author}</p><br>
|
|
| 614 |
+ <!-- END BLOCK : storyindexblock --><br> |
|
| 615 |
+ <!-- START BLOCK : chapterblock --><br> |
|
| 616 |
+ <div class='chaptertitle'>{chaptertitle} by {chapterauthor}</div><br>
|
|
| 617 |
+ <!-- START BLOCK : notes --><br> |
|
| 618 |
+ <div class='notes'><div class='title'><span class='label'>Author's |
|
| 619 |
+ Notes:</div><div class='noteinfo'>{notes}</div></div><br>
|
|
| 620 |
+ <!-- END BLOCK : notes --><br> |
|
| 621 |
+ <div class='chapter'>{chaptertext}</div><br>
|
|
| 622 |
+ <!-- START BLOCK : endnotes --><br> |
|
| 623 |
+ <div class='notes'><div class='title'><span class='label'>End |
|
| 624 |
+ Notes:</div><div class='noteinfo'>{endnotes}</div></div><br>
|
|
| 625 |
+ <!-- END BLOCK : endnotes --><br> |
|
| 626 |
+ <div class='toplink'>{back2top}</div><br>
|
|
| 627 |
+ <!-- END BLOCK : chapterblock --><br> |
|
| 628 |
+ <div id="copyright">{copyright}</div><br>
|
|
| 629 |
+ <div id="archivedat">{archivedat}</div></p>
|
|
| 630 |
+<p><a name="profile"></a>profile.tpl</p> |
|
| 631 |
+<p>This template is used in the author's profile page. It's been separated out |
|
| 632 |
+ of the user.tpl so that it can be re-used in other panels if needed.</p> |
|
| 633 |
+<p>You must start the file with:</p> |
|
| 634 |
+<p class="sample"><!-- START BLOCK : profile --></p> |
|
| 635 |
+<p>and end it with:</p> |
|
| 636 |
+<p class="sample"><!-- END BLOCK : profile --></p> |
|
| 637 |
+<p>The following variables can be included in this file:</p> |
|
| 638 |
+<p>{realname} - The member's real name<br>
|
|
| 639 |
+ {userpenname} - The member's penname<br>
|
|
| 640 |
+ {membersince} - The date the member joined the site<br>
|
|
| 641 |
+ {userlevel} - The member's user level Member or Admin (if the person viewing
|
|
| 642 |
+ the page is an admin they will see the admin level)<br> |
|
| 643 |
+ {image} - The member's image from their bio information<br>
|
|
| 644 |
+ {bio} - The autor's bio<br>
|
|
| 645 |
+ {authorfields} - The list of admin defined author fields. i.e. aol, icq, etc.<br>
|
|
| 646 |
+ {adminoptions} - A list of admin options about the member (visible only to admins)<br>
|
|
| 647 |
+ {reportthis} - A report this link for the members profile</p>
|
|
| 648 |
+<p>For each active authorfield, you will also have a variable for that information. |
|
| 649 |
+ For instance, if you've activated the AOL authorfield, the variable {aol} will
|
|
| 650 |
+ also output the aol information for the member. </p> |
|
| 651 |
+<p>Note: this is for a non-bridged site. If you've bridged your site, the variables |
|
| 652 |
+ available to your profile will depend on how your bridge is set up.</p> |
|
| 653 |
+<p class="sampleLabel">Sample:</p> |
|
| 654 |
+<p class="sample"><!-- START BLOCK : profile --><br> |
|
| 655 |
+ <div id="profile"><br> |
|
| 656 |
+ <div id="bio"><br> |
|
| 657 |
+ <div id="biotitle"><span class="label">Penname: |
|
| 658 |
+ </span>{userpenname} <span class="label">Real name: </span>{realname}</div><br>
|
|
| 659 |
+ <div id="biocontent"><br> |
|
| 660 |
+ <span class="label">Member Since: </span>{membersince}<br
|
|
| 661 |
+ /><br> |
|
| 662 |
+ <span class="label">Membership status:</span> {userlevel}<br
|
|
| 663 |
+ /><br> |
|
| 664 |
+ <span class="label">Bio:</span><br>{image}{bio}<br
|
|
| 665 |
+ /><br> |
|
| 666 |
+ {authorfields} <br>
|
|
| 667 |
+ </div><br> |
|
| 668 |
+ </div><br> |
|
| 669 |
+ {adminoptions} {reportthis}<br>
|
|
| 670 |
+ </div><br> |
|
| 671 |
+ <!-- END BLOCK : profile --></p> |
|
| 672 |
+<p><a name="reviewblock"></a>reviewblock.tpl</p> |
|
| 673 |
+<p>This block controls the display of an individual review. It's been separated |
|
| 674 |
+ from the reviews.tpl file so it can be re-used in other panels.</p> |
|
| 675 |
+<p>You must start the file with:</p> |
|
| 676 |
+<p class="sample"><!-- START BLOCK : reviewsblock --></p> |
|
| 677 |
+<p>and end it with:</p> |
|
| 678 |
+<p class="sample"><!-- END BLOCK : reviewsblock --></p> |
|
| 679 |
+<p>The following variables can be included in this file:</p> |
|
| 680 |
+<p>{reviewer} - The name of the reviewer<br>
|
|
| 681 |
+ {member} - The words Signed or Anonymous depending on whether the reviewer was
|
|
| 682 |
+ a member<br> |
|
| 683 |
+ {rating} - The thumbs up/down or star rating the reviewer gave<br>
|
|
| 684 |
+ {reportthis} - A link to report trouble with this review<br>
|
|
| 685 |
+ {reviewdate} - The date the review was given<br>
|
|
| 686 |
+ {chapter} - The title of the item being reviewed (chapter if it's a story and
|
|
| 687 |
+ the chapter is named)<br> |
|
| 688 |
+ {review} - The text of the review<br>
|
|
| 689 |
+ {adminoptions} - Admin options for the review</p>
|
|
| 690 |
+<p class="sampleLabel">Sample:</p> |
|
| 691 |
+<p class="sample"><!-- START BLOCK : reviewsblock --><br> |
|
| 692 |
+ <div class="listbox"><br> |
|
| 693 |
+ <div class="content{oddeven}"><br>
|
|
| 694 |
+ <span class="label">Reviewer: </span>{reviewer} <span
|
|
| 695 |
+ class="label">{member}</span> {rating} {reportthis}<br
|
|
| 696 |
+ /><br> |
|
| 697 |
+ <span class="label">Date: </span>{reviewdate}<br>
|
|
| 698 |
+ <span class="label">Title: </span>{chapter}<br>
|
|
| 699 |
+ <p>{review}</p><br>
|
|
| 700 |
+ {adminoptions}<br>
|
|
| 701 |
+ </div><br> |
|
| 702 |
+ </div><br> |
|
| 703 |
+ <!-- END BLOCK : reviewsblock --></p> |
|
| 704 |
+<p><a name="reviews">reviews.tpl</a></p> |
|
| 705 |
+<p>This block controls the display of the reviews page. This .tpl includes |
|
| 706 |
+an inner block that formats the individual reviews on the page. The |
|
| 707 |
+following variables are included in the reviews.tpl</p> |
|
| 708 |
+<p>{pagetitle} - The title of the page<br>
|
|
| 709 |
+ {output} - Used for error and confirmation messages. Should probably be
|
|
| 710 |
+ included just below {pagetitle}<br>
|
|
| 711 |
+ {jumpmenu} - Displays the jump menu for reviews pages that require it.<br>
|
|
| 712 |
+ {reviewpagelinks} - Used for pagination. Should be included AFTER the
|
|
| 713 |
+ reviewsblock<br> |
|
| 714 |
+ {reviewslink} - Link inviting visitor to submit a review (Optional can use {reviewsform}
|
|
| 715 |
+ instead) <br> |
|
| 716 |
+ {reviewsform} - The review form. (Optional can use {reviewslink} instead)</p>
|
|
| 717 |
+<p>You will need to start by including the header block.</p> |
|
| 718 |
+<p class="sample"><!-- INCLUDE BLOCK : header --></p> |
|
| 719 |
+<p>And end by including the footer block.</p> |
|
| 720 |
+<p class="sample"> <!-- INCLUDE BLOCK : footer --></p> |
|
| 721 |
+<p class="sampleLabel">Sample:</p> |
|
| 722 |
+<p class="sample"><!-- INCLUDE BLOCK : header --><br> |
|
| 723 |
+ {pagetitle}<br>
|
|
| 724 |
+ <div class="respond">{reviewslink}</div><br>
|
|
| 725 |
+ <div class="jumpmenu">{jumpmenu}</div><br>
|
|
| 726 |
+ {output}<br>
|
|
| 727 |
+ <!-- INCLUDE BLOCK : reviewsblock --><br> |
|
| 728 |
+ {reviewpagelinks}<br>
|
|
| 729 |
+ {reviewform}<br>
|
|
| 730 |
+ <!-- INCLUDE BLOCK : footer --></p> |
|
| 731 |
+<p><a name="seriestitle"></a>series_title.tpl</p> |
|
| 732 |
+<p>This template displays the title block information on a series page. </p> |
|
| 733 |
+<p>You must start the file with:</p> |
|
| 734 |
+<p class="sample"><!-- START BLOCK: series --></p> |
|
| 735 |
+<p>and end it with:</p> |
|
| 736 |
+<p class="sample"><!-- END BLOCK : series --></p> |
|
| 737 |
+<p>The following variables can be included in this file:</p> |
|
| 738 |
+<p>{pagetitle} - This will be the series title and author links<br>
|
|
| 739 |
+ {rating} - The thumbs up/down or star rating for the series<br>
|
|
| 740 |
+ {summary} - The series' summary<br>
|
|
| 741 |
+ {category} - The category information for the series<br>
|
|
| 742 |
+ {characters} - The characters for the series<br>
|
|
| 743 |
+ {classifications} - The other classification information for the series (genres,
|
|
| 744 |
+ warnings, etc.)<br> |
|
| 745 |
+ {parentseries} - If this series has a parent, this will be a link to the parent
|
|
| 746 |
+ series<br> |
|
| 747 |
+ {numstories} - The number of stories in the series<br>
|
|
| 748 |
+ {open} - The open status of the series <br>
|
|
| 749 |
+ {adminoptions} - The admin options for the series<br>
|
|
| 750 |
+ {addtofaves} - The link to add the series to favorites<br>
|
|
| 751 |
+ {jump} - The dropdown list of options for the series.</p>
|
|
| 752 |
+<p class="sampleLabel">Sample:</p> |
|
| 753 |
+<p class="sample"><!-- START BLOCK : series --><br> |
|
| 754 |
+ <div id="pagetitle">{pagetitle} {rating}</div><br>
|
|
| 755 |
+ <div id="titleinfo"> [{reviews} - {numreviews}]</div><br>
|
|
| 756 |
+ <div id="titleblock"><br> |
|
| 757 |
+ <span class="label">Summary:</span> {summary}<br /><br>
|
|
| 758 |
+ <span class="label">Categories:</span> {category}<br
|
|
| 759 |
+ /><br> |
|
| 760 |
+ <span class="label">Characters:</span> {characters}<br
|
|
| 761 |
+ /><br> |
|
| 762 |
+ {classifications}<br>
|
|
| 763 |
+ <span class="label">Parent Series:</span> {parentseries}<br
|
|
| 764 |
+ /><br> |
|
| 765 |
+ <span class="label">Stories:</span> {numstories}<br
|
|
| 766 |
+ /><br> |
|
| 767 |
+ <span class="label">Open Series:</span> {open}<br /><br>
|
|
| 768 |
+ <span class="label">{adminoptions}{addtofaves}<br /><br>
|
|
| 769 |
+ </div><br> |
|
| 770 |
+ <div class="jumpmenu">{jump}</div><br>
|
|
| 771 |
+ <!-- END BLOCK : series --></p> |
|
| 772 |
+<p><a name="storyindex"></a>storyindex.tpl</p> |
|
| 773 |
+<p>This template controls the story index (table of contents) for an individual |
|
| 774 |
+ story. </p> |
|
| 775 |
+<p>You will need to start by including the header block.</p> |
|
| 776 |
+<p class="sample"><!-- INCLUDE BLOCK : header --></p> |
|
| 777 |
+<p>And end by including the footer block.</p> |
|
| 778 |
+<p class="sample"> <!-- INCLUDE BLOCK : footer --></p> |
|
| 779 |
+<p>The following variables may be included in this template:</p> |
|
| 780 |
+<p>{title} - The title of the story<br>
|
|
| 781 |
+ {author} - The author(s) of the story<br>
|
|
| 782 |
+ {reviews} - A link to the reviews for the story with the word "Reviews"
|
|
| 783 |
+ as text<br> |
|
| 784 |
+ {numreviews} - A link to the reviews for the story with the number of reviews
|
|
| 785 |
+ as the text<br> |
|
| 786 |
+ {score} - The thumbs up/down or star rating for a story<br>
|
|
| 787 |
+ {jumpmenu} - The dropdown menu of chapters in the story<br>
|
|
| 788 |
+ {featuredstory} - The featured/retired icon<br>
|
|
| 789 |
+ {summary} - The summary of the story<br>
|
|
| 790 |
+ {rating} - The story's content rating<br>
|
|
| 791 |
+ {category} - The story's categories<br>
|
|
| 792 |
+ {characters} - The list of characters for the story<br>
|
|
| 793 |
+ {classifications} - The other classifications for the story (genres, warnings,
|
|
| 794 |
+ etc.)<br> |
|
| 795 |
+ {serieslinks} - The list of series to which the story belongs<br>
|
|
| 796 |
+ {numchapters} - The number of chapters in the story<br>
|
|
| 797 |
+ {completed} - Yes or No depending on the status of the story<br>
|
|
| 798 |
+ {wordcount} - The total word count for the story<br>
|
|
| 799 |
+ {count} - The read count for the story<br>
|
|
| 800 |
+ {published} - The date the story was published<br>
|
|
| 801 |
+ {updated} - The date the story was last updated<br>
|
|
| 802 |
+ {adminlinks} - The admin options for the story<br>
|
|
| 803 |
+ {addtofaves} - The option to add this story to favorites<br>
|
|
| 804 |
+ {roundrobin} - The option to contribute to the round robin<br>
|
|
| 805 |
+ {jumpmenu2} - The drop down menu of options concerning the story<br>
|
|
| 806 |
+ {reviewform} - A form to submit a review of the story<br>
|
|
| 807 |
+ {reviewslink} - A link to review the story</p>
|
|
| 808 |
+<p>In addition there are two included blocks. The first is storynotes which includes |
|
| 809 |
+ one variable {storynotes} for the story notes. The second is the storyindexblock.
|
|
| 810 |
+ The following information can be included in the storyindexblock for each chapter |
|
| 811 |
+ of the story:</p> |
|
| 812 |
+<p>{chapternumber} - The chapter number<br>
|
|
| 813 |
+ {title} - The title of the chapter<br>
|
|
| 814 |
+ {author} - The author of the chapter<br>
|
|
| 815 |
+ {reviews} - The reviews link for reviews for that chapter<br>
|
|
| 816 |
+ {numreviews} - The number of reviews that chapter has received<br>
|
|
| 817 |
+ {ratingpics} - The thumbs up/down or star rating for that chapter<br>
|
|
| 818 |
+ {wordcount} - The word count for that chapter<br>
|
|
| 819 |
+ {chapternotes} - The chapter notes for that chapter (end notes are not displayed)<br>
|
|
| 820 |
+ {adminoptions} - Admin options for that chapter</p>
|
|
| 821 |
+<p class="sampleLabel">Sample:</p> |
|
| 822 |
+<p class="sample"><!-- INCLUDE BLOCK : header --><br> |
|
| 823 |
+ <div id="pagetitle">{title} by {author}</div><br>
|
|
| 824 |
+ <div id="sort"> [{reviews} - {numreviews}] {score}{printicon}</div><br>
|
|
| 825 |
+ <div id="output"><br> |
|
| 826 |
+ <div class="jumpmenu">{jumpmenu}</div><br>
|
|
| 827 |
+ <div class="listbox"><br> |
|
| 828 |
+ <div class="content">{featuredstory}<span class="label">Summary:
|
|
| 829 |
+ </span>{summary}<br /><br>
|
|
| 830 |
+ <span class="label">Rated:</span> {rating}<br /><br>
|
|
| 831 |
+ <span class="label">Categories:</span> {category} <span
|
|
| 832 |
+ class="label">Characters: </span> {characters}<br /><br>
|
|
| 833 |
+ {classifications}<br>
|
|
| 834 |
+ <span class="label">Challenges:</span> {challengelinks}<br
|
|
| 835 |
+ /> <span class="label">Series:</span> {serieslinks}<br
|
|
| 836 |
+ /><br> |
|
| 837 |
+ <span class="label">Chapters: </span> {numchapters} <span
|
|
| 838 |
+ class="label">Completed:</span> {completed} <br />
|
|
| 839 |
+ <br> |
|
| 840 |
+ <span class="label">Word count:</span> {wordcount} <span
|
|
| 841 |
+ class="label">Read:</span> {count}<br /><br>
|
|
| 842 |
+ <span class="label"> Published: </span>{published} <span
|
|
| 843 |
+ class="label">Updated:</span> {updated} </div><br>
|
|
| 844 |
+ {adminlinks}<br>
|
|
| 845 |
+ </div><br> |
|
| 846 |
+ <div style='text-align: center;'>{addtofaves}</div><br>
|
|
| 847 |
+ <!-- START BLOCK : storynotes --><br> |
|
| 848 |
+ <div class='notes'><div class='title'><span class='label'>Story |
|
| 849 |
+ Notes:</span></div><div class='noteinfo'>{storynotes}</div></div><br>
|
|
| 850 |
+ <!-- END BLOCK : storynotes --><br> |
|
| 851 |
+ <!-- START BLOCK : storyindexblock --><br> |
|
| 852 |
+ <p><b>{chapternumber}. {title} </b>by {author} [{reviews}
|
|
| 853 |
+ - {numreviews}] {ratingpics} ({wordcount} words)<br /><br>
|
|
| 854 |
+ {chapternotes}{adminoptions}</p><br>
|
|
| 855 |
+ <!-- END BLOCK : storyindexblock --><br> |
|
| 856 |
+ <div id="pagelinks"><div class="jumpmenu">{jumpmenu2}</div></div><br>
|
|
| 857 |
+ <div class="respond">{roundrobin}</div><br>
|
|
| 858 |
+ {reviewform}<br>
|
|
| 859 |
+ </div><br> |
|
| 860 |
+ <!-- INCLUDE BLOCK : footer --> </p> |
|
| 861 |
+<p><a name="user">user.tpl</a></p> |
|
| 862 |
+<p>This page displays the user profile page. </p> |
|
| 863 |
+<p>You will need to start by including the header block.</p> |
|
| 864 |
+<p class="sample"><!-- INCLUDE BLOCK : header --></p> |
|
| 865 |
+<p>And end by including the footer block.</p> |
|
| 866 |
+<p class="sample"> <!-- INCLUDE BLOCK : footer --></p> |
|
| 867 |
+<p>In addition you will want to include the profile block as well.</p> |
|
| 868 |
+<p class="sample"><!-- INCLUDE BLOCK : profile --></p> |
|
| 869 |
+<p>The user.tpl file includes one other block used to form the "tabs" |
|
| 870 |
+ for the profile panels. You can build these tabs any way you wish. The sample |
|
| 871 |
+ below places them inside a div with each individual tab as a span. Another idea |
|
| 872 |
+ is to use an unordered list. Within this block you can use the following variables:</p> |
|
| 873 |
+<p>{class} - The class for that "tab" used to differentiate the current/active
|
|
| 874 |
+ tab from the inactive tabs.<br> |
|
| 875 |
+ {link} - The link to the tab<br>
|
|
| 876 |
+ {count} - The count of items in the tab (may be empty)<br>
|
|
| 877 |
+ {linkcount} - The link to the tab with the count of items in the tab included
|
|
| 878 |
+ in the link</p> |
|
| 879 |
+<p>In addition to these blocks, the following variables can be included:</p> |
|
| 880 |
+<p>{adminoptions} - Options regarding this member's account<br>
|
|
| 881 |
+ {sort} - Gives the sort for when displaying the user's stories.<br>
|
|
| 882 |
+ {output} - Used for various messages and errors in panels.</p>
|
|
| 883 |
+<p class="sampleLabel">Sample: </p> |
|
| 884 |
+<p class="sample"><!-- INCLUDE BLOCK : header --><br> |
|
| 885 |
+ <div id="profile"><br> |
|
| 886 |
+ <!-- INCLUDE BLOCK : profile --><br> |
|
| 887 |
+ {adminoptions}<br>
|
|
| 888 |
+ <div id="sort">{sort}</div><br>
|
|
| 889 |
+ </div><br> |
|
| 890 |
+ <div id="tabs"><br> |
|
| 891 |
+ <!-- START BLOCK : paneltabs --><br> |
|
| 892 |
+ <span {class}>{link} {count}</span><br>
|
|
| 893 |
+ <!-- END BLOCK : paneltabs --><br> |
|
| 894 |
+ <div class='cleaner' style='clear: both;'>&nbsp;</div><br> |
|
| 895 |
+ </div><br> |
|
| 896 |
+ {output}<br>
|
|
| 897 |
+ <!-- INCLUDE BLOCK : listings --><br> |
|
| 898 |
+ <!-- INCLUDE BLOCK : footer --></p> |
|
| 899 |
+<p><a name="viewstory">viewstory.tpl</a></p> |
|
| 900 |
+<p>This page displays the story/chapter text. </p> |
|
| 901 |
+<p>You will need to start by including the header block.</p> |
|
| 902 |
+<p class="sample"><!-- INCLUDE BLOCK : header --></p> |
|
| 903 |
+<p>And end by including the footer block.</p> |
|
| 904 |
+<p class="sample"> <!-- INCLUDE BLOCK : footer --></p> |
|
| 905 |
+<p>Three included blocks are used to display the story notes, chapter notes, and |
|
| 906 |
+ chapter end notes.</p> |
|
| 907 |
+<p>In addition, the following variables may be included:</p> |
|
| 908 |
+<p>{title} - The title of the story<br>
|
|
| 909 |
+ {author} - The author(s) of the story<br>
|
|
| 910 |
+ {reviews} - A link to the reviews for the story with the word "Reviews"
|
|
| 911 |
+ as text<br> |
|
| 912 |
+ {numreviews} - A link to the reviews for the story with the number of reviews
|
|
| 913 |
+ as the text<br> |
|
| 914 |
+ {score} - The thumbs up/down or star rating for a story<br>
|
|
| 915 |
+ {jumpmenu} - The dropdown menu of chapters in the story<br>
|
|
| 916 |
+ {featuredstory} - The featured/retired icon<br>
|
|
| 917 |
+ {summary} - The summary of the story<br>
|
|
| 918 |
+ {rating} - The story's content rating<br>
|
|
| 919 |
+ {category} - The story's categories<br>
|
|
| 920 |
+ {characters} - The list of characters for the story<br>
|
|
| 921 |
+ {classifications} - The other classifications for the story (genres, warnings,
|
|
| 922 |
+ etc.)<br> |
|
| 923 |
+ {serieslinks} - The list of series to which the story belongs<br>
|
|
| 924 |
+ {numchapters} - The number of chapters in the story<br>
|
|
| 925 |
+ {completed} - Yes or No depending on the status of the story<br>
|
|
| 926 |
+ {wordcount} - The total word count for the story<br>
|
|
| 927 |
+ {count} - The read count for the story<br>
|
|
| 928 |
+ {published} - The date the story was published<br>
|
|
| 929 |
+ {updated} - The date the story was last updated<br>
|
|
| 930 |
+ {adminlinks} - The admin options for the story<br>
|
|
| 931 |
+ {addtofaves} - The option to add this story to favorites<br>
|
|
| 932 |
+ {roundrobin} - The option to contribute to the round robin<br>
|
|
| 933 |
+ {jumpmenu2} - The drop down menu of options concerning the story<br>
|
|
| 934 |
+ {reviewform} - A form to submit a review of the story<br>
|
|
| 935 |
+ {reviewslink} - A link to review the story</p>
|
|
| 936 |
+<p></p> |
|
| 937 |
+<p class="sampleLabel">Sample: </p> |
|
| 938 |
+<p class="sample"><!-- INCLUDE BLOCK : header --><br> |
|
| 939 |
+ <div id="pagetitle">{title} by {author}</div><br>
|
|
| 940 |
+ <div class="storyinfo"> [{reviews} - {numreviews}]<br /><br>
|
|
| 941 |
+ {toc} {reportthis}<br /><br>
|
|
| 942 |
+ {printicon} <br /><br>
|
|
| 943 |
+ {adminlinks} </div><br>
|
|
| 944 |
+ <div class="jumpmenu">{textsizer}{jumpmenu}</div><br>
|
|
| 945 |
+ <!-- START BLOCK : storynotes --><br> |
|
| 946 |
+ <div class='notes'><br> |
|
| 947 |
+ <div class='title'><span class='label'>Story Notes:</span></div><br> |
|
| 948 |
+ <div class='noteinfo'>{storynotes}</div><br>
|
|
| 949 |
+ </div><br> |
|
| 950 |
+ <!-- END BLOCK : storynotes --><br> |
|
| 951 |
+ <!-- START BLOCK : notes --><br> |
|
| 952 |
+ <div class='notes'><div class='title'><span class='label'>Author's |
|
| 953 |
+ Chapter Notes:</span></div><div class='noteinfo'>{notes}</div></div><br>
|
|
| 954 |
+ <!-- END BLOCK : notes --><br> |
|
| 955 |
+ <div id="story">{story}</div><br>
|
|
| 956 |
+ <!-- START BLOCK : endnotes --><br> |
|
| 957 |
+ <div class='notes'><div class='title'><span class='label'>Chapter |
|
| 958 |
+ End Notes:</span></div><div class='noteinfo'>{endnotes}</div></div><br>
|
|
| 959 |
+ <!-- END BLOCK : endnotes --><br> |
|
| 960 |
+ <div id="prev">{prev}</div><div id="next">{next}</div><br>
|
|
| 961 |
+ {storyend}{last_read}<br>
|
|
| 962 |
+ <div class="jumpmenu2">{jumpmenu2}</div><br>
|
|
| 963 |
+ <div class="respond">{addtofaves} {roundrobin}</div><br>
|
|
| 964 |
+ {reviewform}<br>
|
|
| 965 |
+ <!-- INCLUDE BLOCK : footer --></p> |
|
| 966 |
+<p><br> |
|
| 967 |
+ </p> |
|
| 968 |
+<p> </p> |
|
| 969 |
+ |
|
| 970 |
+<p> </p> |
|
| 971 |
+</body> |
|
| 972 |
+ |
|
| 973 |
+</html> |
|
| 0 | 974 |
\ No newline at end of file |