EFiction 3.0

From Efiction

Revision as of 15:15, 27 July 2006 by Admin (Talk | contribs)
(diff) ←Older revision | view current revision (diff) | Newer revision→ (diff)

Contents

Installation

New Installation

Upgrading from 2.0.X

Upgrading from 1.1

Administration

Adding Classifications

Classifications take the place of the genres and warnings from 1.1 and 2.0. The change lets you define your own classifications without hacking into the files. This tutorial will walk through adding a classification type.

1. Goto Admin -> Classifications.

2. Click on "Add New Classification Type".

3. Enter the name and title for the classification type such as "genres" or "warnings". The title can be anything you like. The title will be what is displayed on screen. The name will be used in your skin template as a variable so it should be a unique one word description. As an example: enter the name as "genre" and the title as "Genres".

4. Click "Submit".

5. After you click submit you'll be taken back to the table listing your classification types.

6. Click on the classification type ("Genres" to continue the example). This will take you to the list of classifications within that type.

7. Click "Add New Classifications" to go to the form to add your classifications for that type. You'll have as many blanks on this form as you've set items per page.

8. Enter the classifications (to continue the example: romance, action/adventure, mystery) one in each text box.

9. Click submit.

Skinning

See Creating Skins

Changes to recent, featured, and random blocks

If you intend to use the .tpl option for these blocks, you will need to make some changes. In 2.0 would look something like this:

Code:

<!-- START BLOCK : recentblock -->
<span class="text">{recenttitle} by {recentauthor} ({recentrating})<br> {recentsummary}<br><br></span>
<!-- END BLOCK : recentblock -->

This is an example from the eFiction skin. This is also how the block would look in 1.1 using the same method.

In 3.0, I set it up so that these blocks use the storyblock.php include. Why? So there's only one place to make changes when changes need to be made. This also lets you use all of the variables you can use in the storyblock in any of these other blocks.

Therefore, in the example above, {recenttitle} becomes {title}, {recentauthor} becomes {author}, etc.

Here's the recent block from the CSSZen skin included with the download.

Code:

<!-- START BLOCK : recentblock -->
<div class="recentbox">
<div class="title">{title} by {author}  {roundrobin}  [{reviews} - {numreviews}] {new} </div>
<div class="content"><span class="label">>Summary: </span>{featuredstory}{summary}<br />
<span class="label">Rated:</span> {rating} {score}<br />
<span class="label">Categories:</span> {category} <br />
<span class="label">Characters: </span> {characters}<br />
{classifications}
<span class="label">Series:</span> {serieslinks}<br />
<span class="label">Chapters: </span> {numchapters} {toc}<br />
<span class="label">Completed:</span> {completed} 
<span class="label">Word count:</span> {wordcount} <span class="label">Read Count:</span> {count}
<span class="label"> Published: </span>{published} <span class="label">Updated:</span> {updated} </div>
</div>
<!-- END BLOCK : recentblock -->

Notice you can include a lot more information in the block now.

Again, these changes affect the recent, random, and featured blocks.

Development

This section is intended to help you in the development of mods, modules, and blocks for eFiction 3.0.

Core Functions

The corefunctions.php file in the includes folder provides a number of functions to make doing common tasks in eFiction 3.0 easier. See corefunctions.php for details.

Personal tools