Previous Chapter
Next Chapter
Table of Contents
Index

About this manual
Contents of This Manual
   Conventions
Changes since the first edition
Getting in touch with us

Introduction


About this manual

This manual is made up of three parts. The first three chapters constitute the Users' guide, and the remaining parts make up the Administrator's and Programmer's guide. The manual is not intended to be read in one sitting. Instead, we recommend that you read the introductory parts and then skip around to see what you will find interesting.

Each chapter of the manual is divided into two "columns". The right column holds the contents while the left column consists of links to the different parts of the chapter.

The reader is assumed to have a basic general knowledge of web page building and to be acquainted with concepts such as client and browser.

Contents of This Manual

Part 1 User's Guide

The User's guide is divided into four chapters. The first chapter describes the Roxen Macro Language (RXML) tags and gives you examples of how and when to use them. Chapter Two gives an introduction to image maps and also shows how image maps are created with Roxen, and the third chapter describes the graphical text tags which allow you to write graphical text without the use of an image editor. The User's guide ends with an example section with somewhat more extensive examples combining the information presented in the different chapters. Its aim is to give you a rough idea of what you can do using these tools.

Part 2 Administrator's Guide

The Administrator's guide is divided into five chapters. The first chapter is about installing Roxen. Chapter Two gives a brief description of the configuration interface, and Chapter Three shows the basic operations needed to get started with Roxen. Chapter Four is an overview of the Roxen configuration interface, describing the different variables and settings. Finally, the fifth chapter describes the existing modules and their use.

Part 3 Programmer's Guide

This is the smallest of the parts, consisting only of one chapter and a small amount of reference text. This one chapter is a guide to writing Pike modules acceptable to a Roxen server, and does not actually teach Pike programming. For this we refer to the actual Pike manual.
The Programmer's guide consists of only one chapter and some reference text.This chapter is a short guide to writing Roxen modules. It does not attempt to teach you Pike. Rather, it describes how a piece of Pike code should be written to be accepted as a module by Roxen. One might feel that it does not qualify as a separate section. Still, it does not easily fit into any of the other sections, and it might grow with time.

Conventions

Monospace is used for:
  • representing examples of code
  • HTML and RXML tags and attributes
  • command lines and options that should be typed on the screen
  • filenames and directories

Italics is used for:

  • Internet addresses such as domain names and URLs
  • to emphasize a term or expression

When you have to fill in a value we indicate this by writing a dummy value between »...«. Replace the dummy value and the »...« with the proper value.


Note: presents interesting pieces of information related to the surrounding discussion.


Tip: a tip offers advice or teaches an easier way to do something.


Warning: advises you about potential problems and helps you steer clear of disaster.

To make it easier for you to spot the examples we have put them in light-grey boxes;

Example

We suggest that you best use the examples by studying and experimenting with them.

Changes since the first edition

The second edition contains numerous improvements suggested by instructors who have used the first edition. These improvements include the following;

We have imcluded hints for creating quality web presentations, and more about getting the most out of your web server. The RXML chapter has been enlarged with more examples and some new tags like the <gtext> tag. As the reader is assumed to have some experience with web page building, the HTML chapter has been excluded.

The Administrator's part has been totally restructured. The Installing Roxen and Basic Configuring chapters have been moved from the User's guide to the Administrator's guide.

The Pike Quick Guide has been excluded from this manual, we instead refer to the on-line Pike manual. The chapter on module programming now contains a section on programming wizards, and a slightly more thorough description of the callback functions.

Getting in touch with us

If you need to get in touch with us or simply wish to express your opinions of Roxen Challenger, the easiest way is by sending an e-mail to us at info@idonex.se. Please help us to improve future editions for this manual by reporting any errors, inaccuracies, bugs and misleading or confusing statements. Please also let us know what we can do to make this manual more useful to you. We take your comments seriously and will try to incorporate reasonable suggestions into future editions.

If you have bought support and live in the USA, call 800-345-0046 and ask for "Collect to Sweden 013-37 68 10". If you live in Sweden, you can call 013-37 68 10 directly.

Previous Chapter
Next Chapter
Table of Contents
Index