| [ Index ] |
PHP Cross Reference of Nucleus CMS v3.51 code documentation |
[Summary view] [Print] [Text view]
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 2 <html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <!-- $Id: help.html 1405 2009-08-14 15:56:06Z ftruscot $ --> 5 6 <title>Nucleus Admin Help</title> 7 <style type="text/css"> 8 <!-- 9 body { 10 font-family: verdana, arial; 11 font-size: small; 12 } 13 14 h1 { 15 font-size: large; 16 border-bottom: 1px gray dashed; 17 color: #596d9d; 18 text-align: left; 19 } 20 21 h2 { 22 font-size: medium; 23 border: 1px solid #ddd; 24 background-color: whitesmoke; 25 text-align: left; 26 } 27 28 .page { 29 height: 2400px; 30 text-align: justify; 31 margin-bottom: 100px; 32 } 33 34 pre { 35 background-color: #ddd; 36 padding: 5px; 37 font-size: small; 38 } 39 40 .example { 41 background-color: #ddd; 42 padding: 5px; 43 } 44 45 ul.templates { 46 font-size: x-small; 47 line-height: 1.1; 48 list-style: none; 49 text-indent: -20px; 50 margin-left: 20px; 51 } 52 53 ul { 54 text-align: left; 55 } 56 57 a:link, a:visited { 58 color: #1D3565; 59 font-weight: bold; 60 text-decoration: underline; 61 } 62 63 a:hover { 64 background-color: whitesmoke; 65 } 66 67 .deprecated { 68 border: 3px solid red; 69 padding: 5px; 70 font-size: medium; 71 } 72 73 tt, code { 74 font-size: small; 75 } 76 77 table { 78 border: 1px solid #ccc; 79 } 80 81 th { 82 background-color: #eee; 83 } 84 85 td { 86 vertical-align: top; 87 } 88 89 .note { 90 background-color: #eee; 91 padding: 5px; 92 } 93 --> 94 </style> 95 </head> 96 <body> 97 98 <div class="page"> 99 <h1>Nucleus Popup Help</h1> 100 <p>Please hold on while the page is being downloaded (about 100KB).</p> 101 </div> 102 103 104 <div class="page"> 105 <a name="future"></a> 106 <a name="allowpastposting"></a> 107 <h1>Add Later/Earlier</h1> 108 <h2>Add Later</h2> 109 <p>The 'Add Later' option on add-item forms allows you to mark an item to become visible only at the exact time you've specified. Before that time has come, the item will not be viewable anywhere in the public part of your site.</p> 110 <p>This date <strong>must</strong> be in the future, unless the 'Allow posting to the past' option is enabled for the blog to which you want to add the item.</p> 111 <h2>Allow posting to the past</h2> 112 <p>When enabled, you'll be allowed to specify the date on which an item should be added, and to edit the timestamp of already existing items.</p> 113 </div> 114 115 <div class="page"><a name="changedate"></a> 116 <h1>Change post date/time</h1> 117 <p> 118 The 'Update Timestamp' option allows you to change the posting date and/or time of an item. If you changed the content of an item, this is a way bring the story back to the top of your front page.</p> 119 <p>But, the unique id connected to the item will not change, so your visitors can still find out that the item was originally posted later than items with a lower id.</p> 120 </div> 121 122 123 <div class="page"><a name="autosave"></a> 124 <h1>Autosave</h1> 125 <p>The Autosave function saves an item as a <a href="#draft">draft</a> after 10 minutes editing. It should avoid that unsaved changes get lost. It is usefull for users that work for a long time on an item and often forget to save their work.</p> 126 <p>If you want to invoke Autosave before the 10 minutes are past, you can press the '<strong>Auto save now</strong>' button at the end of the form.</p> 127 <p>The Autosave function can be enabled and disabled in the member options.</p> 128 </div> 129 130 131 <div class="page"><a name="draft"></a> 132 <h1>Drafts</h1> 133 <p> 134 Draft items are not yet viewable in the public blog. They might come in handy when you are working on a story, and something comes in between. Your draft items will be listed on the main page, so you can continue your work when you have the time to do so.</p> 135 <p>When editing drafts, choose the '<strong>Add now</strong>' radiobutton and hit the 'Edit item' button to make them visible. 136 </p> 137 </div> 138 139 <div class="page"><a name="extended"></a> 140 <h1>Extended part</h1> 141 <p> 142 Items have an optional extended part that you can use for continued stories. e.g. when a story is too long to put on the main page of your blog, you can write an introduction in the body part and the rest in the extended part. When viewing your main blog page, you will then see 'read more' links (as defined by the templates). 143 </p> 144 <p> 145 If you want to write an introduction only for <em>some</em> of your items, you could use the <a href="#templatevar-smartbody">smartbody</a> template variable to make a selection out of the body text and the extended text. 146 </p> 147 </div> 148 149 <div class="page"><a name="shortblogname"></a> 150 <h1>Short Blog Name</h1> 151 <p> 152 The short blog name is used mainly in the admin area to indicate which items are associated with which blog. 153 </p> 154 <p> 155 It can also be used in alternative index files, to make a second weblog available: 156 </p> 157 <pre> 158 <? 159 include ('./config.php'); 160 selectBlog('myshortblogname'); 161 selector(); 162 ?> 163 </pre> 164 </div> 165 166 <div class="page"><a name="blogdefaultskin"></a> 167 <h1>Default Skin</h1> 168 <p> 169 The default skin selected in the blog settings is the skin that should be used when the blog is displayed, and there is no other skin selected (through arguments in the URL) 170 </p> 171 </div> 172 173 174 <div class="page"><a name="blognotify"></a> 175 <h1>Notify Address</h1> 176 <p> 177 This option contains one or multiple e-mail addresses to which notification e-mails should be sent when new comments are added. Leave empty if you don't want notification. The given e-mail addresses must, of course, be valid. 178 </p> 179 <p> 180 If you're using multiple addresses, you should use a semicolon (<strong>;</strong>) as a separator. 181 </p> 182 <div class="note"> 183 <b>Note:</b> As the maximum length of the settings fields is 128 characters, there's only a limited amount of e-mail addresses you can list. 184 </div> 185 <div class="note"> 186 <b>Note:</b> When you set up your own e-mail address as notification address, you won't get notified of the items/comments that you wrote yourself. Assuming that you know what you wrote, that shouldn't be a problem. 187 </div> 188 </div> 189 190 <div class="page"><a name="blogmaxcomments"></a> 191 <h1>Max Amount of Comments</h1> 192 <p> 193 This is the maximum number of comments that will be shown on the <em>main page</em>. <strong>This is NOT a restriction on the total number of comments that can be made</strong>. On the detail pages, all comments will be shown, even if there are more than the maximum amount chosen. 194 </p> 195 <p class="note"><strong>Note:</strong> 196 Inside templates, this variable can be overridden by an optional parameter of the <a href="#templatevar-comments">comments</a> templatevar. 197 </p> 198 </div> 199 200 <div class="page"><a name="blogtimeoffset"></a> 201 <h1>Time Offset</h1> 202 <p> 203 If the time on your server is not equal to the time where you live, you might want to add an offset to the server time in order to get the correct time. Use negative values to subtract (negation sign). The current server time is listed as a reference. 204 </p> 205 <h2>Example</h2> 206 <p>If your local time is 20:35 and the server time is listed as 14:35, you'll need to set the time offset equal to 6 in order to get your blog time to 20:35 207 </p> 208 <p class="note"><strong>Note:</strong> Fractional offsets can be used as well, for people living in half time zones. e.g. an offset of <strong>1.5</strong> equals an offset of 1 hour and 30 minutes.</p> 209 </div> 210 211 <div class="page"><a name="blogupdatefile"></a> 212 <h1>Update File</h1> 213 <p> 214 Nucleus can edit a file for you whenever a new item is added to the blog. The contents of that file will be a timestamp of the last change. The use of such a file could be useful for services which check a file on your server once in a while to see if there were updates, and generate 'updated weblogs' from that. Pointing them to your main blog could cause false update warnings to be sent out when visitors add comments or when you change something to the skins or templates. 215 </p> 216 <p> 217 When you don't need an update file, just leave the field empty. 218 </p> 219 <p> 220 Please note that the location of the update file is relative to the admin-area, so you might want to use an absolute path (something like <tt>/path/to/your/website/update.txt</tt>). Also make sure the update file already exists and is writable (<a href="tips.html#filepermissions" onclick="window.open(this.href);return false;" class="out" title="quick guide on changing file permissions">chmod it to 666</a> if you want to be sure). 221 </p> 222 </div> 223 224 <div class="page"><a name="teamadmin"></a> 225 <h1>Blog Admin</h1> 226 <p> 227 Blog administrators have the following extra rights: 228 </p> 229 230 <ul> 231 <li>They can manage the team</li> 232 <li>They can edit blog settings</li> 233 <li>They can edit/delete all items by all authors (from the blog of which they are admin)</li> 234 <li>They can delete the blog</li> 235 </ul> 236 237 <p> 238 A blog can have multiple admins, but there must be at least one admin at all times. 239 </p> 240 </div> 241 242 243 <div class="page"><a name="superadmin"></a> 244 <h1>Administrator Privileges</h1> 245 246 <p> 247 A so called <em>super-admin</em> has <strong>full access</strong> to all functions and all weblogs, even if she is not on the blog team. 248 </p> 249 250 <p> 251 On top of that: a super-admin has the right to create new weblogs, to change general settings, to change templates, to change skins and to manage the members (creation/ manipulation/ deletion of members). 252 </p> 253 254 <p> 255 Usually, there will be only one super-admin, the site administrator. 256 </p> 257 258 </div> 259 260 <div class="page"><a name="canlogin"></a> 261 <h1>Can Login?</h1> 262 <p> 263 As a <a href="#superadmin" title="Administrator Privileges">superadmin</a>, you can disallow individual members to login to the admin area. 264 </p> 265 </div> 266 267 <div class="page"><a name="defaultblog"></a> 268 <h1>Default Blog</h1> 269 <p> 270 This is the blog that will be used when no other blog has been specified in the request. 271 </p> 272 </div> 273 274 <div class="page"><a name="baseskin"></a> 275 <h1>Base Skin</h1> 276 277 <p>The option tells Nucleus which skin to fall back to when no such decision can be automatically made. This happens when skin parts are empty, when no blog or skin is implicitly/explicitly selected.</p> 278 <p>Most users don't need to worry about this setting.</p> 279 </div> 280 281 <div class="page"><a name="cookies"></a> 282 <h1>Cookies</h1> 283 284 <h2>Cookie Lifetime</h2> 285 <p> 286 When a member logs in, a cookie is stored in his browser, so she doesn't need to log in again when she comes back the next day. The lifetime of this cookie decided when it will become invalid:</p> 287 <ul> 288 <li><strong>Session cookies</strong> get deleted when you exit the browser</li> 289 <li>Cookies with a lifetime of <strong>one month</strong> will stay on the computer until you don't use/visit the site for a month. Using this option, you'll never have to login again (unless you've logged out yourself, or logged in from another computer)</li> 290 </ul> 291 292 <h2>Cookie Path & Cookie Domain</h2> 293 <p> 294 These settings are advanced settings. Normally, you shouldn't change them at all. In that case, cookie path is a simple slash ('/') and cookie domain is empty. 295 </p> 296 297 <h2>Secure Cookies</h2> 298 <p> 299 Normally, this should be set to 'no'. You should only set it to 'yes' when you have a HTTPS url and want cookies only to be sent over such a https connection. 300 </p> 301 302 <h2>'Last Visit' Cookie</h2> 303 <p> 304 You can setup Nucleus to store a cookie in which the time of the visitors last visit is stored. This can be used to put indications next to <a href="#templatenew">new items</a> 305 </p> 306 307 </div> 308 309 310 <div class="page"><a name="language"></a> 311 <h1>Language</h1> 312 <p> 313 You can choose a language to be used when nucleus creates content for you. The content generated by Nucleus includes the admin-area, the error messages, forms in skins, ... 314 </p> 315 316 <p> 317 There are two places where a language can be chosen: the global site settings include a language option. 318 Next to that, logged in members can override this setting if they want to. 319 </p> 320 321 <p> 322 When both of these settings are invalid, 'english' is used as the default language. 323 </p> 324 325 <p class="note"><strong>Note:</strong> Extra language files can be downloaded from the <a href="http://www.nucleuscms.org/" onclick="window.open(this.href);return false;" class="out" title="Nucleus CMS Website">Nucleus Website</a>. (opens a new window)</p> 326 327 </div> 328 329 <div class="page"><a name="allowaccountcreation"></a> 330 <h1>Account Creation</h1> 331 <p> 332 You can either allow or disallow your visitors to create their own 'member' account. They won't be allowed to add items to a blog (unless the admin adds them to a team), but they can login to the administration area and change their settings, and even delete or modify the comments they made. 333 </p> 334 </div> 335 336 <div class="page"><a name="allownewmemberlogin"></a> 337 <h1>New Member: can login ?</h1> 338 <p> 339 When you allow <a href="#allowaccountcreation">creation of member accounts</a> by your visitors, this setting defines whether or not accounts created in that way will have the ability to <a href="#canlogin">login to the administration area</a>. 340 </p> 341 </div> 342 343 344 <div class="page"><a name="messageservice"></a> 345 <h1>Message Service</h1> 346 347 <p> 348 For the privacy of your members, you can hide all e-mail addresses and allow members to send an e-mail message to each other through the script. The message that will be sent out will however contain the e-mail addresses of both users, so they can then do continued communication through regular e-mail. This service can be disabled. 349 </p> 350 351 <h2>Non-members</h2> 352 <p> 353 By default, non members cannot use the message service (because there's no way to check the validity of the e-mail address they enter). You can relax this restriction by allowing non-members to use the message service too. When submitting a message, they will be asked to enter their e-mail address, which will show up in the <tt>From:</tt> headers of the e-mail you receive. 354 </p> 355 356 </div> 357 358 <div class="page"><a name="disablesite"></a> 359 <h1>Disable Site</h1> 360 <p> 361 It's possible to disable your entire Nucleus site. You might want to do this when you are doing some configuration, or when something went horribly wrong :-) 362 </p> 363 <p> 364 The URL that needs to be configured is an URL to which the visitor will be redirected. 365 </p> 366 <p> 367 Exceptions: the <strong>admin-area</strong> is still available, and <strong><a href="#superadmin">super-admins</a></strong> can still see the entire site. (don't forget to re-enable your site afterwards ;-)) 368 </p> 369 </div> 370 371 372 <div class="page"><a name="urlmode"></a> 373 <h1>URL Mode</h1> 374 <p>Using this option, you can switch between URL styles:</p> 375 <ul> 376 <li><strong>Normal</strong>: URLs looking like <code>http://host/index.php?itemid=1234</code></li> 377 <li><strong>Fancy</strong>: URLs looking like <code>http://host/item/1234</code></li> 378 </ul> 379 <p class="note"><strong>Note:</strong> In order to get the 'Fancy URL' mode working, some extra actions are required. They're described in the <a href="tips.html" class="out" onclick="window.open(this.href);return false;">Tips & Suggestions</a> (opens in new window)</p> 380 381 </div> 382 383 <div class="page"><a name="defaultlistsize"></a> 384 <h1>Default List Size</h1> 385 <p>(3.40) Using this option, you can set the default size of lists in the Admin Area. Value should be an integer. 10 is a good default for most users.</p> 386 </div> 387 388 <div class="page"><a name="debugvars"></a> 389 <h1>Debug Vars</h1> 390 <p>(3.40) Using this option, you can set whether unresolved Vars (SkinVars, TemplateVars, ItemVars) are shown on the blog. Default is <code>No</code>.</p> 391 </div> 392 393 <div class="page"><a name="templateitems"></a> 394 <h1>Templates: Items</h1> 395 <p> 396 When items are shown, the following setup is repeated for each item: 397 </p> 398 399 <pre> 400 item header 401 item body 402 item footer 403 </pre> 404 405 <p>These three blocks all refer to a template-part, which define what the result looks like.</p> 406 407 <h2>Variables</h2> 408 409 <p>Within these template, a series of so called <a href="#templatevars-overview" title="Find out which variables are available">template variables can be used</a> to insert item data.</p> 410 411 <h2>Example</h2> 412 <p><a href="#templateitemsexample">An example</a></p> 413 414 </div> 415 416 <div class="page"><a name="templateitemsexample"></a> 417 <h1>Templates: Items</h1> 418 <p> 419 An example for the <b>item body</b> template: 420 </p> 421 422 <pre><h1><%title%></h1> 423 424 <p><%body%></p> 425 426 <div class="metadata"> 427 <a href="<%itemlink%>">link</a> - 428 <%date%> <%time%> - 429 <a href="<%authorlink%>"><%author%></a> - 430 <%comments%> 431 </div></pre> 432 433 <p>The result would become something like this:</p> 434 435 <div class="example"> 436 <h4 style="margin: 2px;">This is an item</h4> 437 <p style="margin: 2px; padding: 0px;">This is the text for the item</p> 438 <div style="font-style: italic; margin: 2px;"> 439 <a href="#templateitemsexample">link</a> - 440 August 8th 2002 18:51 - 441 <a href="#templateitemsexample">karma</a> - 442 <a href="#templateitemsexample">no comments</a> 443 </div> 444 </div> 445 446 </div> 447 448 449 <div class="page"><a name="templatecomments"></a> 450 <h1>Templates: comments</h1> 451 452 <p>There are three possible structures for a comments block.</p> 453 454 <ol> 455 <li> 456 When comments are displayed (like on detail pages, or on the main page when there are less than the maximum allowed amount of comments) 457 <pre>comments header 458 comments body (repeated) 459 comments footer</pre> 460 </li> 461 <li> 462 When there are no comments at all 463 <pre> 464 no comments 465 </pre> 466 </li> 467 <li> 468 When there are comments, but there are more than the maximum allowed number. (only applies when not on a detailed item page) 469 <pre> 470 too much comments 471 </pre> 472 </li> 473 </ol> 474 475 <p>Inside these template-parts, some <a href="#templatevars-comments" title="Overview of comments-related template variables">comments-related variables</a> are available</p> 476 477 </div> 478 479 <div class="page"> 480 <a name="templatecommentheaders"></a> 481 <a name="templatecommentfooters"></a> 482 <h1>Templates: Comment headers/footers</h1> 483 484 <h2>Description</h2> 485 486 <p>While the comments-body is repeated for each comment, the header and footer are only displayed once. A typicall structure would look like this:</p> 487 <pre>comments header 488 comments body 1 489 comments body 2 490 comments body 3 491 comments footer</pre> 492 <p>In these template-parts, <a href="#templatevars-comments" title="Overview of comments-related template variables">comments-related templatevars</a> are available</p> 493 494 <h2>Examples</h2> 495 496 <p>Header:</p> 497 <pre><ul></pre> 498 <p>Body:</p> 499 <pre><li><%user%>: <%body%></li></pre> 500 <p>Footer</p> 501 <pre></ul></pre> 502 <p>Result</p> 503 504 <ul class="example"> 505 <li>karma: nice!</li> 506 <li>xiffy: yes indeed!</li> 507 </ul> 508 509 </div> 510 511 <div class="page"><a name="templatemorelink"></a> 512 <h1>Templates: Link to extended entry</h1> 513 <p> 514 This is the template that will be used to format the <a href="#templatevar-morelink">morelink templatevar</a> that is available in the item templates. <a href="#templatevars-overview">Available variables</a> are the same as in the item templates. 515 </p> 516 <p> 517 When there's no extended part of the item, the <code><%morelink%></code> templatevar will have no effect. 518 </p> 519 520 <h2>Example</h2> 521 <pre><code><a href="<%itemlink%>">[Read More!]</a></code></pre> 522 523 </div> 524 525 <div class="page"><a name="templatearchivelists"></a> 526 527 <h1>Templates: Archive Lists</h1> 528 529 <p>The archive lists are formatted as listed below:</p> 530 531 <pre>archivelist header 532 archivelist listitem (repeated for each archive) 533 archivelist footer</pre> 534 535 <p> 536 Available variables: (in the header and footer, only <tt>blogid</tt> is allowed) 537 </p> 538 539 <table><tr> 540 <th>Name</th> 541 <th>Description</th> 542 </tr><tr> 543 <td>blogid</td> 544 <td>ID of the weblog</td> 545 </tr><tr> 546 <td>archivelink</td> 547 <td>link to the archive, which you can embed in a <code><a href=".."></code> tag.</td> 548 </tr><tr> 549 <td>month</td> 550 <td>Number of the month (2 digits: 01-12)</td> 551 </tr><tr> 552 <td>year</td> 553 <td>Year (4 digits)</td> 554 </tr><tr> 555 <td>day</td> 556 <td>Day of month (2 digits; only when in day mode)</td> 557 </tr></table> 558 559 <p>A more flexible way to add the date of the archive to the listitem, is to use <a href="#strftime">strftime</a> variables. If you find this too complicated, use the following:</p> 560 561 <pre><code><a href="<%archivelink%>">%B, %Y</a><br /></code></pre> 562 563 564 <p>To change the language to your local settings, change the <a href="#templatelocale">locale</a>.</p> 565 566 </div> 567 568 569 570 571 <div class="page"><a name="templatecategorylists"></a> 572 <h1>Templates: Category Lists</h1> 573 574 <p>The category lists are formatted as listed below:</p> 575 576 <pre>categorylist header 577 categorylist listitem (repeated) 578 categorylist footer</pre> 579 580 <p>Available variables: (in the header and footer, only <tt>blogid</tt>, <tt>blogurl</tt> and <tt>self</tt> are allowed)</p> 581 582 <table><tr> 583 <th>Name</th> 584 <th>Description</th> 585 </tr><tr> 586 <td>blogid</td> 587 <td>ID of the weblog</td> 588 </tr><tr> 589 <td>blogurl</td> 590 <td>URL of the blog (as defined in blogsettings)</td> 591 </tr><tr> 592 <td>self</td> 593 <td>Current page, without parameters (e.g. <tt>index.php</tt>)</td> 594 </tr><tr> 595 <td>catlink</td> 596 <td>a link to the most recent items for a category, which you can embed in a <a href=".."> tag.</td> 597 </tr><tr> 598 <td>catid</td> 599 <td>Category ID</td> 600 </tr><tr> 601 <td>catname</td> 602 <td>Category name</td> 603 </tr><tr> 604 <td>catdesc</td> 605 <td>Category description</td> 606 </tr><tr> 607 <td>catiscurrent</td> 608 <td>yes if category is currently selected, no if it is not. Useful to style current category.</td> 609 </tr><tr> 610 <td>currentcat</td> 611 <td>Synonym of catiscurrent</td> 612 </tr></table> 613 614 <p><a href="#categorylistexample">View an example</a></p> 615 616 </div> 617 618 <div class="page"><a name="categorylistexample"></a> 619 <h1>Templates: Category Lists Example</h1> 620 <p> 621 <a href="#templatecategorylists">(go back)</a> 622 </p> 623 624 <h2>Header</h2> 625 <pre><code><ul> 626 <li><a href="<blogurl%>">All</a></li></code></pre> 627 628 <h2>List Item</h2> 629 <pre><code><li><a href="<%catlink%>"><%catname%></a></li></code></pre> 630 631 <h2>Footer</h2> 632 <pre><code></ul></code></pre> 633 634 <h2>Results in:</h2> 635 636 <ul class="example"> 637 <li><a href="#categorylistexample">All</a></li> 638 <li><a href="#categorylistexample">myCategory</a></li> 639 <li><a href="#categorylistexample">yourCategory</a></li> 640 </ul> 641 642 </div> 643 644 <div class="page"><a name="templatebloglists"></a> 645 <h1>Templates: Blog Lists</h1> 646 647 <p>The blog lists are formatted as listed below:</p> 648 649 <pre>bloglist header 650 bloglist listitem (repeated) 651 bloglist footer</pre> 652 653 <p>Available variables in list item field: </p> 654 655 <table><tr> 656 <th>Name</th> 657 <th>Description</th> 658 </tr><tr> 659 <td>bloglink</td> 660 <td>URL of the blog (as generated by createBlogIdLink() function)</td> 661 </tr><tr> 662 <td>blogurl</td> 663 <td>URL of the blog (as defined in blogsettings)</td> 664 </tr><tr> 665 <td>blogdesc</td> 666 <td>Description of the blog</td> 667 </tr><tr> 668 <td>blogname</td> 669 <td>Name of the blog (either full or short, depending on skinvar parameter).</td> 670 </tr></table> 671 672 <p>Available variables in header and footer fields: </p> 673 674 <table><tr> 675 <th>Name</th> 676 <th>Description</th> 677 </tr><tr> 678 <td>siteurl</td> 679 <td>URL of the site (as defined in global settings)</td> 680 </tr><tr> 681 <td>sitename</td> 682 <td>Name of the site (as defined in global settings).</td> 683 </tr></table> 684 685 <p><a href="#bloglistexample">View an example</a></p> 686 687 </div> 688 689 <div class="page"><a name="bloglistexample"></a> 690 <h1>Templates: Blog Lists Example</h1> 691 <p> 692 <a href="#templatebloglists">(go back)</a> 693 </p> 694 695 <h2>Header</h2> 696 <pre><code><ul> 697 <li><a href="<siteurl%>"><sitename%></a></li></code></pre> 698 699 <h2>List Item</h2> 700 <pre><code><li><a href="<%bloglink%>"><%blogname%></a></li></code></pre> 701 702 <h2>Footer</h2> 703 <pre><code></ul></code></pre> 704 705 <h2>Results in:</h2> 706 707 <ul class="example"> 708 <li><a href="#bloglistexample">My Site</a></li> 709 <li><a href="#bloglistexample">mainblog</a></li> 710 <li><a href="#bloglistexample">newsblog</a></li> 711 </ul> 712 713 </div> 714 715 716 717 718 719 720 721 <div class="page"><a name="templatelocale"></a> 722 <h1>Templates: Locale</h1> 723 <p> 724 This is actually not a template-part, it's a setting. Setting it allows the date and time preferences when to be localized. Names of months and days will be in the desired language, etc. 725 </p> 726 727 <p> 728 The possible values depend according to which machine Nucleus is running on. Some possible values are 729 </p> 730 731 <ul> 732 <li><strong>en</strong>: English</li> 733 <li><strong>dutch</strong>: Dutch</li> 734 <li>...</li> 735 </ul> 736 737 <p> 738 More info in the <a href="http://www.opengroup.org/onlinepubs/7908799/xsh/strftime.html" onclick="window.open(this.href);return false;" class="out" title="Open Group specification">Open Group Specification</a> for strftime. (opens a new window) 739 </p> 740 741 <p> 742 The locale is used for the <a href="#templatedatetime">date and time format</a>, for the <a href="#templatedateheads">dateheaders</a>, and for the <a href="#templatearchivelists">archivelist items</a> 743 </p> 744 745 </div> 746 747 <div class="page"><a name="templatedatetime"></a> 748 <h1>Templates: Date and Time formats</h1> 749 <p> 750 These are used to format dates and times into the <code><%date%></code> and <code><%time%></code> vars (see <a href="#templatevars-overview">template vars</a>). The formatting is done according to the <a href="#templatelocale">locale</a> 751 </p> 752 753 <p> 754 <a href="#strftime">More info on the available vars</a>. If want to get started quickly, use "%x" to format the date and "%X" to format the time. 755 </p> 756 757 </div> 758 759 <div class="page"><a name="templatedateheads"></a> 760 <h1>Template: Date headers/footers</h1> 761 762 <p> 763 The date header and date footer can contain date and time vars. <a href="#strftime">More info on the available vars</a>. If you want to get started quickly, use "%x" to format the date. The language which is used to format the date, is determined by the <a href="#templatelocale">locale-setting</a> in the template.</p> 764 765 <p> 766 In the date header, the template variable <%%daylink%%> is allowed to insert a link to the archive for that day. <strong>Note the double '%'! It's necessary to avoid %d to be expanded as the current day of the month.</strong> Also, if you just want to add a '%' character somewhere, you should also put it twice ('%%') or it will be gone on your website. 767 </p> 768 769 <p> 770 Sample for date header: 771 </p> 772 773 <pre> 774 <div class="day"> 775 <h1>%d %B</h1> 776 </pre> 777 778 <p> 779 Sample for date footer: 780 </p> 781 782 <pre> 783 </div> 784 </pre> 785 786 <p>And another example for the date head using daylink</p> 787 788 <pre> 789 <div class="day"> 790 <h1>%d %B</h1> 791 <a href="<%%daylink%%>">(archive)</a> 792 </pre> 793 794 </div> 795 796 <div class="page"><a name="templatehighlight"></a> 797 <h1>Templates: Highlight</h1> 798 <p> 799 The highlighting is used when performing searches. This is actually used in a regular expression, so you might want to escape some characters by putting a backslash before them. The place where the highlighted word will come, is indicated by "\0". 800 </p> 801 802 <h2>Example</h2> 803 804 <pre><code><span style='background-color:yellow'>\0</span></code></pre> 805 806 </div> 807 808 <div class="page"><a name="templatenothingfound"></a> 809 <h1>Templates: nothing found</h1> 810 811 <p> 812 Shown when a search has been performed and no results were found. 813 </p> 814 815 <p>Available variables:</p> 816 817 <table><tr> 818 <th>Name</th> 819 <th>Description</th> 820 </tr><tr> 821 <td>blogid</td> 822 <td>ID of the weblog</td> 823 </tr><tr> 824 <td>query</td> 825 <td>the query that was used in the search</td> 826 </tr></table> 827 828 <h2>Example</h2> 829 830 <pre><code>No search results found for <b><%query%></b></code></pre> 831 832 </div> 833 834 <div class="page"><a name="templatecommentbody"></a> 835 <h1>Templates: Comment body</h1> 836 <p> 837 This is the part of the template used to display a single comment. In this template-part, <a href="#templatevars-comments" title="Overview of comments-related template variables">comments-related templatevars</a> are available.</p> 838 839 <h2>Example</h2> 840 <pre><code><h2>Comment by <%userlink%>:</h2> 841 842 <p><%body%></p> 843 844 <div class="metadata"> 845 (from <%host%> on <%date%> at <%time%>) 846 </div></code></pre> 847 848 <p>Result:</p> 849 850 <div class="example"> 851 <h4 style="margin: 2px;">Comment by <a href="#templatecommentbody">karma</a>:</h4> 852 <p style="margin: 2px;">Nice!</p> 853 <div style="margin:2px;font-size:smaller;">(from host.example.org on 2003-03-02 at 13:30)</div> 854 </div> 855 856 </div> 857 858 <div class="page"><a name="templatepopups"></a> 859 <h1>Templates: Media & Popups</h1> 860 <p> 861 These templates are used to format links to popup image windows and media objects (non-pictures). The available variables for each of the templates are described below 862 </p> 863 864 <h2>Popup Link Code</h2> 865 866 <table><tr> 867 <th>Name</th> 868 <th>Description</th> 869 </tr><tr> 870 <td>popuplink</td> 871 <td>an <a href... link ready to use</td> 872 </tr><tr> 873 <td>rawpopuplink</td> 874 <td>only the url inside href="..."</td> 875 </tr><tr> 876 <td>popupcode</td> 877 <td>javascript code to open window</td> 878 </tr><tr> 879 <td>text</td> 880 <td>the alternate text (link text)</td> 881 </tr><tr> 882 <td>width</td> 883 <td>image width</td> 884 </tr><tr> 885 <td>height</td> 886 <td>image width</td> 887 </tr><tr> 888 <td>popuptext</td> 889 <td>(=same as text)</td> 890 </tr><tr> 891 <td>link</td> 892 <td>direct link to the image (URL)</td> 893 </tr><tr> 894 <td>media</td> 895 <td>a non-popup A-tag to the image, ready to use.</td> 896 </tr></table> 897 898 899 <h2>Inline Image Code</h2> 900 901 <table><tr> 902 <th>Name</th> 903 <th>Description</th> 904 </tr><tr> 905 <td>image</td> 906 <td>an IMG-tag, ready to use</td> 907 </tr><tr> 908 <td>link</td> 909 <td>direct link to the image (URL)</td> 910 </tr><tr> 911 <td>text</td> 912 <td>the alternate text (link text)</td> 913 </tr><tr> 914 <td>width</td> 915 <td>image width</td> 916 </tr><tr> 917 <td>height</td> 918 <td>image width</td> 919 </tr><tr> 920 <td>media</td> 921 <td>an A-tag to the image, ready to use.</td> 922 </tr></table> 923 924 <h2>Media Object Link Code</h2> 925 926 <table><tr> 927 <th>Name</th> 928 <th>Description</th> 929 </tr><tr> 930 <td>media</td> 931 <td>an A-tag, ready to use</td> 932 </tr><tr> 933 <td>link</td> 934 <td>direct link to the file (URL)</td> 935 </tr><tr> 936 <td>text</td> 937 <td>the alternate text (link text)</td> 938 </tr></table> 939 940 </div> 941 942 <div class="page"><a name="templatememberextra"></a> 943 <h1>Templates: Member Extra</h1> 944 <p> 945 This is a template you can use to add an extra indication that a comment-author is a member. It ends up in the <code><%authtext%></code> variable for use in the <a href="#templatecommentbody">comment body</a> 946 </p> 947 948 <p>Inside this template-part, some <a href="#templatevars-comments" title="Overview of comments-related template variables">comments-related variables</a> are available.</p> 949 950 </div> 951 952 <div class="page"><a name="templatecommentcontinued"></a> 953 <h1>Templates: Comments Read More</h1> 954 <p> 955 This is the format of the link that will be added at the end of <code><%short%></code>, which is a variable for use in the <a href="#templatecommentbody">comment body</a> 956 </p> 957 958 <p>Inside this template-part, some <a href="#templatevars-comments" title="Overview of comments-related template variables">comments-related variables</a> are available (except for the <code><%short%></code> variable).</p> 959 960 <p>Example:</p> 961 962 <pre> 963 <a href="<%itemlink%>">[more]</a> 964 </pre> 965 966 </div> 967 968 <div class="page"><a name="templatecommentwords"></a> 969 <h1>Templates: commentword</h1> 970 <p> 971 Most likely, you'll rather want to write "1 comment" than "1 comment(s)". The "One comment" and "Many comments" template parts can be used for this purpose. They will be used to fill the <code><%commentword%></code> variable that you can use elsewhere. 972 </p> 973 974 <p> 975 If there is only 1 comment, <code><%commentword%></code> will be equal to the contents of the "one comment" part. If there are many comments (more than one), <code><%commentword%></code> will be equal to the contents of the "two (or more) comments" part. 976 </p> 977 978 <p> 979 Typical values are "comment" and "comments". <strong>No special variables can be used here</strong>. 980 </p> 981 </div> 982 983 984 985 <div class="page"><a name="templateeditlink"></a> 986 <h1>Templates: Edit Link</h1> 987 <p> 988 This template defines how the <a href="#templatevar-edit">edit-templatevar</a> will be marked up. You can use any of the <a href="#templatevars-overview">template variables</a> here. 989 </p> 990 991 <h2>Example:</h2> 992 993 <pre><code><a href="<%editlink%>" 994 onclick="<%editpopupcode%>">edit</a></code></pre> 995 996 </div> 997 998 999 1000 1001 <div class="page"><a name="skinpartindex"></a> 1002 <h1>Skins: Main Index</h1> 1003 <p> 1004 This skinpart is used to show the most recent entries of your weblog. It's usually the home page of your site. 1005 </p> 1006 1007 <p> 1008 Very basic buildup for a main index: 1009 </p> 1010 1011 <pre> 1012 <html> 1013 <head> 1014 <title>My Weblog</title> 1015 </head> 1016 <body> 1017 1018 <h1>My Weblog</h1> 1019 <%blog(mytemplate,20)%> 1020 1021 </body> 1022 </html> 1023 </pre> 1024 1025 <p> 1026 This will show the 20 most recent items of the default weblog (unless overridden), using the 'mytemplate' template. 1027 </p> 1028 </div> 1029 1030 1031 <div class="page"><a name="skinpartitem"></a> 1032 <h1>Skins: Detail Pages</h1> 1033 <p> 1034 These pages are used to show the full items, all comments that were made and a form to add comments. 1035 </p> 1036 1037 <p> 1038 Very basic buildup for a detailed item page: 1039 </p> 1040 1041 <pre> 1042 <html> 1043 <head> 1044 <title>My Weblog :: Item</title> 1045 </head> 1046 <body> 1047 1048 <h1>Item</h1> 1049 <%item(detailed)%> 1050 1051 <h1>Comments</h1> 1052 <%comments(detailed)%> 1053 1054 <h1>Add Comment</h1> 1055 <%commentform%> 1056 1057 </body> 1058 </html> 1059 </pre> 1060 1061 <p> 1062 This will show the item and comments using the 'detailed' template, and add a standard commentform. 1063 </p> 1064 1065 1066 </div> 1067 1068 <div class="page"><a name="skinpartarchivelist"></a> 1069 <h1>Skins: Archive List</h1> 1070 <p> 1071 An overview of all the months for which archives are available, and links to those archives 1072 </p> 1073 1074 <p> 1075 Very basic buildup for an archive list: 1076 </p> 1077 1078 <pre> 1079 <html> 1080 <head> 1081 <title>My Weblog :: Archives</title> 1082 </head> 1083 <body> 1084 1085 <h1>Archives</h1> 1086 <%archivelist(default)%> 1087 1088 </body> 1089 </html> 1090 </pre> 1091 1092 <p> 1093 This will show the list of all available archive files, using the 'default' template 1094 </p> 1095 1096 </div> 1097 1098 <div class="page"><a name="skinpartarchive"></a> 1099 <h1>Skins: Archive</h1> 1100 <p> 1101 An archive for one month. Behaves like a main index, but shows all the items from a certain month. 1102 </p> 1103 1104 <p> 1105 Very basic buildup for an archive page: 1106 </p> 1107 1108 <pre> 1109 <html> 1110 <head> 1111 <title>My Weblog :: Archive</title> 1112 </head> 1113 <body> 1114 1115 <h1>Archive</h1> 1116 <%archive(default)%> 1117 1118 </body> 1119 </html> 1120 </pre> 1121 1122 <p> 1123 This will show the requested archive using the 'default' template 1124 </p> 1125 1126 1127 </div> 1128 1129 1130 <div class="page"><a name="skinpartsearch"></a> 1131 <h1>Skins: Search</h1> 1132 <p> 1133 Used to show search results. 1134 </p> 1135 1136 <p> 1137 Very basic buildup for a searchresults page: 1138 </p> 1139 1140 <pre> 1141 <html> 1142 <head> 1143 <title>My Weblog :: Search</title> 1144 </head> 1145 <body> 1146 1147 <h1>Search</h1> 1148 <%searchform%> 1149 1150 <h1>Searchresults</h1> 1151 <%searchresults(default)%> 1152 1153 </body> 1154 </html> 1155 </pre> 1156 1157 <p> 1158 This will show search results using the 'default' template. 1159 </p> 1160 1161 </div> 1162 1163 <div class="page"><a name="skinparterror"></a> 1164 <h1>Skins: Errors</h1> 1165 <p> 1166 Used when there is an error 1167 </p> 1168 1169 <pre> 1170 <html> 1171 <head> 1172 <title>My Weblog :: Error</title> 1173 </head> 1174 <body> 1175 1176 <h1>Error!</h1> 1177 <%errormessage%> 1178 1179 <br /><br /> 1180 1181 <a href="javascript:history.back();">Back</a> 1182 1183 </body> 1184 </html> 1185 </pre> 1186 1187 <p> 1188 This will show the error message, plus a link to go back. 1189 </p> 1190 1191 </div> 1192 1193 <div class="page"><a name="skinpartmember"></a> 1194 <h1>Skins: Member</h1> 1195 <p> 1196 Used to show member details. 1197 </p> 1198 1199 <p> 1200 Very basic buildup for a member-detail page: 1201 </p> 1202 1203 <pre> 1204 <html> 1205 <head> 1206 <title>My Weblog :: Member details</title> 1207 </head> 1208 <body> 1209 1210 <h1>Info about <%member(name)%></h1> 1211 Website: 1212 <a href="<%member(url)%>"><%member(url)%></a> 1213 1214 <h1>Send Message</h1> 1215 <%membermailform%> 1216 1217 </body> 1218 </html> 1219 </pre> 1220 1221 <p> 1222 This will show the members name, website address and a mailform. 1223 </p> 1224 1225 </div> 1226 1227 1228 <div class="page"><a name="skinpartimagepopup"></a> 1229 <h1>Skins: Image Popup</h1> 1230 <p> 1231 Used when a media file (image) needs to be shown in a popup window. This skin defines the layout that will be used in that case. 1232 </p> 1233 1234 <p> 1235 Very basic buildup for an imagepopup page: 1236 </p> 1237 1238 <pre> 1239 <html> 1240 <head> 1241 <title><%imagetext%></title> 1242 <style type="text/css"> 1243 img { border: none; } 1244 </style> 1245 </head> 1246 <body> 1247 <a href="javascript:window.close();"><%image%></a> 1248 </body> 1249 </html> 1250 </pre> 1251 1252 </div> 1253 1254 1255 <div class="page"><a name="skinpartspecial"></a> 1256 <h1>Skins: Main Index</h1> 1257 <p> 1258 This skinpart is used to show special, non-blog, content on your site. It can be used to show static content, or to wrap other 1259 dynamic applications, like forms, inside the skin of your blog. It is accessed by the name of the special skin part, in this way 1260 (assuming the special skin part is named <code>fred</code>): 1261 </p> 1262 <code>http://www.yoursite.tld/index.php?special=fred</code> 1263 1264 <p>Further discussion of the use of this feature can be found on the support forum: 1265 <a href="http://forum.nucleuscms.org/viewtopic.php?t=16501" title="Special Skin Parts">Nucleus 3.31 and Static Pages</a> 1266 </p> 1267 1268 <p> 1269 Very basic buildup for a special skin part: 1270 </p> 1271 1272 <pre> 1273 <html> 1274 <head> 1275 <title>My Weblog</title> 1276 </head> 1277 <body> 1278 1279 <h1>About My Site</h1> 1280 <p>This page was published in order 1281 to provide a platform to publicize the plight 1282 of the peeping-polly parrot whose present 1283 prognosis is perturbingly pessimistic.</p> 1284 1285 </body> 1286 </html> 1287 </pre> 1288 1289 <p> 1290 This will show the text of the body as indicated above. Also, many SkinVars work on special pages, so you can make 1291 the page look just like the other pages and use SkinVars to show an index of the whole site, or a list of members, etc... 1292 </p> 1293 </div> 1294 1295 1296 1297 1298 <div class="page"><a name="shortnames"></a> 1299 <h1>Shortnames & Display Names</h1> 1300 <p> 1301 Weblogs, templates and skin should all have a short name next to the full name or description. 1302 </p> 1303 1304 <p> 1305 A short name consists of <strong>only</strong> the characters a-z and 0-9, and <strong>cannot</strong> contain spaces 1306 </p> 1307 1308 <p> 1309 Display names are used for members. They can contain a-z, A-Z, 0-9 and spaces, but the spaces cannot be placed at the beginning or end of the name. 1310 </p> 1311 </div> 1312 1313 1314 1315 1316 1317 1318 <div class="page"><a name="templatenew"></a> 1319 <h1>Template: 'New' indication</h1> 1320 <p> 1321 When the <a href="#cookies">'last visit' cookie</a> option is activated, the contents of the 'Indication of new item'-template is copied into the <%new%> variable for items that have been added since the last visit. The <code><%new%></code> variable can e.g. be used in the <a href="#templateitems">item body</a>-template. 1322 </p> 1323 1324 <p> 1325 When the 'last visit' cookie is disabled, or the item is not 'new', this template part will not be used. 1326 </p> 1327 </div> 1328 1329 1330 <div class="page"><a name="strftime"></a> 1331 <h1>Time variables overview</h1> 1332 1333 <p>The following conversion specifiers are recognized in the format string <small>(taken from the PHP documentation for the strftime function)</small>. More info in the <a href="http://www.opengroup.org/onlinepubs/7908799/xsh/strftime.html" onclick="window.open(this.href);return false;" class="out" title="Open Group specification">Open Group Specification</a></p> 1334 1335 <ul> 1336 <li><strong>%a</strong> - abbreviated weekday name according to the current locale</li> 1337 <li><strong>%A</strong> - full weekday name according to the current locale</li> 1338 <li><strong>%b</strong> - abbreviated month name according to the current locale</li> 1339 <li><strong>%B</strong> - full month name according to the current locale</li> 1340 <li><strong>%c</strong> - preferred date and time representation for the current locale</li> 1341 <li><strong>%d</strong> - day of the month as a decimal number (range 00 to 31)</li> 1342 <li><strong>%H</strong> - hour as a decimal number using a 24-hour clock (range 00 to 23)</li> 1343 <li><strong>%I</strong> - hour as a decimal number using a 12-hour clock (range 01 to 12)</li> 1344 <li><strong>%j</strong> - day of the year as a decimal number (range 001 to 366)</li> 1345 <li><strong>%m</strong> - month as a decimal number (range 1 to 12)</li> 1346 <li><strong>%M</strong> - minute as a decimal number</li> 1347 <li><strong>%p</strong> - either `am' or `pm' according to the given time value, or the corresponding strings for the current locale</li> 1348 <li><strong>%S</strong> - second as a decimal number</li> 1349 <li><strong>%U</strong> - week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week</li> 1350 <li><strong>%W</strong> - week number of the current year as a decimal number, starting with the first Monday as the first day of the first week</li> 1351 <li><strong>%w</strong> - day of the week as a decimal, Sunday being 0</li> 1352 <li><strong>%x</strong> - preferred date representation for the current locale without the time</li> 1353 <li><strong>%X</strong> - preferred time representation for the current locale without the date</li> 1354 <li><strong>%y</strong> - year as a decimal number without a century (range 00 to 99)</li> 1355 <li><strong>%Y</strong> - year as a decimal number including the century</li> 1356 <li><strong>%Z</strong> - time zone or name or abbreviation</li> 1357 <li><strong>%%</strong> - a literal `%' character</li> 1358 </ul> 1359 1360 </div> 1361 1362 <div class="page"><a name="sendping"></a> 1363 <h1>Ping weblog listing services</h1> 1364 <p> 1365 When updating your weblog, you can choose to send an update notification (ping) to various weblog listing services. They provides a list of recently updated weblogs to everyone who requests it. Lots of websites are using this data, so you might receive some extra hits when enabling the ping. 1366 </p> 1367 <p class="note"><strong>Note:</strong> For this feature to work correctly, you need to fill out both the weblog URL and the weblog name in the blogsettings. 1368 </p> 1369 1370 </div> 1371 1372 <div class="page"><a name="blogsearchable"></a> 1373 1374 <h1>Always include in search</h1> 1375 1376 <p>When the 'include in search' option is selected, the weblog will <strong>always</strong> be included in searches, even if the search is done on another weblog.</p> 1377 1378 <p>As an example, suppose you have two blogs called 'lifelog' and 'linkdump', with the 'include in search' enabled for 'linkdump'. Now, a search query on 'lifelog' will also search through 'linkdump', while a search query on 'linkdump' will only search entries in 'linkdump'</p> 1379 1380 1381 </div> 1382 1383 1384 <div class="page"><a name="convertbreaks"></a> 1385 <h1>Convert Linebreaks</h1> 1386 <p> 1387 By default, Nucleus converts linebreaks in your items to <code><br /></code> tags, so a linebreak will also show up in your (X)HTML output 1388 </p> 1389 <p> 1390 Advanced users, or users striving for the semantic web (<tt>br</tt> tags don't add any information, they're just used for markup), might find this feature annoying, and turn this feature off. 1391 </p> 1392 </div> 1393 1394 1395 <div class="page"><a name="media"></a> 1396 <h1>Media</h1> 1397 <p> 1398 Nucleus allows you to upload media files (images, video, sound, ...) to your website 1399 </p> 1400 <p> 1401 Some settings are needed to do this: 1402 </p> 1403 <ul> 1404 <li><strong>Media dir</strong>: location on the server where the media files will be saved (local filesystem)</li> 1405 <li><strong>Media URL</strong>: location of the media files</li> 1406 <li><strong>Allow upload</strong>: It's possible to disable file upload</li> 1407 <li><strong>Allowed filetypes for upload</strong>: a bunch of extensions uploaded files can have (seperated by commas, case insensitive)</li> 1408 <li><strong>Max. upload file size</strong>: Puts a limit on the size of uploaded files</li> 1409 <li><strong>Prefix Media Files</strong>: When this option is turned on, uploaded file will be prefixed with the current date. Uploading a file named 'bunny.jpg' on April 8, 2003 will then result in a file named 20030408-bunny.jpg. The reason why you might want to do this, is when you're uploading tons of files, and don't want problems with duplicate names.</li> 1410 </ul> 1411 1412 <p> 1413 Each member has his own private collection of media files. Next to that, subdirectories that are under the media dir are seen as global collections (shared between members). 1414 </p> 1415 1416 <p>Uploading is only possible when a member is on the team of at least one of the blogs, to prevent abuse.</p> 1417 </div> 1418 1419 1420 <div class="page"><a name="protectmemnames"></a> 1421 <h1>Protect Member Names</h1> 1422 <p>When this option is enabled, non-logged in members cannot add comments using the same name as registered members. The reason to do this would be to avoid guest impersonating members.</p> 1423 </div> 1424 1425 1426 <div class="page"><a name="pluginurl"></a> 1427 <h1>Plugin URL</h1> 1428 <p>This setting is the base URL for plugin admin areas. Usually it will look like the following</p> 1429 <pre>http://hostname.com/nucleus/plugins/</pre> 1430 </div> 1431 1432 <div class="page"><a name="skinsurl"></a> 1433 <h1>Skins URL</h1> 1434 <p>This setting is the base URL for the Nucleus skins directory. Usually it will look like the following</p> 1435 <pre>http://hostname.com/skins/</pre> 1436 </div> 1437 1438 <div class="page"><a name="actionurl"></a> 1439 <h1>Action URL</h1> 1440 <p>This setting is the absolute URL of the <code>action.php</code> script that comes with Nucleus. Usually it will look like the following</p> 1441 <pre>http://hostname.com/actions.php</pre> 1442 </div> 1443 1444 1445 1446 <div class="page"><a name="additem"></a> 1447 <h1>Adding items</h1> 1448 <p>When adding items to a weblog, there are four kinds of template variables that you can use in the body text, title or extended part:</p> 1449 <ul> 1450 <li><a href="#templatevar-popup"><%popup(...)%></a> to insert a popup image</li> 1451 <li><a href="#templatevar-popup"><%image(...)%></a> to insert an inline image</li> 1452 <li><a href="#templatevar-popup"><%media(...)%></a> to insert a media object</li> 1453 </ul> 1454 <p>Usually, these tags are inserted by the 'insert media' button in the JavaScript toolbar</p> 1455 1456 1457 </div> 1458 1459 1460 1461 1462 <div class="page"> 1463 <a name="skinvar-referer"></a> 1464 <h1>Skinvar: referer</h1> 1465 <p>Inserts the refering URL (can be empty)</p> 1466 <h2>Arguments</h2> 1467 <p>None</p> 1468 <h2>Skintypes</h2> 1469 <p>all</p> 1470 <h2>Examples</h2> 1471 <pre> 1472 <a href="<%referer%>">back</a> 1473 </pre> 1474 </div> 1475 1476 1477 <div class="page"> 1478 <a name="skinvar-itemid"></a> 1479 <h1>Skinvar: itemid</h1> 1480 <p>Inserts the ID of the currently selected item</p> 1481 <h2>Arguments</h2> 1482 <p>None</p> 1483 <h2>Skintypes</h2> 1484 <p>item</p> 1485 <h2>Examples</h2> 1486 <pre> 1487 <%itemid%> 1488 </pre> 1489 </div> 1490 1491 1492 <div class="page"> 1493 <a name="skinvar-itemlink"></a> 1494 1495 <h1>Skinvar: itemlink</h1> 1496 1497 <p>Adds a permanent link for the item.</p> 1498 1499 <h2>Arguments</h2> 1500 1501 <p> 1502 Optional 1503 <ul> 1504 <li><strong><em>linktext</em></strong>: when present, a full <code><a href...</code> tag will be outputted, rather than a raw link</li> 1505 </ul> 1506 </p> 1507 <h2>Skintypes</h2> 1508 1509 <p>item</p> 1510 1511 <h2>Examples</h2> 1512 1513 <pre> 1514 <%itemlink%> 1515 </pre> 1516 </div> 1517 1518 <div class="page"> 1519 <a name="skinvar-itemtitle"></a> 1520 <h1>Skinvar: itemtitle</h1> 1521 <p>Inserts the title of the item, with HTML-stripped off and entities encoded</p> 1522 <h2>Arguments</h2> 1523 <p>None</p> 1524 <h2>Skintypes</h2> 1525 <p>item</p> 1526 <h2>Examples</h2> 1527 <pre> 1528 <%itemtitle%> 1529 </pre> 1530 </div> 1531 1532 1533 <div class="page"> 1534 <a name="skinvar-archivedate"></a> 1535 <h1>Skinvar: archivedate</h1> 1536 <p>Inserts a formatted date for an archive date. Using no parameters, this will either insert '15 august 2002' or 'august 2002' if the archive is for august 2002</p> 1537 <h2>Arguments</h2> 1538 <ul> 1539 <li>Optional 1540 <table><tr> 1541 <th>Name</th> 1542 <th>Value</th> 1543 </tr><tr> 1544 <td>Locale</td> 1545 <td><a href="#templatelocale">Locale</a> in which the date must be formatted</td> 1546 </tr><tr> 1547 <td>Format</td> 1548 <td>Date format (<a href="#strftime">strftime variables</a>)</td> 1549 </tr></table> 1550 </li> 1551 </ul> 1552 <h2>Skintypes</h2> 1553 <p>archive</p> 1554 <h2>Examples</h2> 1555 <pre> 1556 Archive for <%archivedate%> 1557 Archive for <%archivedate(dutch)%> 1558 Archive for <%archivedate(en,%B %Y)%> 1559 </pre> 1560 </div> 1561 1562 1563 1564 <div class="page"> 1565 <a name="skinvar-blog"></a> 1566 <h1>Skinvar: blog</h1> 1567 1568 <p> 1569 Inserts the most recently added items of the currently active blog (usually the default one) into the skin. 1570 </p> 1571 1572 <h2>Arguments</h2> 1573 <p> 1574 Required: 1575 <ul> 1576 <li><strong>template</strong>: name of the template to use</li> 1577 </ul> 1578 Optional: 1579 <ul> 1580 <li><strong><em>amount</em></strong>: the amount of items to show (default = 10). Can also contain an offset telling Nucleus to start only from the given item. e.g. <code>10(5)</code> shows 10 items starting from item 5</li> 1581 <li><strong><em>category</em></strong>: name of the category to show</li> 1582 </ul> 1583 </p> 1584 1585 <h2>Skintypes</h2> 1586 1587 <p> 1588 index, item, archive, archivelist, search 1589 </p> 1590 1591 <h2>Examples</h2> 1592 1593 <pre> 1594 <%blog(default,15)%> 1595 <%blog(default,5(15))%> 1596 <%blog(mytemplate)%> 1597 <%blog(mytemplate,5,mycategory)%> 1598 </pre> 1599 1600 </div> 1601 1602 <div class="page"> 1603 <a name="skinvar-bloglist"></a> 1604 <h1>Skinvar: bloglist</h1> 1605 1606 <p> 1607 Shows a list of all blogs that are defined in your Nucles CMS. 1608 </p> 1609 1610 <h2>Arguments</h2> 1611 <p> 1612 Required: 1613 <ul> 1614 <li><strong>template</strong>: name of the template to use</li> 1615 </ul> 1616 Optional: 1617 <ul> 1618 <li><strong>bnametype</strong>: whether the Blog Name (<code>name</code>) or the Short Blog Name (<code>shortname</code>) of the Blog is used. Default setting is the Blog name (<code>name</code>).</li> 1619 </ul> 1620 <ul> 1621 <li><strong>orderby</strong>: (3.40) Attribute of the blog used for determinig the order in which the blogs are listed. Supported values are <code>number</code>, <code>name</code>, <code>shortname</code>, <code>description</code>. Default is <code>number</code>.</li> 1622 </ul> 1623 <ul> 1624 <li><strong>direction</strong>: (3.40) Direction of the sorting, <code>asc</code> for ascending order, or <code>desc</code> for descending order. Default is <code>asc</code>. 1625 </ul> 1626 </p> 1627 1628 <h2>Skintypes</h2> 1629 1630 <p> 1631 all 1632 </p> 1633 1634 <h2>Examples</h2> 1635 1636 <pre> 1637 <%bloglist(default/index)%> 1638 <%bloglist(default/index,name)%> 1639 <%bloglist(default/index,shortname)%> 1640 <%bloglist(default/index,name,name,asc)%> 1641 </pre> 1642 1643 </div> 1644 1645 1646 1647 <div class="page"> 1648 <a name="skinvar-otherblog"></a> 1649 <h1>Skinvar: otherblog</h1> 1650 1651 <p> 1652 Inserts the most recently added items of a given blog into the skin. 1653 </p> 1654 1655 <h2>Arguments</h2> 1656 <p> 1657 Required: 1658 <ul> 1659 <li><strong>blogname</strong>: name of the blog to show</li> 1660 <li><strong>template</strong>: name of the template to use</li> 1661 </ul> 1662 Optional: 1663 <ul> 1664 <li><strong><em>amount</em></strong>: the amount of items to show (default = 10). Can also contain an offset telling Nucleus to start only from the given item. e.g. <code>10(5)</code> shows 10 items starting from item 5</li> 1665 <li><strong><em>category</em></strong>: name of the category to show</li> 1666 </ul> 1667 </p> 1668 1669 <h2>Skintypes</h2> 1670 1671 <p> 1672 all 1673 </p> 1674 1675 <h2>Examples</h2> 1676 1677 <pre> 1678 <%otherblog(myblog,default,15)%> 1679 <%otherblog(yourblog,mytemplate)%> 1680 <%otherblog(yourblog,mytemplate,15,mycategory)%> 1681 <%otherblog(yourblog,mytemplate,5(15),mycategory)%> 1682 </pre> 1683 1684 </div> 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 <div class="page"> 1695 <a name="skinvar-item"></a> 1696 <h1>Skinvar: item</h1> 1697 1698 <p> 1699 Shows the currently selected item (without comments) using a given template 1700 </p> 1701 1702 <h2>Arguments</h2> 1703 <ul> 1704 <li><strong>template</strong>: name of the template to use</li> 1705 </ul> 1706 1707 <h2>Skintypes</h2> 1708 1709 <p> 1710 item 1711 </p> 1712 1713 <h2>Examples</h2> 1714 1715 <pre> 1716 <%item(mytemplate)%> 1717 </pre> 1718 1719 </div> 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 <div class="page"> 1730 <a name="skinvar-comments"></a> 1731 <h1>Skinvar: comments</h1> 1732 1733 <p> 1734 Shows the comments for the currently selected item using a given template. 1735 </p> 1736 1737 <h2>Arguments</h2> 1738 <ul> 1739 <li><strong>template</strong>: name of the template to use</li> 1740 </ul> 1741 1742 <h2>Skintypes</h2> 1743 1744 <p> 1745 item 1746 </p> 1747 1748 <h2>Examples</h2> 1749 1750 <pre> 1751 <%comments(mytemplate)%> 1752 </pre> 1753 1754 </div> 1755 1756 1757 1758 1759 1760 1761 1762 <div class="page"> 1763 <a name="skinvar-archive"></a> 1764 <h1>Skinvar: archive</h1> 1765 1766 <p> 1767 Shows the archive for the selected month and the selected blog (usually the default one), using a given template 1768 </p> 1769 1770 <h2>Arguments</h2> 1771 <p> 1772 Required 1773 <ul> 1774 <li><strong>template</strong>: name of the template to use</li> 1775 </ul> 1776 Optional 1777 <ul> 1778 <li><strong><em>category</em></strong>: name of the category to show</li> 1779 </ul> 1780 </p> 1781 1782 <h2>Skintypes</h2> 1783 1784 <p> 1785 archive 1786 </p> 1787 1788 <h2>Examples</h2> 1789 1790 <pre> 1791 <%archive(mytemplate)%> 1792 <%archive(mytemplate,mycategory)%> 1793 </pre> 1794 1795 </div> 1796 1797 1798 1799 1800 <div class="page"> 1801 <a name="skinvar-otherarchive"></a> 1802 <h1>Skinvar: otherarchive</h1> 1803 1804 <p> 1805 Shows the archive for the selected month, using the given blog and template 1806 </p> 1807 1808 <h2>Arguments</h2> 1809 <p> 1810 Required 1811 <ul> 1812 <li><strong>blogname</strong>: name of the blog to use</li> 1813 <li><strong>template</strong>: name of the template to use</li> 1814 </ul> 1815 Optional 1816 <ul> 1817 <li><strong><em>category</em></strong>: name of the category to show</li> 1818 </ul> 1819 </p> 1820 1821 <h2>Skintypes</h2> 1822 1823 <p> 1824 archive 1825 </p> 1826 1827 <h2>Examples</h2> 1828 1829 <pre> 1830 <%otherarchive(myblog,mytemplate)%> 1831 <%otherarchive(myblog,mytemplate,mycategory)%> 1832 </pre> 1833 1834 </div> 1835 1836 1837 1838 1839 1840 1841 1842 <div class="page"> 1843 <a name="skinvar-archivelist"></a> 1844 <h1>Skinvar: archivelist</h1> 1845 1846 <p> 1847 Shows the list of available archives for the currently selected blog (usually the default one), using a given template 1848 </p> 1849 1850 <h2>Arguments</h2> 1851 <p> 1852 Required 1853 <ul> 1854 <li><strong>template</strong>: name of the template to use</li> 1855 </ul> 1856 Optional 1857 <ul> 1858 <li><strong><em>category</em></strong>: name of the category to show</li> 1859 <li><strong><em>limit</em></strong>: limits the amount of links shown (e.g. if you only want to show links to the past 3 months)</li> 1860 </ul> 1861 </p> 1862 1863 <h2>Skintypes</h2> 1864 1865 <p> 1866 index, archive, archivelist, search, item 1867 </p> 1868 </div> 1869 1870 <div class="page"> 1871 <a name="skinvar-archivedaylist"></a> 1872 <h1>Skinvar: archivedaylist</h1> 1873 1874 <p> 1875 The same as the <a href="#skinvar-archivelist">archivelist</a> skinvar, but shows an entry for each <em>day</em> instead of for each <em>month</em> 1876 </p> 1877 1878 <h2>Arguments</h2> 1879 <p> 1880 Required 1881 <ul> 1882 <li><strong>template</strong>: name of the template to use</li> 1883 </ul> 1884 Optional 1885 <ul> 1886 <li><strong><em>category</em></strong> name of the category to show</li> 1887 <li><strong><em>limit</em></strong>: limits the amount of links shown (e.g. if you only want to show links to the past 3 months)</li> 1888 </ul> 1889 </p> 1890 1891 <h2>Skintypes</h2> 1892 1893 <p> 1894 index, archive, archivelist, search, item 1895 </p> 1896 1897 1898 <h2>Examples</h2> 1899 1900 <pre> 1901 <%archivedaylist(mytemplate)%> 1902 <%archivedaylist(mytemplate,mycategory)%> 1903 </pre> 1904 1905 </div> 1906 1907 1908 <div class="page"> 1909 <a name="skinvar-otherarchivedaylist"></a> 1910 <h1>Skinvar: otherarchivedaylist</h1> 1911 1912 <p> 1913 The same as the <a href="#skinvar-otherarchivelist">otherarchivelist</a> skinvar, but shows an entry for each <em>day</em> instead of for each <em>month</em> 1914 1915 </p> 1916 1917 <h2>Arguments</h2> 1918 <p> 1919 Required 1920 <ul> 1921 <li><strong>blogname</strong>: name of the blog</li> 1922 <li><strong>template</strong>: name of the template to use</li> 1923 </ul> 1924 Optional 1925 <ul> 1926 <li><strong><em>category</em></strong>: name of the category to show</li> 1927 </ul> 1928 </p> 1929 1930 <h2>Skintypes</h2> 1931 1932 <p> 1933 all 1934 </p> 1935 1936 <h2>Examples</h2> 1937 1938 <pre> 1939 <%otherarchivedaylist(yourblog,mytemplate)%> 1940 <%otherarchivedaylist(yourblog,mytemplate,mycategory)%> 1941 </pre> 1942 1943 </div> 1944 1945 <div class="page"> 1946 <a name="skinvar-archiveyearlist"></a> 1947 <h1>Skinvar: archiveyearlist</h1> 1948 1949 <p> 1950 The same as the <a href="#skinvar-archivelist">archivelist</a> skinvar, but shows an entry for each <em>year</em> instead of for each <em>month</em> 1951 </p> 1952 1953 <h2>Arguments</h2> 1954 <p> 1955 Required 1956 <ul> 1957 <li><strong>template</strong>: name of the template to use</li> 1958 </ul> 1959 Optional 1960 <ul> 1961 <li><strong><em>category</em></strong> name of the category to show</li> 1962 <li><strong><em>limit</em></strong>: limits the amount of links shown (e.g. if you only want to show links to the past 3 years)</li> 1963 </ul> 1964 </p> 1965 1966 <h2>Skintypes</h2> 1967 1968 <p> 1969 index, archive, archivelist, search, item 1970 </p> 1971 1972 1973 <h2>Examples</h2> 1974 1975 <pre> 1976 <%archiveyearlist(mytemplate)%> 1977 <%archiveyearlist(mytemplate,mycategory)%> 1978 </pre> 1979 1980 </div> 1981 1982 1983 <div class="page"> 1984 <a name="skinvar-otherarchiveyearlist"></a> 1985 <h1>Skinvar: otherarchiveyearlist</h1> 1986 1987 <p> 1988 The same as the <a href="#skinvar-otherarchivelist">otherarchivelist</a> skinvar, but shows an entry for each <em>year</em> instead of for each <em>month</em> 1989 1990 </p> 1991 1992 <h2>Arguments</h2> 1993 <p> 1994 Required 1995 <ul> 1996 <li><strong>blogname</strong>: name of the blog</li> 1997 <li><strong>template</strong>: name of the template to use</li> 1998 </ul> 1999 Optional 2000 <ul> 2001 <li><strong><em>category</em></strong>: name of the category to show</li> 2002 </ul> 2003 </p> 2004 2005 <h2>Skintypes</h2> 2006 2007 <p> 2008 all 2009 </p> 2010 2011 <h2>Examples</h2> 2012 2013 <pre> 2014 <%otherarchiveyearlist(yourblog,mytemplate)%> 2015 <%otherarchiveyearlist(yourblog,mytemplate,mycategory)%> 2016 </pre> 2017 2018 </div> 2019 2020 2021 2022 <div class="page"> 2023 <a name="skinvar-otherarchivelist"></a> 2024 <h1>Skinvar: otherarchivelist</h1> 2025 2026 <p> 2027 Shows the list of available archives for a given blog, using a given template 2028 </p> 2029 2030 <h2>Arguments</h2> 2031 <p> 2032 Required 2033 <ul> 2034 <li><strong>blogname</strong>: name of the blog</li> 2035 <li><strong>template</strong>: name of the template to use</li> 2036 </ul> 2037 Optional 2038 <ul> 2039 <li><strong><em>category</em></strong>: name of the category to show</li> 2040 </ul> 2041 </p> 2042 2043 <h2>Skintypes</h2> 2044 2045 <p> 2046 all 2047 </p> 2048 2049 <h2>Examples</h2> 2050 2051 <pre> 2052 <%otherarchivelist(yourblog,mytemplate)%> 2053 <%otherarchivelist(yourblog,mytemplate,mycategory)%> 2054 </pre> 2055 2056 </div> 2057 2058 2059 2060 <div class="page"> 2061 <a name="skinvar-categorylist"></a> 2062 <h1>Skinvar: categorylist</h1> 2063 2064 <p> 2065 Inserts a list of categories for a blog (defaults to the currently selected blog), using a given template 2066 </p> 2067 2068 <h2>Arguments</h2> 2069 <p> 2070 Required 2071 <ul> 2072 <li><strong>template</strong>: name of the template to use</li> 2073 </ul> 2074 Optional 2075 <ul> 2076 <li><strong><em>blogname</em></strong>: short name of the blog to use</li> 2077 </ul> 2078 </p> 2079 2080 <h2>Skintypes</h2> 2081 2082 <p> 2083 index, archive, archivelist, search, item 2084 </p> 2085 2086 <h2>Examples</h2> 2087 2088 <pre> 2089 <%categorylist(mytemplate)%> 2090 <%categorylist(mytemplate,myweblog)%> 2091 </pre> 2092 2093 </div> 2094 2095 2096 2097 <div class="page"> 2098 <a name="skinvar-category"></a> 2099 <h1>Skinvar: category</h1> 2100 2101 <p> 2102 Inserts some information about the currently selected category. When no category is selected, does nothing. 2103 </p> 2104 2105 <h2>Arguments</h2> 2106 <p> 2107 Optional 2108 <ul> 2109 <li><strong><em>type</em></strong>: What information to include. Can be <b>name</b> (default), <b>desc</b> or <b>id</b></li> 2110 </ul> 2111 </p> 2112 2113 <h2>Skintypes</h2> 2114 2115 <p> 2116 all 2117 </p> 2118 2119 <h2>Examples</h2> 2120 2121 <pre> 2122 <%category%> 2123 <%category(id)%> 2124 <%category(desc)%> 2125 <%category(name)%> 2126 </pre> 2127 2128 </div> 2129 2130 2131 <div class="page"> 2132 <a name="skinvar-ifcat"></a> 2133 <h1>Skinvar: ifcat</h1> 2134 2135 <p class="deprecated">Deprecated as of Nucleus v2.0. Use <a href="#skinvar-if"><%if(category)%></a> instead.</p> 2136 2137 <h2>Arguments</h2> 2138 <p> 2139 None 2140 <ul> 2141 <li><em>text</em>: Text to show</li> 2142 </ul> 2143 </p> 2144 2145 <h2>Skintypes</h2> 2146 2147 <p> 2148 all 2149 </p> 2150 2151 <h2>Examples</h2> 2152 2153 <pre> 2154 <%ifcat(Current Category: )%><%category%> 2155 </pre> 2156 2157 </div> 2158 2159 2160 2161 2162 <div class="page"> 2163 <a name="skinvar-searchresults"></a> 2164 <h1>Skinvar: searchresults</h1> 2165 2166 <p> 2167 Shows the searchresult for the current query 2168 </p> 2169 2170 <h2>Arguments</h2> 2171 <p> 2172 Required: 2173 <ul> 2174 <li><strong>template</strong>: name of the template to use</li> 2175 </ul> 2176 Optional: 2177 <ul> 2178 <li><strong><em>maxresults</em></strong>: maximum amount of results to show</li> 2179 </ul> 2180 </p> 2181 2182 <h2>Skintypes</h2> 2183 2184 <p> 2185 search 2186 </p> 2187 2188 <h2>Examples</h2> 2189 2190 <pre> 2191 <%searchresults(mytemplate)%> 2192 </pre> 2193 2194 </div> 2195 2196 2197 2198 2199 <div class="page"> 2200 <a name="skinvar-othersearchresults"></a> 2201 <h1>Skinvar: othersearchresults</h1> 2202 2203 <p> 2204 Shows the searchresult in a give blog for the current query, using the given template 2205 </p> 2206 2207 <h2>Arguments</h2> 2208 <p> 2209 Required: 2210 <ul> 2211 <li><strong>blogname</strong>: name of the blog to use</li> 2212 <li><strong>template</strong>: name of the template to use</li> 2213 </ul> 2214 Optional: 2215 <ul> 2216 <li><strong><em>maxresults</em></strong>: maximum amount of results to show</li> 2217 </ul> 2218 </p> 2219 2220 <h2>Skintypes</h2> 2221 2222 <p> 2223 search 2224 </p> 2225 2226 <h2>Examples</h2> 2227 2228 <pre> 2229 <%othersearchresults(myblog,mytemplate)%> 2230 </pre> 2231 2232 </div> 2233 2234 2235 2236 2237 2238 2239 2240 <div class="page"> 2241 <a name="skinvar-query"></a> 2242 <h1>Skinvar: query</h1> 2243 2244 <p> 2245 Inserts the current search query. 2246 </p> 2247 2248 <h2>Arguments</h2> 2249 <p> 2250 None 2251 </p> 2252 2253 <h2>Skintypes</h2> 2254 2255 <p> 2256 search 2257 </p> 2258 2259 <h2>Examples</h2> 2260 2261 <pre> 2262 <%query%> 2263 </pre> 2264 2265 </div> 2266 2267 2268 2269 2270 2271 2272 2273 2274 <div class="page"> 2275 <a name="skinvar-version"></a> 2276 <h1>Skinvar: version</h1> 2277 2278 <p>Inserts the current Nucleus version.</p> 2279 2280 <h2>Arguments</h2> 2281 2282 <p> 2283 None 2284 </p> 2285 2286 <h2>Skintypes</h2> 2287 2288 <p> 2289 all 2290 </p> 2291 2292 <h2>Examples</h2> 2293 2294 <pre> 2295 <%version%> 2296 </pre> 2297 2298 </div> 2299 2300 2301 <div class="page"> 2302 <a name="skinvar-charset"></a> 2303 <h1>Skinvar: charset</h1> 2304 2305 <p>Inserts the character set encoding used by the current language file.</p> 2306 2307 <h2>Arguments</h2> 2308 2309 <p> 2310 None 2311 </p> 2312 2313 <h2>Skintypes</h2> 2314 2315 <p> 2316 all 2317 </p> 2318 2319 <h2>Examples</h2> 2320 2321 <pre> 2322 <%charset%> 2323 </pre> 2324 2325 </div> 2326 2327 2328 2329 2330 2331 <div class="page"> 2332 <a name="skinvar-previtem"></a> 2333 <h1>Skinvar: previtem</h1> 2334 2335 <p> 2336 Inserts the ID of the previous item in the blog 2337 </p> 2338 2339 <h2>Arguments</h2> 2340 <p>None</p> 2341 2342 <h2>Skintypes</h2> 2343 2344 <p> 2345 item 2346 </p> 2347 2348 <h2>Examples</h2> 2349 2350 <pre> 2351 <%previtem%> 2352 </pre> 2353 2354 </div> 2355 2356 2357 2358 2359 2360 2361 <div class="page"> 2362 <a name="skinvar-nextitem"></a> 2363 <h1>Skinvar: nextitem</h1> 2364 2365 <p> 2366 Inserts the ID of the next item in the blog 2367 </p> 2368 2369 <h2>Arguments</h2> 2370 <p>None</p> 2371 2372 <h2>Skintypes</h2> 2373 2374 <p> 2375 item 2376 </p> 2377 2378 <h2>Examples</h2> 2379 2380 <pre> 2381 <%nextitem%> 2382 </pre> 2383 2384 </div> 2385 2386 2387 <div class="page"> 2388 <a name="skinvar-nextitemtitle"></a> 2389 <h1>Skinvar: nextitemtitle</h1> 2390 2391 <p> 2392 Inserts the title of the next item in the blog 2393 </p> 2394 2395 <h2>Arguments</h2> 2396 <p>None</p> 2397 2398 <h2>Skintypes</h2> 2399 2400 <p> 2401 item 2402 </p> 2403 2404 <h2>Examples</h2> 2405 2406 <pre> 2407 <%nextitemtitle%> 2408 </pre> 2409 2410 </div> 2411 2412 2413 <div class="page"> 2414 <a name="skinvar-previtemtitle"></a> 2415 <h1>Skinvar: previtemtitle</h1> 2416 2417 <p> 2418 Inserts the title of the previous item in the blog 2419 </p> 2420 2421 <h2>Arguments</h2> 2422 <p>None</p> 2423 2424 <h2>Skintypes</h2> 2425 2426 <p> 2427 item 2428 </p> 2429 2430 <h2>Examples</h2> 2431 2432 <pre> 2433 <%previtemtitle%> 2434 </pre> 2435 2436 </div> 2437 2438 2439 2440 2441 <div class="page"> 2442 <a name="skinvar-prevarchive"></a> 2443 <h1>Skinvar: prevarchive</h1> 2444 2445 <p> 2446 Inserts the <code>archive</code> attribute that corresponds to the archive of either 1 day or 1 month back. This value can be used inside URLs to select an archive. 2447 </p> 2448 2449 <ul> 2450 <li>If the shown archive is for one specific day, the value has the form <code>YYYY-MM-DD</code></li> 2451 <li>If the shown archive is for a full month, the value has the form <code>YYYY-MM</code></li> 2452 </ul> 2453 2454 <h2>Arguments</h2> 2455 <p>None</p> 2456 2457 <h2>Skintypes</h2> 2458 2459 <p> 2460 archive 2461 </p> 2462 2463 <h2>Examples</h2> 2464 2465 <pre><code><a href="index.php?archive=<%prevarchive%>>....</code></pre> 2466 2467 </div> 2468 2469 2470 2471 2472 2473 2474 <div class="page"> 2475 <a name="skinvar-nextarchive"></a> 2476 <h1>Skinvar: nextarchive</h1> 2477 2478 <p> 2479 Inserts the <code>archive</code> attribute that corresponds to the archive of either 1 day or 1 month further in time. This value can be used inside URLs to select an archive. 2480 </p> 2481 2482 <ul> 2483 <li>If the shown archive is for one specific day, the value has the form <code>YYYY-MM-DD</code></li> 2484 <li>If the shown archive is for a full month, the value has the form <code>YYYY-MM</code></li> 2485 </ul> 2486 2487 <h2>Arguments</h2> 2488 <p>None</p> 2489 2490 <h2>Skintypes</h2> 2491 2492 <p> 2493 archive 2494 </p> 2495 2496 <h2>Examples</h2> 2497 2498 <pre><code><a href="index.php?archive=<%nextarchive%>>....</code></pre> 2499 2500 </div> 2501 2502 2503 <div class="page"> 2504 <a name="skinvar-archivetype"></a> 2505 <h1>Skinvar: archivetype</h1> 2506 2507 <p> 2508 Either <tt>day</tt> or <tt>month</tt>, indicating which type of archive is currently being shown 2509 </p> 2510 2511 <h2>Arguments</h2> 2512 <p>None</p> 2513 2514 <h2>Skintypes</h2> 2515 2516 <p> 2517 archive 2518 </p> 2519 2520 </div> 2521 2522 2523 2524 2525 2526 <div class="page"> 2527 <a name="skinvar-todaylink"></a> 2528 <h1>Skinvar: todaylink</h1> 2529 2530 <p> 2531 Inserts a link to the main page of the weblog. Takes into account the currently selected blog and category. 2532 </p> 2533 2534 <h2>Arguments</h2> 2535 <p> 2536 Optional 2537 <ul> 2538 <li><strong><em>linktext</em></strong>: when present, a full <code><a href...</code> tag will be outputted, rather than a raw link</li> 2539 </ul> 2540 </p> 2541 2542 2543 <h2>Skintypes</h2> 2544 2545 <p> 2546 all 2547 </p> 2548 2549 <h2>Examples</h2> 2550 2551 <pre> 2552 <%todaylink%> 2553 </pre> 2554 2555 </div> 2556 2557 2558 2559 2560 2561 2562 2563 <div class="page"> 2564 <a name="skinvar-archivelink"></a> 2565 <h1>Skinvar: archivelink</h1> 2566 2567 <p> 2568 Inserts a link to the archive for the currently selected blog and category (or the default blog when no blog selected) 2569 </p> 2570 2571 <h2>Arguments</h2> 2572 2573 <p> 2574 Optional 2575 <ul> 2576 <li><strong><em>linktext</em></strong>: when present, a full <code><a href...</code> tag will be outputted, rather than a raw link</li> 2577 </ul> 2578 </p> 2579 2580 2581 <h2>Skintypes</h2> 2582 2583 <p> 2584 all 2585 </p> 2586 2587 <h2>Examples</h2> 2588 2589 <pre> 2590 <%archivelink%> 2591 </pre> 2592 2593 </div> 2594 2595 2596 2597 2598 2599 2600 <div class="page"> 2601 <a name="skinvar-nextlink"></a> 2602 <h1>Skinvar: nextlink</h1> 2603 2604 <p> 2605 Inserts a link to the next item (on item pages) or to the next archive (on archive pages) 2606 </p> 2607 2608 <h2>Arguments</h2> 2609 <p> 2610 Optional 2611 <ul> 2612 <li><strong><em>linktext</em></strong>: when present, a full <code><a href...</code> tag will be outputted, rather than a raw link</li> 2613 <li><strong><em>amount</em></strong>: for search and index skins: the amount of items to go forward/backward</li> 2614 </ul> 2615 </p> 2616 2617 2618 <h2>Skintypes</h2> 2619 2620 <p> 2621 item, archive, search, index 2622 </p> 2623 2624 <h2>Examples</h2> 2625 2626 <pre> 2627 <%nextlink%> 2628 </pre> 2629 2630 </div> 2631 2632 2633 2634 2635 2636 2637 2638 2639 <div class="page"> 2640 <a name="skinvar-prevlink"></a> 2641 <h1>Skinvar: prevlink</h1> 2642 2643 <p> 2644 Inserts a link to the previous item (on item pages) or to the previous archive (on archive pages). For search and index pages 2645 </p> 2646 2647 <h2>Arguments</h2> 2648 <p> 2649 Optional 2650 <ul> 2651 <li><strong><em>linktext</em></strong>: when present, a full <code><a href...</code> tag will be outputted, rather than a raw link</li> 2652 <li><strong><em>amount</em></strong>: for search and index skins: the amount of items to go forward/backward</li> 2653 </ul> 2654 </p> 2655 2656 <h2>Skintypes</h2> 2657 2658 <p> 2659 item, archive, search, index 2660 </p> 2661 2662 <h2>Examples</h2> 2663 2664 <pre> 2665 <%prevlink%> 2666 </pre> 2667 2668 </div> 2669 2670 2671 2672 2673 2674 2675 2676 2677 <div class="page"> 2678 <a name="skinvar-errormessage"></a> 2679 <h1>Skinvar: errormessage</h1> 2680 2681 <p> 2682 Inserts the message corresponding to the error that occurred 2683 </p> 2684 2685 <h2>Arguments</h2> 2686 <p>None</p> 2687 2688 <h2>Skintypes</h2> 2689 2690 <p> 2691 error 2692 </p> 2693 2694 <h2>Examples</h2> 2695 2696 <pre> 2697 <%errormessage%> 2698 </pre> 2699 2700 </div> 2701 2702 2703 2704 2705 2706 2707 2708 2709 <div class="page"> 2710 <a name="skinvar-imagetext"></a> 2711 <h1>Skinvar: imagetext</h1> 2712 2713 <p class="deprecated">This skinvar is deprecated since Nucleus v2.0. You should use <a href="#skinvar-image"><code><%image(caption)%></code></a> instead</p> 2714 2715 <p> 2716 Inserts the caption text for a popup image 2717 </p> 2718 2719 <h2>Arguments</h2> 2720 <p>None</p> 2721 2722 <h2>Skintypes</h2> 2723 2724 <p> 2725 imagepopup 2726 </p> 2727 2728 <h2>Examples</h2> 2729 2730 <pre> 2731 <%imagetext%> 2732 </pre> 2733 2734 </div> 2735 2736 2737 2738 <div class="page"> 2739 <a name="skinvar-image"></a> 2740 <h1>Skinvar: image</h1> 2741 2742 <p> 2743 Inserts the selected image (for popup images) 2744 </p> 2745 2746 <h2>Arguments</h2> 2747 2748 <p>Optional</p> 2749 <ul> 2750 <li> 2751 <em>type</em> 2752 <table><tr> 2753 <td><strong>imgtag</strong> (default)</td> 2754 <td>Full XHTML <code><img ... /></code> tag</td> 2755 </tr><tr> 2756 <td><strong>url</strong></td> 2757 <td>Image file URL</td> 2758 </tr><tr> 2759 <td><strong>width</strong></td> 2760 <td>image width</td> 2761 </tr><tr> 2762 <td><strong>height</strong></td> 2763 <td>image height</td> 2764 </tr><tr> 2765 <td><strong>caption</strong></td> 2766 <td>image caption (text to go with image)</td> 2767 </tr></table> 2768 </li> 2769 </ul> 2770 2771 <h2>Skintypes</h2> 2772 2773 <p> 2774 imagepopup 2775 </p> 2776 2777 <h2>Examples</h2> 2778 2779 <pre> 2780 <%image%> 2781 </pre> 2782 2783 </div> 2784 2785 2786 <div class="page"> 2787 <a name="skinvar-vars"></a> 2788 <h1>Skinvar: vars</h1> 2789 2790 <p class="deprecated">This skinvar is deprecated since Nucleus v2.0. It's a small pain to insert this HTML yourself using the <a href="#skinvar-itemid">itemid skinvar</a></p> 2791 2792 <p> 2793 Inserts a hidden form-input field with the itemid. 2794 </p> 2795 2796 <code><input type="hidden" name="itemid" value="<strong>1234</strong>" /></code> 2797 2798 <h2>Arguments</h2> 2799 <p>None</p> 2800 2801 <h2>Skintypes</h2> 2802 2803 <p> 2804 item 2805 </p> 2806 2807 2808 </div> 2809 2810 2811 2812 2813 2814 2815 <div class="page"> 2816 <a name="skinvar-sitevar"></a> 2817 <h1>Skinvar: sitevar</h1> 2818 2819 <p> 2820 Includes a site variable 2821 </p> 2822 2823 <h2>Arguments</h2> 2824 <ul> 2825 <li><strong>type</strong>: name of the variable to show: 2826 <ul> 2827 <li><em>url</em>: URL of the site</li> 2828 <li><em>name</em>: Name of the site</li> 2829 <li><em>admin</em>: E-mail address of the administrator</li> 2830 </ul> 2831 </li> 2832 </ul> 2833 2834 <h2>Skintypes</h2> 2835 2836 <p> 2837 all 2838 </p> 2839 2840 <h2>Examples</h2> 2841 2842 <pre> 2843 <%sitevar(name)%> 2844 <%sitevar(url)%> 2845 <a href="mailto:<%sitevar(email)%>">Admin</a> 2846 </pre> 2847 2848 </div> 2849 2850 2851 2852 2853 2854 2855 <div class="page"> 2856 <a name="skinvar-blogsetting"></a> 2857 <h1>Skinvar: blogsetting</h1> 2858 2859 <p> 2860 Inserts a setting specific to the currently selected blog (usually the default one) 2861 </p> 2862 2863 <h2>Arguments</h2> 2864 <ul> 2865 <li><strong>type</strong>: which setting to add 2866 <ul> 2867 <li><em>id</em>: ID of the blog</li> 2868 <li><em>url</em>: URL of the blog</li> 2869 <li><em>name</em>: Name of the blog (long name)</li> 2870 <li><em>desc</em>: Description of the blog</li> 2871 <li><em>short</em>: Short name of the blog</li> 2872 </ul> 2873 </li> 2874 </ul> 2875 2876 <h2>Skintypes</h2> 2877 2878 <p> 2879 index, archive, archivelist, search, item, member 2880 </p> 2881 2882 <h2>Examples</h2> 2883 2884 <pre> 2885 <%blogsetting(name)%> 2886 <%blogsetting(id)%> 2887 <%blogsetting(desc)%> 2888 <a href="<%blogsetting(url)%>">...</a> 2889 </pre> 2890 2891 </div> 2892 2893 2894 2895 2896 2897 2898 <div class="page"> 2899 <a name="skinvar-member"></a> 2900 <h1>Skinvar: member</h1> 2901 2902 <p> 2903 Inserts some info about on the currently logged in member. On member detail pages, extra options are available to show the same information for the requested member. 2904 </p> 2905 2906 <p>When the visitor is not logged in, the <em>your...</em> parameters will insert nothing</p> 2907 2908 <h2>Arguments</h2> 2909 <ul> 2910 <li><strong>type</strong>: which information to show. 2911 <p>Information on the logged in member:</p> 2912 <ul> 2913 <li><em>yourname</em>: nickname of the member (the one used to login)</li> 2914 <li><em>yourrealname</em>: full name of the member</li> 2915 <li><em>yournotes</em>: extra information a member can set for him/herself</li> 2916 <li><em>yoururl</em>: URL of the members website</li> 2917 <li><em>youremail</em>: email address </li> 2918 <li><em>yourid</em>: ID</li> 2919 </ul> 2920 <p>Information on the requested member (only available on member detail pages):</p> 2921 <ul> 2922 <li><em>name</em>: nickname of the member (the one used to login)</li> 2923 <li><em>realname</em>: full name of the member</li> 2924 <li><em>notes</em>: extra information a member can set for him/herself</li> 2925 <li><em>url</em>: URL of the members website</li> 2926 <li><em>email</em>: email address of the member</li> 2927 <li><em>id</em>: ID</li> 2928 </ul> 2929 </li> 2930 </ul> 2931 2932 <h2>Skintypes</h2> 2933 2934 <p> 2935 all 2936 </p> 2937 2938 <h2>Examples</h2> 2939 2940 <pre><code> 2941 <%if(loggedin)%> 2942 you are <%member(yourrealname)%> 2943 <%endif%> 2944 </code></pre> 2945 2946 </div> 2947 2948 2949 2950 2951 2952 2953 <div class="page"> 2954 <a name="skinvar-preview"></a> 2955 <h1>Skinvar: preview</h1> 2956 2957 <p> 2958 Inserts an item-preview into the page, using a given template (to be used in conjunction with <a href="#skinvar-additemform">additemform</a>) 2959 </p> 2960 2961 <h2>Arguments</h2> 2962 <ul> 2963 <li><strong>template</strong>: name of the template to be used</li> 2964 </ul> 2965 2966 <h2>Skintypes</h2> 2967 2968 <p> 2969 index 2970 </p> 2971 2972 <h2>Examples</h2> 2973 2974 <pre> 2975 <%preview(mytemplate)%> 2976 </pre> 2977 2978 </div> 2979 2980 2981 2982 <div class="page"> 2983 <a name="skinvar-adminurl"></a> 2984 <h1>Skinvar: adminurl</h1> 2985 2986 <p>Inserts the full URL to the Admin Area</p> 2987 2988 <h2>Arguments</h2> 2989 <p>None</p> 2990 2991 <h2>Skintypes</h2> 2992 2993 <p> 2994 all 2995 </p> 2996 2997 <h2>Examples</h2> 2998 2999 <pre> 3000 <a href="<%adminurl%>">Admin Area</a> 3001 </pre> 3002 3003 </div> 3004 3005 3006 3007 3008 <div class="page"> 3009 <a name="skinvar-additemform"></a> 3010 <h1>Skinvar: additemform</h1> 3011 3012 <p> 3013 Shows an add-item form for the currently selected blog (usually the default one). Mostly used in conjunction with <a href="#skinvar-preview">preview</a> 3014 </p> 3015 3016 <h2>Arguments</h2> 3017 <p>None</p> 3018 3019 <h2>Skintypes</h2> 3020 3021 <p> 3022 index 3023 </p> 3024 3025 <h2>Examples</h2> 3026 3027 <pre> 3028 <%additemform%> 3029 </pre> 3030 3031 </div> 3032 3033 3034 3035 3036 3037 3038 <div class="page"> 3039 <a name="skinvar-include"></a> 3040 <h1>Skin/Templatevar: include</h1> 3041 3042 <p> 3043 Includes a textfile into the output. The contents of the file is not parsed in any way, so you cannot use skin/templatevars or use PHP code (see <a href="#skinvar-parsedinclude">parsedinclude</a> and <a href="#skinvar-phpinclude">phpinclude</a> if you want parsed includes) 3044 </p> 3045 3046 <h2>Arguments</h2> 3047 <ul> 3048 <li><strong>filename</strong>: the name of the file to be included (either relative to the position of index.php, or absolute). Note that an URL can also be used here.</li> 3049 </ul> 3050 3051 <h2>Notes</h2> 3052 <ul> 3053 <li>This tag is affected by the <a href="#parser-properties">parser settings <code>IncludeMode</code> and <code>IncludePrefix</code></a></li> 3054 </ul> 3055 3056 <h2>Skintypes</h2> 3057 3058 <p> 3059 all 3060 </p> 3061 3062 <h2>Examples</h2> 3063 3064 <pre> 3065 <%include(filename.txt)%> 3066 <%include(/home/user/myself/filename.txt)%> 3067 <%include(http://mydomain.com/filename.html)%> 3068 </pre> 3069 3070 </div> 3071 3072 3073 3074 3075 3076 3077 3078 <div class="page"> 3079 <a name="skinvar-phpinclude"></a> 3080 <h1>Skin/Templatevar: phpinclude</h1> 3081 3082 <p> 3083 Includes a php-file into the output. The contents of the file is parsed by the PHP parser, so be careful. Nucleus skin/templatevars are <b>not</b> parsed! (see <a href="#skinvar-parsedinclude">parsedinclude</a> and <a href="#skinvar-include">include</a> for other include options). 3084 </p> 3085 3086 <h2>Arguments</h2> 3087 <ul> 3088 <li><strong>filename</strong>: the name of the file to be included (either relative to the position of index.php, or absolute)</li> 3089 </ul> 3090 3091 <h2>Notes</h2> 3092 <ul> 3093 <li>This tag is affected by the <a href="#parser-properties">parser settings <code>IncludeMode</code> and <code>IncludePrefix</code></a></li> 3094 <li>Your file will be included using the standard php <code>include()</code> command. This command will be called from <em>inside</em> a class method, so <strong>you'll need to declare which global variables you want to access</strong> yourself. Most of the <a href="#skinvar-phpinclude-vars">standard variables</a> are automatically declared global by Nucleus itself.</li> 3095 </ul> 3096 3097 <h2>Skintypes</h2> 3098 3099 <p> 3100 all 3101 </p> 3102 3103 <h2>Examples</h2> 3104 3105 <pre><code><%phpinclude(filename.php)%> 3106 <%phpinclude(/home/user/myself/filename.php)%></code></pre> 3107 3108 </div> 3109 3110 3111 3112 <div class="page"> 3113 <a name="skinvar-phpinclude-vars"></a> 3114 <h1>Skin/Templatevar: phpinclude : vars</h1> 3115 3116 <p> 3117 The following global variables are accessible from within files included by the <a href="#skinvar-phpinclude">phpinclude</a> skin/templatevar: 3118 </p> 3119 3120 <p> 3121 $GATEWAY_INTERFACE, $SERVER_NAME, $SERVER_SOFTWARE 3122 <br />$SERVER_PROTOCOL, $REQUEST_METHOD, $QUERY_STRING 3123 <br />$DOCUMENT_ROOT, $HTTP_ACCEPT, $HTTP_ACCEPT_CHARSET 3124 <br />$HTTP_ACCEPT_ENCODING, $HTTP_ACCEPT_LANGUAGE 3125 <br />$HTTP_CONNECTION, $HTTP_HOST, $HTTP_REFERER 3126 <br />$HTTP_USER_AGENT, $REMOTE_ADDR, $REMOTE_PORT 3127 <br />$SCRIPT_FILENAME, $SERVER_ADMIN, $SERVER_PORT 3128 <br />$SERVER_SIGNATURE, $PATH_TRANSLATED, $SCRIPT_NAME 3129 <br />$REQUEST_URI, $argv, $argc, $PHP_SELF 3130 <br />$HTTP_COOKIE_VARS, $HTTP_GET_VARS, $HTTP_POST_VARS 3131 <br />$HTTP_POST_FILES, $HTTP_ENV_VARS, $HTTP_SERVER_VARS 3132 <br />$HTTP_SESSION_VARS, $PATH_INFO, $HTTPS 3133 <br />$HTTP_RAW_POST_DATA, $HTTP_X_FORWARDED_FOR 3134 </p> 3135 3136 <p> 3137 For others variables, you'll need to add '<tt>global $varname;</tt>' explicitly in your code 3138 </p> 3139 3140 </div> 3141 3142 3143 3144 <div class="page"> 3145 <a name="skinvar-parsedinclude"></a> 3146 <h1>Skin/Templatevar: parsedinclude</h1> 3147 3148 <p> 3149 Includes a file into the output. The contents of the file is parsed by the Nucleus skin/template parser, so you can use skin/templatevars. (see <a href="#skinvar-phpinclude">phpinclude</a> and <a href="#skinvar-include">include</a> for other include options) 3150 </p> 3151 3152 <h2>Arguments</h2> 3153 <ul> 3154 <li><strong>filename</strong>: the name of the file to be included (either relative to the position of index.php, or absolute)</li> 3155 </ul> 3156 3157 <h2>Notes</h2> 3158 <ul> 3159 <li>This tag is affected by the <a href="#parser-properties">parser settings <code>IncludeMode</code> and <code>IncludePrefix</code></a></li> 3160 <li>From inside the included file, you can call <code><%parsedinclude(filename)%></code> again. To avoid endless loops, the maximum depth level you can go is 3.</li> 3161 </ul> 3162 3163 3164 <h2>Skintypes</h2> 3165 3166 <p> 3167 all 3168 </p> 3169 3170 <h2>Examples</h2> 3171 3172 <pre> 3173 <%parsedinclude(filename.txt)%> 3174 <%parsedinclude(/home/user/myself/filename.txt)%> 3175 </pre> 3176 3177 </div> 3178 3179 3180 3181 3182 3183 3184 <div class="page"> 3185 <a name="skinvar-plugin"></a> 3186 <h1>Skin/Templatevar: plugin</h1> 3187 3188 <p> 3189 Calls a plugin 3190 </p> 3191 3192 <h2>Arguments</h2> 3193 <ul> 3194 <li> 3195 <p>Required</p> 3196 <table><tr> 3197 <th>Name</th> 3198 <th>Contents</th> 3199 </tr><tr> 3200 <td>PlugName</td> 3201 <td>Name of the plugin that should be called. <strong>This name is case sensitive!</strong></td> 3202 </tr></table> 3203 </li> 3204 <li><p>Extra parameters can be added, depending on the plugin</p></li> 3205 </ul> 3206 3207 <h2>Notes</h2> 3208 <ul> 3209 <li>When a plugin name does not conflict with existing variables, it can be called directly using <code><%PluginName(parameters)%></code></li> 3210 </ul> 3211 3212 <h2>Skintypes</h2> 3213 3214 <p> 3215 all 3216 </p> 3217 3218 <h2>Examples</h2> 3219 3220 <pre> 3221 <%plugin(Calendar)%> 3222 <%plugin(LastComments,myweblog)%> 3223 <%LastComments(myweblog)%> 3224 </pre> 3225 3226 </div> 3227 3228 3229 3230 3231 <div class="page"> 3232 <a name="skinvar-loginform"></a> 3233 <h1>Skinvar: loginform</h1> 3234 3235 <p>Adds a loginform, or shows a "You are karma (Log out)" message</p> 3236 3237 <h2>Arguments</h2> 3238 <p> 3239 None 3240 </p> 3241 3242 <h2>Skintypes</h2> 3243 3244 <p>all</p> 3245 3246 <h2>Examples</h2> 3247 3248 <pre><code><%loginform%></code></pre> 3249 3250 </div> 3251 3252 3253 3254 3255 <div class="page"> 3256 <a name="skinvar-commentform"></a> 3257 <h1>Skinvar: commentform</h1> 3258 3259 <p> 3260 Adds a commentform to an item page. 3261 </p> 3262 3263 <h2>Arguments</h2> 3264 <p> 3265 Optional: 3266 <ul> 3267 <li><strong><em>destinationurl</em></strong>: sets the URL to where Nucleus needs to redirect after adding the comment (by default, Nucleus redirects to the item detail page for the item)</li> 3268 </ul> 3269 </p> 3270 3271 <h2>Skintypes</h2> 3272 3273 <p> 3274 item 3275 </p> 3276 3277 <h2>Examples</h2> 3278 3279 <pre> 3280 <%commentform%> 3281 <%commentform(http://host/thanks.html)%> 3282 </pre> 3283 3284 </div> 3285 3286 3287 3288 <div class="page"> 3289 <a name="skinvar-set"></a> 3290 <h1>Skin/Templatevar: set</h1> 3291 3292 <p> 3293 Sets a <a href="#parser-properties" title="A list of available parser properties">parser property</a>. 3294 </p> 3295 3296 <h2>Arguments</h2> 3297 <p> 3298 <ul> 3299 <li><strong>property</strong>: name of the property</li> 3300 <li><strong>value</strong>: value of the property</li> 3301 </ul> 3302 </p> 3303 3304 <h2>Skintypes</h2> 3305 3306 <p> 3307 all 3308 </p> 3309 3310 <h2>Examples</h2> 3311 3312 <pre> 3313 <%set(IncludeMode,skindir)%> 3314 <%set(IncludePrefix,somedir/)%> 3315 </pre> 3316 3317 </div> 3318 3319 3320 <div class="page"> 3321 <a name="skinvar-skinfile"></a> 3322 <h1>Skin/Templatevar: skinfile</h1> 3323 3324 <p>Used by imported skins to put a link relative to the skins-URL. Use it in conjunction with the <tt>IncludePrefix</tt> <a href="#parser-properties">parser property</a> to get the best results</p> 3325 3326 <h2>Arguments</h2> 3327 <p> 3328 <ul> 3329 <li><strong>filename</strong>: filename of which you want the correct URL</li> 3330 </ul> 3331 </p> 3332 3333 <h2>Skintypes</h2> 3334 3335 <p> 3336 all 3337 </p> 3338 3339 <h2>Examples</h2> 3340 3341 <pre> 3342 <%skinfile(mystyle.css)%> 3343 </pre> 3344 3345 </div> 3346 3347 3348 3349 <div class="page"> 3350 <a name="skinvar-skinname"></a> 3351 <h1>Skin/Templatevar: skinname</h1> 3352 3353 <p>Inserts the name of the skin that's currently being used.</p> 3354 3355 <h2>Arguments</h2> 3356 <p> 3357 None 3358 </p> 3359 3360 <h2>Skintypes</h2> 3361 3362 <p> 3363 all 3364 </p> 3365 3366 <h2>Examples</h2> 3367 3368 <pre> 3369 <%skinname%> 3370 </pre> 3371 3372 </div> 3373 3374 3375 3376 <div class="page"> 3377 <a name="skinvar-if"></a> 3378 <a name="skinvar-else"></a> 3379 <a name="skinvar-endif"></a> 3380 <a name="skinvar-ifnot"></a> 3381 <a name="skinvar-elseifnot"></a> 3382 <a name="skinvar-elseif"></a> 3383 <h1>Skinvars: if/ifnot/else/elseif/elseifnot/endif</h1> 3384 3385 <p>Inserts a content block only when certain conditions are fullfilled</p> 3386 3387 <h2>Arguments</h2> 3388 <p>Only the <code>if</code>, <code>ifnot</code>, <code>elseif</code>, and <code>elseifnot</code> skinvars have options</p> 3389 3390 3391 <ul> 3392 <li><strong>type</strong>: type of condition</li> 3393 <li><em>name</em>: name of option (optional)</li> 3394 <li><em>value</em>: value to be checked (optional)</li> 3395 </ul> 3396 3397 <h2>Condition types</h2> 3398 3399 <ul> 3400 <li><strong>category</strong>: condition is fullfilled when a category is selected 3401 <ul> 3402 <li><strong>category</strong>: checks if any category is selected</li> 3403 <li><strong>category,catname,<em>CategoryName</em></strong>: checks if the current category is <em>CategoryName</em></li> 3404 <li><strong>category,catid,<em>CategoryId</em></strong>: checks if the current category is <em>CategoryId</em></li> 3405 </ul> 3406 </li> 3407 <li><strong>blogsetting</strong>: checks if the value <em>name</em> blogsetting equals <em>value</em> (the name is the column name from the nucleus_blog sql table)</li> 3408 <li><strong>loggedin</strong>: condition is fullfilled if visiting member is currently logged in</li> 3409 <li><strong>onteam</strong>: condition is fullfilled if visiting member is currently logged in & member of the blog team of the current blog (or the blog given in the <em>name</em> parameter)</li> 3410 <li><strong>admin</strong>: condition is fullfilled if visiting member is currently logged in & member with blog admin rights to the current blog (or the blog given in the <em>name</em> parameter)</li> 3411 <li><strong>nextitem</strong>: true if there is a more recent item available for the current weblog (item skintype)</li> 3412 <li><strong>previtem</strong>: true if there is an older item available for the current weblog (item skintype)</li> 3413 <li><strong>archivenextexists</strong>: true if there is a more recent archive available for the current weblog (archive skintype)</li> 3414 <li><strong>archiveprevexists</strong>: true if there is an older archive available for the current weblog (archive skintype)</li> 3415 <li><strong>skintype</strong>: checks if the current skin type is equal to <em>value</em> (index, search, item, archive, archivelist, ...). For special skin parts, the skin type is the name of the special skin part.</li> 3416 <li><strong>hasplugin</strong>: checks if the a plugin is installed, or if a plugin option has been set to a specific value 3417 <ul> 3418 <li><strong>hasplugin,<em>PluginName</em></strong>: checks if plugin is available</li> 3419 <li><strong>hasplugin,<em>PluginName</em>,<em>OptionName</em></strong>: checks if a plugin option is not set to 'no'</li> 3420 <li><strong>hasplugin,<em>PluginName</em>,<em>OptionName=value</em></strong>: checks if a plugin option is set to a specific value</li> 3421 </ul> 3422 </li> 3423 <li><strong><em>PluginName</em></strong>: checks if the a plugin is installed, and executes doIf() method of plugin to check condition of name/value pair. This allows plugins to do conditional checks in a skin. See documentation for your plugin to determine what conditionals it can perform and the syntax required for its use. 3424 <ul> 3425 <li><strong><em>PluginName</em>,<em>AttributeName</em></strong>: uses <em>PluginName</em> plugin to check if <em>AttributeName</em> has empty value</li> 3426 <li><strong><em>PluginName</em>,<em>AttributeName</em>,<em>AttributeValue</em></strong>: uses <em>PluginName</em> plugin to check if <em>AttributeName</em> is <em>AttributeValue</em></li> 3427 </ul> 3428 </li> 3429 </ul> 3430 3431 <h2>Skintypes</h2> 3432 3433 <p> 3434 all 3435 </p> 3436 3437 <h2>Examples</h2> 3438 3439 <pre> 3440 <%if(loggedin)%> 3441 Welcome back! 3442 <%else%> 3443 Welcom guest! 3444 <%endif%> 3445 </pre> 3446 3447 <pre> 3448 <%if(category,catname,Off Topic)%> 3449 Welcome to the 'Off Topic' category. 3450 <%endif%> 3451 </pre> 3452 3453 <pre> 3454 <%ifnot(loggedin)%> 3455 Access Denied! 3456 <%elseif(admin)%> 3457 Welcome O Mighty Admin of this Blog! 3458 <%elseif(onteam)%> 3459 Welcome O Worthy Blog Team Member! 3460 <%else%> 3461 Welcome O Humble Site Member! 3462 <%endif%> 3463 </pre> 3464 3465 <h2>Notes</h2> 3466 3467 <p>If you want something to be displayed only if a condition is not fullfilled, you can use a construct like this:</p> 3468 3469 <pre> 3470 <%ifnot(skintype,error)%> 3471 <%blogsetting(name)%> 3472 <%endif%> 3473 </pre> 3474 3475 </div> 3476 3477 3478 3479 3480 3481 3482 <div class="page"> 3483 <a name="skinvar-membermailform"></a> 3484 <h1>Skinvar: membermailform</h1> 3485 3486 <p> 3487 Shows a form through which a logged-in member can send a message to the member which details are being shown (on member detail pages) 3488 </p> 3489 3490 <h2>Arguments</h2> 3491 <p> 3492 Optional: 3493 <ul> 3494 <li><strong><em>rows</em></strong>: Amount of rows in the box (default = 10)</li> 3495 <li><strong><em>cols</em></strong>: Amount of columns in the box (default = 40)</li> 3496 <li><strong><em>destination url</em></strong>: URL to where Nucleus needs to redirection after sending the message</li> 3497 </ul> 3498 </p> 3499 3500 <h2>Skintypes</h2> 3501 3502 <p> 3503 member 3504 </p> 3505 3506 <h2>Examples</h2> 3507 3508 <pre> 3509 <%membermailform%> 3510 </pre> 3511 3512 </div> 3513 3514 3515 3516 3517 3518 3519 <div class="page"> 3520 <a name="skinvar-searchform"></a> 3521 <h1>Skinvar: searchform</h1> 3522 3523 <p> 3524 Shows a search form for the current blog. 3525 </p> 3526 3527 <h2>Arguments</h2> 3528 <p> 3529 Optional: 3530 <ul> 3531 <li><strong><em>blogname</em></strong>: The name of the blog for which you want a search form (short blog name)</li> 3532 </ul> 3533 </p> 3534 3535 <h2>Skintypes</h2> 3536 3537 <p> 3538 index, archive, archivelist, search, item 3539 </p> 3540 3541 <h2>Examples</h2> 3542 3543 <pre> 3544 <%searchform%> 3545 <%searchform(otherweblog)%> 3546 </pre> 3547 3548 </div> 3549 3550 3551 3552 3553 3554 3555 <div class="page"> 3556 <a name="skinvar-nucleusbutton"></a> 3557 <h1>Skinvar: nucleusbutton</h1> 3558 3559 <p>Inserts a nucleus button, with link to the <a href="http://nucleuscms.org/" class="out" onclick="window.open(this.href);return false;" title="Nucleus website (opens in new window)">Nucleus website</a>.</p> 3560 3561 <h2>Arguments</h2> 3562 <p> 3563 Optional: 3564 <ul> 3565 <li><strong><em>imgurl</em></strong>: URL of the image (if you don't want the default)</li> 3566 <li><strong><em>imgwidth</em></strong>: width of the image (in pixels)</li> 3567 <li><strong><em>imgheight</em></strong>: height of the image (in pixels)</li> 3568 </ul> 3569 </p> 3570 3571 <h2>Notes</h2> 3572 <ul> 3573 <li>This tag is affected by the <a href="#parser-properties">parser settings <code>IncludeMode</code> and <code>IncludePrefix</code></a></li> 3574 </ul> 3575 3576 <h2>Skintypes</h2> 3577 3578 <p> 3579 all 3580 </p> 3581 3582 <h2>Examples</h2> 3583 3584 <pre> 3585 <%nucleusbutton%> 3586 <%nucleusbutton(nucleus/nucleus.gif,46,43)%> 3587 </pre> 3588 3589 </div> 3590 3591 3592 3593 3594 <div class="page"> 3595 <a name="skinvar-self"></a> 3596 <h1>Skinvar: self</h1> 3597 3598 <p> 3599 Inserts the filename of the page currently being displayed (index.php or whatever you changed it to) 3600 </p> 3601 3602 <h2>Arguments</h2> 3603 <p>None</p> 3604 3605 <h2>Skintypes</h2> 3606 3607 <p> 3608 all 3609 </p> 3610 3611 <h2>Examples</h2> 3612 3613 <pre> 3614 <%self%> 3615 </pre> 3616 3617 </div> 3618 3619 3620 <div class="page"> 3621 <a name="skinvar-addlink"></a> 3622 <h1>Skinvar: addlink</h1> 3623 3624 <p> 3625 Inserts a URL to the new item bookmarklet form. Only shown for members who have rights on the current blog. 3626 </p> 3627 3628 <h2>Arguments</h2> 3629 <p>None</p> 3630 3631 <h2>Skintypes</h2> 3632 3633 <p> 3634 all 3635 </p> 3636 3637 <h2>Examples</h2> 3638 3639 <pre> 3640 <dd><a href="<%addlink%>" onclick="<%addpopupcode%>" title="Add an item to your blog">Add an item</a></dd> 3641 </pre> 3642 3643 </div> 3644 3645 <div class="page"> 3646 <a name="skinvar-addpopupcode"></a> 3647 <h1>Skinvar: addpopupcode</h1> 3648 3649 <p> 3650 Inserts javascript code to open a bookmarklet in an popup window. Use with <code><%addlink%></code> 3651 </p> 3652 3653 <h2>Arguments</h2> 3654 <p>None</p> 3655 3656 <h2>Skintypes</h2> 3657 3658 <p> 3659 all 3660 </p> 3661 3662 <h2>Examples</h2> 3663 3664 <pre> 3665 <dd><a href="<%addlink%>" onclick="<%addpopupcode%>" title="Add an item to your blog">Add an item</a></dd> 3666 </pre> 3667 3668 </div> 3669 3670 3671 <div class="page"> 3672 <a name="skinvar-sticky"></a> 3673 <h1>Skinvar: sticky</h1> 3674 3675 <p> 3676 Inserts the indicated item into the skin. 3677 </p> 3678 3679 <h2>Arguments</h2> 3680 <p> 3681 Required: 3682 <ul> 3683 <li><strong>itemid</strong>: id of the item to show</li> 3684 <li><strong>template</strong>: name of the template to use</li> 3685 </ul> 3686 </p> 3687 3688 <h2>Skintypes</h2> 3689 3690 <p> 3691 all 3692 </p> 3693 3694 <h2>Examples</h2> 3695 3696 <pre> 3697 <%sticky(11,default/index)%> 3698 </pre> 3699 3700 </div> 3701 3702 3703 3704 <div class="page"> 3705 <a name="templatevars-overview"></a> 3706 <h1>Template variables: Overview</h1> 3707 3708 <h2>What?</h2> 3709 3710 <p>Template variables largely work in exact the same way as skin variables, with the only difference that they are being used inside templates. The variables are called using <code><%<i>varname</i>%></code>, and include some text depending on the variable function. Some variables also have extra optional parameters.</p> 3711 3712 <h2>Available variables</h2> 3713 3714 <p> 3715 These template variables be used in the following template-parts: <tt>item header, item body, item footer, date header, date footer, morelink, editlink</tt> (The variables <tt>image</tt>, <tt>popup</tt> and <tt>media</tt> can also be used inside weblog items.) 3716 </p> 3717 3718 <ul> 3719 <li><a href="#templatevars-basic">Basic variables...</a> (title, body, ...)</li> 3720 <li><a href="#templatevars-advanced">Advanced variables...</a> (include, plugin, ...)</li> 3721 </ul> 3722 3723 <p>Comments-related template-parts (<tt>comments header, comments body, comments footer, one comment, two comments, comments read more, no comments, too much comments</tt>) have a different set of available variables:</p> 3724 3725 <ul> 3726 <li><a href="#templatevars-comments">Comments-related variables...</a></li> 3727 </ul> 3728 3729 3730 </div> 3731 3732 3733 3734 <div class="page"> 3735 <a name="templatevars-basic"></a> 3736 <h1>Template variables: Basic variables</h1> 3737 3738 <p>All these variables concern the item that's currently being parsed.</p> 3739 3740 <table><tr> 3741 <th>Name</th> 3742 <th>Description</th> 3743 </tr><tr> 3744 <td>title</td> 3745 <td>item title</td> 3746 </tr><tr> 3747 <td>body</td> 3748 <td>body text</td> 3749 </tr><tr> 3750 <td>more</td> 3751 <td>extended text</td> 3752 </tr><tr> 3753 <td>category</td> 3754 <td>name of the category</td> 3755 </tr><tr> 3756 <td>categorylink</td> 3757 <td>raw link to the category</td> 3758 </tr><tr> 3759 <td><a href="#templatevar-karma">karma</a></td> 3760 <td>karma score</td> 3761 </tr><tr> 3762 <td>authorlink</td> 3763 <td>raw link to the author</td> 3764 </tr><tr> 3765 <td>itemlink</td> 3766 <td>raw permanent link for the item</td> 3767 </tr><tr> 3768 <td><a href="#templatevar-author">author</a></td> 3769 <td>name of the author</td> 3770 </tr><tr> 3771 <td><a href="#templatevar-smartbody">smartbody</a></td> 3772 <td>either the body text or the extended text</td> 3773 </tr><tr> 3774 <td><a href="#templatevar-morelink">morelink</a></td> 3775 <td>'read more'-link</td> 3776 </tr><tr> 3777 <td><a href="#templatevar-date">date</a></td> 3778 <td>Formatted date</td> 3779 </tr><tr> 3780 <td><a href="#templatevar-time">time</a></td> 3781 <td>Formatted time</td> 3782 </tr><tr> 3783 <td>daylink</td> 3784 <td>raw link to the daily archive</td> 3785 </tr><tr> 3786 <td><a href="#templatevar-comments">comments</a></td> 3787 <td>comments block or commentcount</td> 3788 </tr><tr> 3789 <td>itemid</td> 3790 <td>ID of the item</td> 3791 </tr><tr> 3792 <td>blogurl</td> 3793 <td>URL of the blog</td> 3794 </tr></table> 3795 3796 <p><a href="#templatevars-overview">Template variables overview...</a></p> 3797 3798 3799 </div> 3800 3801 3802 3803 <div class="page"> 3804 <a name="templatevars-advanced"></a> 3805 <h1>Template variables: Advanced variables</h1> 3806 3807 3808 <table><tr> 3809 <th>Name</th> 3810 <th>Description</th> 3811 </tr><tr> 3812 <td>authorid</td> 3813 <td>ID of the current items author</td> 3814 </tr><tr> 3815 <td>blogid</td> 3816 <td>ID of the blog</td> 3817 </tr><tr> 3818 <td>catid</td> 3819 <td>ID of the category for the current item</td> 3820 </tr><tr> 3821 <td>query</td> 3822 <td>search query (if there is one)</td> 3823 </tr><tr> 3824 <td><a href="#templatevar-syndicate_title">syndicate_title</a></td> 3825 <td>Syndicated title</td> 3826 </tr><tr> 3827 <td><a href="#templatevar-syndicate_description">syndicate_description</a></td> 3828 <td>Syndicated body text</td> 3829 </tr><tr> 3830 <td>karmaposlink</td> 3831 <td>raw vote link</td> 3832 </tr><tr> 3833 <td>karmaneglink</td> 3834 <td>raw vote link</td> 3835 </tr><tr> 3836 <td>new</td> 3837 <td>'New Item!'-text</td> 3838 </tr><tr> 3839 <td><a href="#skinvar-include">include</a></td> 3840 <td>includes a file, whithout parsing</td> 3841 </tr><tr> 3842 <td><a href="#skinvar-parsedinclude">parsedinclude</a></td> 3843 <td>includes a file, parsing it</td> 3844 </tr><tr> 3845 <td><a href="#skinvar-phpinclude">phpinclude</a></td> 3846 <td>includes a file, parsing by PHP</td> 3847 </tr><tr> 3848 <td><a href="#skinvar-plugin">plugin</a></td> 3849 <td>executes a plugin</td> 3850 </tr><tr> 3851 <td><a href="#templatevar-edit">edit</a></td> 3852 <td>inserts an 'edit this item' link</td> 3853 </tr><tr> 3854 <td><a href="#templatevar-editlink">editlink</a></td> 3855 <td>raw 'edit item' link (links to bookmarklet)</td> 3856 </tr><tr> 3857 <td><a href="#templatevar-editpopupcode">editpopupcode</a></td> 3858 <td>javascript code to open a popup window for editlink</td> 3859 </tr><tr> 3860 <td><a href="#skinvar-skinfile">skinfile</a></td> 3861 <td>includes the correct URL for a file belonging to an imported skin</td> 3862 </tr><tr> 3863 <td><a href="#skinvar-set">set</a></td> 3864 <td>sets a parser property</td> 3865 </tr><tr> 3866 <td><a href="#templatevar-image">image</a></td> 3867 <td>inline image from media library</td> 3868 </tr><tr> 3869 <td><a href="#templatevar-popup">popup</a></td> 3870 <td>popup image from media dir</td> 3871 </tr><tr> 3872 <td><a href="#templatevar-media">media</a></td> 3873 <td>other media object from media dir</td> 3874 </tr><tr> 3875 <td>relevance</td> 3876 <td>Includes the 'search hit relevance' in templates that display search results</td> 3877 </tr></table> 3878 3879 <p><a href="#templatevars-overview">Template variables overview...</a></p> 3880 3881 </div> 3882 3883 3884 3885 3886 <div class="page"> 3887 <a name="templatevars-comments"></a> 3888 <h1>Template variables: Comments</h1> 3889 3890 3891 <table><tr> 3892 <th>Name</th> 3893 <th>Description</th> 3894 </tr><tr> 3895 <td>body</td> 3896 <td>comment body</td> 3897 </tr><tr> 3898 <td>user</td> 3899 <td>user name</td> 3900 </tr><tr> 3901 <td>userid</td> 3902 <td>users URL or e-mail address</td> 3903 </tr><tr> 3904 <td>userlink</td> 3905 <td>a smart link to either the e-mail or URL for non members, or the member detail page for members. Note: this link already includes the <a href="..."> and </a> tags ! (when no valid URL or e-mail is available, only the name of the member will be shown)</td> 3906 </tr><tr> 3907 <td>userlinkraw</td> 3908 <td>same as above, but without the <a href.., empty when no valid URL or e-mail available</td> 3909 </tr><tr> 3910 <td>useremail</td> 3911 <td>the e-mail address of the user, empty if the e-mail address was not provided by the user</td> 3912 </tr><tr> 3913 <td>userwebsite</td> 3914 <td>the URL of the users website, empty if the URL was not provided by the user</td> 3915 </tr><tr> 3916 <td>userwebsitelink</td> 3917 <td>a smart link to URL for non members, or the member detail page for members. Note: this link already includes the <a href="..."> and </a> tags ! (when no valid URL, only the name of the member will be shown)</td> 3918 </tr><tr> 3919 <td>memberid</td> 3920 <td>ID of the member (0 for non-members)</td> 3921 </tr><tr> 3922 <td>commentcount</td> 3923 <td>total amount of comments for the item</td> 3924 </tr><tr> 3925 <td><a href="#templatecommentwords" title="commentword()">commentword</a></td> 3926 <td>1 'comment', 2 'comments'</td> 3927 </tr><tr> 3928 <td><a href="#templatevar-date" title="date([format])">date</a></td> 3929 <td>date on which comment was added</td> 3930 </tr><tr> 3931 <td><a href="#templatevar-time" title="time([format])">time</a></td> 3932 <td>time at which comment was added</td> 3933 </tr><tr> 3934 <td>host</td> 3935 <td>host from where comment was added</td> 3936 </tr><tr> 3937 <td>ip</td> 3938 <td>IP-address from where comment was added</td> 3939 </tr><tr> 3940 <td>commentid</td> 3941 <td>ID of the current comment</td> 3942 </tr><tr> 3943 <td>itemid</td> 3944 <td>ID of the current item</td> 3945 </tr><tr> 3946 <td>itemlink</td> 3947 <td>link to the detailed item page</td> 3948 </tr><tr> 3949 <td><a href="#templateitemtitle" title="itemtitle([maxlength])">itemtitle</a></td> 3950 <td>Title of the current item</td> 3951 </tr><tr> 3952 <td>blogid</td> 3953 <td>ID of the weblog</td> 3954 </tr><tr> 3955 <td>blogurl</td> 3956 <td>URL of the weblog</td> 3957 </tr><tr> 3958 <td><a href="#templatememberextra" title="authtext()">authtext</a></td> 3959 <td>the extra text</a> for members, empty for non members</td> 3960 </tr><tr> 3961 <td>short</td> 3962 <td>a cut off version of the body, which truncates after the first line break. <a href="#templatecommentcontinued">A link is added</a> at the end according to the template</td> 3963 </tr><tr> 3964 <td>excerpt</td> 3965 <td>the body of the comment, cut at 60 characters and appended with '...'</td> 3966 </tr><tr> 3967 <td>timestamp</td> 3968 <td>time at which comment was added</td> 3969 </tr><tr> 3970 <td><a href="#skinvar-include" title="include(filename)">include</a></td> 3971 <td>includes a file, whithout parsing</td> 3972 </tr><tr> 3973 <td><a href="#skinvar-parsedinclude" title="parsedinclude(filename)">parsedinclude</a></td> 3974 <td>includes a file, parsing it</td> 3975 </tr><tr> 3976 <td><a href="#skinvar-phpinclude" title="phpinclude(filename)">phpinclude</a></td> 3977 <td>includes a file, parsing by PHP</td> 3978 </tr><tr> 3979 <td><a href="#skinvar-plugin" title="plugin(name,[options...])">plugin</a></td> 3980 <td>executes a plugin</td> 3981 </tr><tr> 3982 <td><a href="#skinvar-skinfile" title="skinfile(filename)">skinfile</a></td> 3983 <td>includes the correct URL for a file belonging to an imported skin</td> 3984 </tr><tr> 3985 <td><a href="#skinvar-set" title="set(property,value)">set</a></td> 3986 <td>sets a parser property</td> 3987 </tr></table> 3988 3989 3990 3991 <p><a href="#templatevars-overview">Template variables overview...</a></p> 3992 3993 </div> 3994 3995 3996 3997 <div class="page"> 3998 <a name="templatevar-karma"></a> 3999 <h1>Templatevar: karma</h1> 4000 4001 <p>Inserts karma votes data. Karma votes are a method to vote the 'karma' of an item. With a single click, the visitor can vote either positive or negative. The total of all these votes gives an idea of how much an item is liked by the visitors</p> 4002 4003 <h2>Arguments</h2> 4004 4005 4006 <ul>Optional: 4007 <ul> 4008 <li><strong><em>what</em></strong>: Choose a type of information to be displayed: 4009 <ul> 4010 <li><strong>totalscore</strong>: the total karma vote score (=amount of positive votes minus the amount of negative votes) <em>(default)</em></li> 4011 <li><strong>pos</strong>: total number of positive votes</li> 4012 <li><strong>neg</strong>: total number of negative votes</li> 4013 <li><strong>votes</strong>: total number of votes</li> 4014 <li><strong>posp</strong>: percentage of votes that is positive</li> 4015 <li><strong>negp</strong>: percentage of votes that is negative</li> 4016 </ul> 4017 </li> 4018 </ul> 4019 </ul> 4020 4021 <h2>Examples</h2> 4022 <pre><code><%karma(posp)%> out of <%karma(votes)%> were positive</code></pre> 4023 4024 4025 </div> 4026 4027 4028 4029 <div class="page"> 4030 <a name="templateitemtitle"></a> 4031 <h1>Templatevar: templateitemtitle</h1> 4032 4033 <p>On comments-releated templateparts, inserts the title of the associated item.</p> 4034 4035 <h2>Arguments</h2> 4036 4037 <ul>Optional: 4038 <ul> 4039 <li><strong><em>maxlength</em></strong>: When provided, makes the itemtitle behave like the <a href="#templatevar-syndicate_title">syndicate_title templatevar</a>. 4040 </li> 4041 </ul> 4042 </ul> 4043 4044 </div> 4045 4046 4047 4048 4049 4050 4051 <div class="page"> 4052 <a name="templatevar-author"></a> 4053 <h1>Templatevar: author</h1> 4054 4055 <p>Inserts the name of the author</p> 4056 4057 <h2>Arguments</h2> 4058 <ul>Optional: 4059 <ul> 4060 <li><strong><em>what</em></strong>: Choose a type of information to be displayed: 4061 <ul> 4062 <li><strong>name</strong>: display name <em>(default)</em></li> 4063 <li><strong>realname</strong>: the real name of the author instead of the display name</li> 4064 <li><strong>id</strong>: Nucleus membet ID</li> 4065 <li><strong>url</strong>: URL of members website</li> 4066 <li><strong>email</strong>: email address of member (use of this one should be avoided)</li> 4067 </ul> 4068 </li> 4069 </ul> 4070 </ul> 4071 4072 <h2>Examples</h2> 4073 4074 <pre><code><%author%> 4075 <%author(realname)%> 4076 <a href="<%author(url)%>"><%author%></a></code></pre> 4077 4078 </div> 4079 4080 4081 4082 4083 <div class="page"> 4084 <a name="templatevar-smartbody"></a> 4085 <h1>Templatevar: smartbody</h1> 4086 4087 <p> 4088 Examines the current item and then decides to show either the body text or the expanded text. 4089 </p> 4090 4091 <p>When the extended part is empty, the body part is chosen. Otherwise the extended part is shown.</p> 4092 4093 <table style="text-align: center;"><tr> 4094 <th>Part</th><th colspan="2">Empty?</th> 4095 </tr><tr> 4096 <td>Body</td><td>No</td><td>No</td> 4097 </tr><tr> 4098 <td>Extended</td><td>Yes</td><td>No</td> 4099 </tr><tr> 4100 <th>smartbody=</th><th>body part</th><th>extended part</th> 4101 </tr></table> 4102 4103 <h2>Example use</h2> 4104 4105 <p>The body text could be interpreted as your full text, and the extended part could be interpreted as an 'introduction' or 'exerpt', which you want to show on the front page.</p> 4106 <p>In the template used on the front page, you would use <tt><%smartbody%></tt> to insert an excerpt (if there is one), or the full text (if no excerpt). In the template for detailed items, <tt><%body%></tt> can then be used instead of the usual <tt><%body%></tt> + <tt><%more%></tt>, since <tt><%body%></tt> will contain the full item anyway.</p> 4107 4108 4109 4110 4111 </div> 4112 4113 4114 <div class="page"> 4115 <a name="templatevar-morelink"></a> 4116 <h1>Templatevar: morelink</h1> 4117 4118 <p> 4119 Inserts a link to the detail page for the item, as defined in the template (<a href="#templatemorelink">link to extended entry</a>). This is empty when there is no extended part. 4120 </p> 4121 4122 <p>Note that the contents of the 'link to extended entry' templatepart is also parsed and can thus also contain <a href="#templatevars-overview">templatevariables</a>.</p> 4123 </div> 4124 4125 4126 <div class="page"> 4127 <a name="templatevar-date"></a> 4128 <h1>Templatevar: date</h1> 4129 4130 <p> 4131 Inserts a date using the <a href="#templatedatetime">date format specified in the template</a>. Optionally, a custom date format can be given as a parameter. 4132 </p> 4133 4134 <h2>Arguments</h2> 4135 <ul>Optional 4136 <ul> 4137 <li><strong><i>format</i></strong>: format to be used to format the date</li> 4138 </ul> 4139 </ul> 4140 4141 <h2>Specials</h2> 4142 4143 <p>Four special parameters are possible:</p> 4144 <ol> 4145 <li><code>rfc822</code>: RFC822 date in local time</li> 4146 <li><code>rfc822GMT</code>: RFC date in GMT time</li> 4147 <li><code>iso8601</code>: ISO-8601 date (<a href="http://www.w3.org/TR/NOTE-datetime">W3C Date and Time Format</a> profile). Example: 2002-10-02T10:00:00-05:00</li> 4148 <li><code>utc</code>: Same as iso8601, but the date is expressed in UTC, using a "Z" for the timezone indicator.</li> 4149 </ol> 4150 4151 <h2>Examples</h2> 4152 <pre> 4153 <%date%> 4154 <%date(%x)%> 4155 <%date(rfc822)%> 4156 <%date(rfc822GMT)%> 4157 </pre> 4158 4159 4160 </div> 4161 4162 <div class="page"> 4163 <a name="templatevar-time"></a> 4164 <h1>Templatevar: time</h1> 4165 4166 <p> 4167 Inserts a time using the <a href="#templatedatetime">time format specified in the template</a>. Optionally, a custom time format can be given as a parameter. 4168 </p> 4169 4170 <h2>Arguments</h2> 4171 <ul>Optional 4172 <ul> 4173 <li><strong><i>format</i></strong>: format to be used to format the time</li> 4174 </ul> 4175 </ul> 4176 4177 <h2>Examples</h2> 4178 <pre> 4179 <%time%> 4180 <%time(%X)%> 4181 </pre> 4182 4183 </div> 4184 4185 4186 <div class="page"> 4187 <a name="templatevar-comments"></a> 4188 <h1>Templatevar: comments</h1> 4189 4190 <p> 4191 Inserts a comments 'block'. <a href="#templatecomments">More information about the structure of this block</a>. 4192 </p> 4193 4194 <h2>Arguments</h2> 4195 <ul><p>Optional:</p> 4196 <table><tr> 4197 <th>Name</th> 4198 <th>Contents</th> 4199 </tr><tr> 4200 <td>MaxToShow</td> 4201 <td>Amount of comments to show (when set, this overrides the <a href="#blogmaxcomments">max. comments blogsetting</a>)</td> 4202 </tr></table> 4203 </ul> 4204 4205 <h2>Examples</h2> 4206 4207 <pre> 4208 <%comments%> 4209 <%comments(5)%> 4210 </pre> 4211 4212 </div> 4213 4214 4215 <div class="page"> 4216 <a name="templatevar-syndicate_title"></a> 4217 <h1>Templatevar: syndicate_title</h1> 4218 4219 <p> 4220 Inserts the title of the item, with HTML tags-stripped off, and shortened to 100 characters. When the text needs to be shortened, "..." is added at the end of the text. 4221 </p> 4222 4223 <p> 4224 This variable was originally intended for use in the XML-RSS skin that comes with Nucleus, but can also be of use in other situations. 4225 </p> 4226 4227 <h2>Arguments</h2> 4228 <ul> 4229 <li> 4230 <p>Optional:</p> 4231 <table><tr> 4232 <th>Name</th> 4233 <th>Contents</th> 4234 </tr><tr> 4235 <td>MaxChars</td> 4236 <td>Maximum amount of characters to keep (defaults to 100)</td> 4237 </tr></table> 4238 </li> 4239 </ul> 4240 4241 <h2>Examples</h2> 4242 4243 <pre> 4244 <%syndicate_title%> 4245 <%syndicate_title(25)%> 4246 </pre> 4247 4248 </div> 4249 4250 <div class="page"> 4251 <a name="templatevar-syndicate_description"></a> 4252 <h1>Templatevar: syndicate_description</h1> 4253 4254 <p> 4255 Inserts the body of the item, with HTML tags-stripped off, and shortened to 250 characters. When the text needs to be shortened, "..." is added at the end of the text. 4256 </p> 4257 4258 <p> 4259 This variable was originally intended for use in the XML-RSS skin that comes with Nucleus, but can also be of use in other situations. 4260 </p> 4261 4262 <h2>Arguments</h2> 4263 <ul> 4264 <li> 4265 <p>Optional:</p> 4266 <table><tr> 4267 <th>Name</th> 4268 <th>Contents</th> 4269 </tr><tr> 4270 <td>MaxChars</td> 4271 <td>Maximum amount of characters to keep (defaults to 250)</td> 4272 </tr></table> 4273 </li> 4274 </ul> 4275 4276 <h2>Examples</h2> 4277 4278 <pre> 4279 <%syndicate_description%> 4280 <%syndicate_description(25)%> 4281 </pre> 4282 4283 </div> 4284 4285 4286 <div class="page"> 4287 <a name="templatevar-image"></a> 4288 <h1>Templatevar: image</h1> 4289 4290 <p>Inserts an inline image into an item body or template.</p> 4291 4292 <p>In normal use, the image-templatevar is generated automatically when adding images through the media library. You can call it from within templates too, though. Note that in this last case, the image will come out of the media dir of the current item's author.</p> 4293 4294 <h2>Arguments</h2> 4295 <ul> 4296 <li> 4297 <p>Required:</p> 4298 <table><tr> 4299 <th>Name</th> 4300 <th>Contents</th> 4301 </tr><tr> 4302 <td>filename</td> 4303 <td>Name of the image file (file gets)</td> 4304 </tr><tr> 4305 <td>width</td> 4306 <td>Width of the image (pixels or percentage)</td> 4307 </tr><tr> 4308 <td>height</td> 4309 <td>Height of the image</td> 4310 </tr><tr> 4311 <td>text</td> 4312 <td>alt-text for the image</td> 4313 </tr></table> 4314 </li> 4315 <li><strong>Note:</strong> for the image, popup and media tags, the parameters must be separated by the '|' character, <em>not</em> by a comma!</li> 4316 </ul> 4317 4318 <h2>Examples</h2> 4319 4320 <pre> 4321 <%image(myphoto.jpg|100|200|this is me)%> 4322 <%image(myphoto.jpg|50%|50%|this is me, but smaller)%> 4323 </pre> 4324 4325 </div> 4326 4327 4328 4329 <div class="page"> 4330 <a name="templatevar-popup"></a> 4331 <h1>Templatevar: popup</h1> 4332 4333 <p>Inserts a popup image into an item body or template.</p> 4334 4335 <p>In normal use, the popup-templatevar is generated automatically when adding images through the media library. You can call it from within templates too, though. Note that in this last case, the image will come out of the media dir of the current item's author.</p> 4336 4337 <h2>Arguments</h2> 4338 <ul> 4339 <li> 4340 <p>Required:</p> 4341 <table><tr> 4342 <th>Name</th> 4343 <th>Contents</th> 4344 </tr><tr> 4345 <td>filename</td> 4346 <td>Name of the image file (file gets)</td> 4347 </tr><tr> 4348 <td>width</td> 4349 <td>Width of the image (pixels or percentage)</td> 4350 </tr><tr> 4351 <td>height</td> 4352 <td>Height of the image</td> 4353 </tr><tr> 4354 <td>text</td> 4355 <td>alt-text for the image</td> 4356 </tr></table> 4357 </li> 4358 <li><strong>Note:</strong> for the image, popup and media tags, the parameters must be separated by the '|' character, <em>not</em> by a comma!</li> 4359 </ul> 4360 4361 <h2>Examples</h2> 4362 4363 <pre> 4364 <%popup(myphoto.jpg|100|200|this is me)%> 4365 <%popup(myphoto.jpg|50%|50%|this is me, but smaller)%> 4366 </pre> 4367 4368 </div> 4369 4370 4371 4372 <div class="page"> 4373 <a name="templatevar-media"></a> 4374 <h1>Templatevar: media</h1> 4375 4376 <p>Inserts a media object into an item body or template.</p> 4377 4378 <p>In normal use, the media-templatevar is generated automatically when adding images through the media library. You can call it from within templates too, though. Note that in this last case, the object will come out of the media dir of the current item's author.</p> 4379 4380 <h2>Arguments</h2> 4381 <ul> 4382 <li> 4383 <p>Required:</p> 4384 <table><tr> 4385 <th>Name</th> 4386 <th>Contents</th> 4387 </tr><tr> 4388 <td>filename</td> 4389 <td>Name of the image file (file gets)</td> 4390 </tr><tr> 4391 <td>text</td> 4392 <td>descriptive text for the media object</td> 4393 </tr></table> 4394 </li> 4395 <li><strong>Note:</strong> for the image, popup and media tags, the parameters must be separated by the '|' character, <em>not</em> by a comma!</li> 4396 </ul> 4397 4398 <h2>Examples</h2> 4399 4400 <pre><code><%media(mysong.mp3|listen to my new song)%></code></pre> 4401 4402 </div> 4403 4404 4405 <div class="page"> 4406 <a name="templatevar-edit"></a> 4407 <h1>Templatevar: edit</h1> 4408 4409 <p> 4410 From within your template, you can add an 'edit item' link by using this template variable. By default, it will link to a popup-bookmarklet-window, but that behaviour can be changed through the <a href="#templateeditlink">editlink template</a>. 4411 </p> 4412 4413 <p><strong>Note:</strong> only logged in members that are allowed to edit the item will see this link. In other cases, the edit-templatevar does nothing at all.</p> 4414 4415 <h2>Example</h2> 4416 <p>An example for the item body template</p> 4417 <pre><code><h1><%title%></h1> 4418 <p><%body%> <%morelink%></p> 4419 <div class="metadata"> 4420 <%edit%> <%comments%> 4421 </div></code></pre> 4422 4423 <h2>Results in</h2> 4424 4425 <div class="example"> 4426 <h4 style="margin:2px;">Title</h4> 4427 <p style="margin:2px;">This is an item</p> 4428 <div style="margin:2px;"><a href="#templatevar-edit">edit</a> - <a href="#templatevar-edit">5 comments</a></div> 4429 </div> 4430 4431 </div> 4432 4433 4434 <div class="page"> 4435 <a name="templatevar-editlink"></a> 4436 <h1>Templatevar: editlink</h1> 4437 4438 <p> 4439 Insert a link to the 'edit item' bookmarklet. This can be used in the <a href="#templateeditlink">editlink template</a> for simplicity. 4440 </p> 4441 4442 <h2>Example</h2> 4443 4444 <p>The <a href="#templateeditlink">'edit link'-template</a> could look like this:</p> 4445 <pre> 4446 <a href="<%editlink%>" 4447 onclick="<%editpopupcode%>">edit</a> - 4448 </pre> 4449 4450 </div> 4451 4452 4453 <div class="page"> 4454 <a name="templatevar-editpopupcode"></a> 4455 <h1>Templatevar: editpopupcode</h1> 4456 4457 <p> 4458 To open a popup window for the 'edit link' window, you'll need to add some javascript code to your link. To avoid having to enter this code in the 'edit link'-template, you can insert it using the editpopupcode-templatevar. 4459 </p> 4460 4461 <h2>Example</h2> 4462 <p>See the example for the <a href="#templatevar-editlink">editlink templatevar</a></p> 4463 </div> 4464 4465 4466 4467 <div class="page"> 4468 <a name="plugins"></a> 4469 <h1>Plugins</h1> 4470 <p> 4471 Nucleus allows you to install custom plugins, adding extra functionality. Plugins can do different things: 4472 </p> 4473 <ol> 4474 <li>Act as a skin variable</li> 4475 <li>Act as a template variable</li> 4476 <li>Hook into events generated by Nucleus. The 'move up' and 'move down' links in 'manage plugins' screen can be used to define the order in which plugins will be called when such an event occurs. The first plugin in the list will be called first, the last one will be called last.</li> 4477 <li>Act as actors when called through <tt>action.php</tt></li> 4478 </ol> 4479 <p> 4480 Note that the responsibility for plugins is entirely with the plugin author. He should make sure that everything works fine. 4481 </p> 4482 <a name="getplugins"></a> 4483 <p> 4484 There are two main repositories where you can find plugins for Nucleus CMS: 4485 </p> 4486 <ul> 4487 <li><a href="http://wiki.nucleuscms.org/plugin" title="Plugin Wiki">English</a></li> 4488 <li><a href="http://japan.nucleuscms.org/wiki/plugins" title="Japanese Plugin Wiki">Japanese</a></li> 4489 </ul> 4490 <p> 4491 Neither or these repositories is entirely complete. You will find some plugins in one, but not in the other, and vice versa. 4492 Do not be scared off of one or the other on account of language, as there are a few free translation services on the Internet that 4493 will help you get by. 4494 </p> 4495 Another resource that will help you while working with plugins is the search function at the 4496 <a href="http://forum.nucleuscms.org/" title="Support Forum">support forum</a>. You will even find some 4497 smaller plugins on the forum that never made it to the wiki. 4498 <p> 4499 </p> 4500 </div> 4501 4502 <div class="page"> 4503 <a name="parser-properties"></a> 4504 <a name="includemode"></a> 4505 <a name="includeprefix"></a> 4506 <h1>Parser Properties</h1> 4507 4508 <p>The available parser options are described below.</p> 4509 4510 <table> 4511 <caption>Parser properties</caption> 4512 <tr> 4513 <th>Option Name</th> 4514 <th>Values</th> 4515 </tr><tr> 4516 <td>IncludeMode</td> 4517 <td> 4518 <ul> 4519 <li><strong>normal</strong>: normal behaviour; included files are taken relative to the directory/url of the .php file generating the page.</li> 4520 <li><strong>skindir</strong>: included files are taken relative to the skindir/skinurl</li> 4521 </ul> 4522 <p>This property affects the following skinvars: <a href="#skinvar-include">include</a>, <a href="#skinvar-phpinclude">phpinclude</a>, <a href="#skinvar-parsedinclude">parsedinclude</a>, <a href="#skinvar-nucleusbutton">nucleusbutton</a></p> 4523 </td> 4524 </tr><tr> 4525 <td>IncludePrefix</td> 4526 <td> 4527 <p>This property is a prefix that get's added in front of each filename you want to include. For example, if the prefix is <tt>base/</tt> and you want to include <tt>somefile.txt</tt>, you'll end up including <tt>base/somefile.txt</tt></p> 4528 <p>This property is intended to be used in conjunction with the IncludeMode property. This way, a skin imported to <tt><em>skindir/</em>somename/</tt> can set <tt>IncludeMode</tt> to <tt>skindir</tt> and <tt>IncludePrefix</tt> to <tt>somename/</tt></p> 4529 <p>This property affects the following skinvars: <a href="#skinvar-include">include</a>, <a href="#skinvar-phpinclude">phpinclude</a>, <a href="#skinvar-parsedinclude">parsedinclude</a>, <a href="#skinvar-nucleusbutton">nucleusbutton</a></p> 4530 </td> 4531 </tr> 4532 </table> 4533 4534 <p>The <tt>IncludePrefix</tt> and <tt>IncludeMode</tt> properties can be set globally for a skin in the general settings of a skin. Also note that from the moment a property is set, it applies to all parsed data, thus also for templates.</p> 4535 4536 </div> 4537 4538 </body> 4539 </html>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Sun Aug 1 03:56:06 2010 |