Quick Reference

Introduction

What you're currently looking at is a rather new part of RIFE's documentation and it's very far from complete. But what we are aiming for with this section is to write down a different perspective on RIFE. A different approach. Because many people were learning RIFE through the tutorials and afterwards happily work on their own projects. But when they wanted to look something up, they had to search through the whole wiki just to find the specific syntax they needed for their particular problem. That's why we sat down and started this section in order to provide a smarter way to solve those day-to-day routine problems.

You will also find that this section contains a lot of redundant information that can also be found in other places of the wiki, but there point is really to organize the knowledge in a different way, so it can be found quicker and easier.

Chapters

You're almost there. Here is the table of Contents. We tried to make the order of the Sections in somewhat the same order as they would be dealt with in a real project.

• Chapter 1 - Laying the groundwork: XML Configuration
  • Section 1.1 - Element Definition - Define your elements and how they look on the outside.
    • Subsection 1.1.1 - Stock Elements - What element definition are included with RIFE and how to use them.
  • Section 1.2 - Site Structure - Connecting the elements and building your applications backbone.
  • Section 1.3 - Site Repository - This is where all the pieces are put together.
• Chapter 2 - The heart of your software: Implementations
  • Section 2.1 - Element Implementation - Time to get to the actual meat of your project.
  • Section 2.2 - Bean Implementation - How do implement various kinds of beans in RIFE.
  • Section 2.3 - Executor Implementation - Yeah, it's rare, but sometimes you need this scheduler thing. And when you do, you better know how to implement those Executors or else ...
• Chapter 3 - Making it pretty: Templates
  • Section 3.1 - Template Syntax Primer - The Big Four: B, V, BV and I
  • Section 3.2 - Advanced Template Patterns - How to get your logic out of the template and still have all the tools right in your hands.
• Chapter 4 - Time to add some: Flexibility
  • Section 4.1 - Site Configuration - Make your application adopt to any outside conditions.
  • Section 4.2 - I18n And L10n - Of course you want to conquer those strange overseas markets, right?
• Chapter 5 - Databases
  • Section 5.1 - Creating tables - Can't have a database application without them.

What is left to do?

Thanks to Confluence, we can actually put a todo list right here in the Wiki. So, if you want to help out with this guide and you don't know where to start, just pick something from below.