Extension page template

From FusionWiki

Jump to: navigation, search

This is the new extension template page.

To create a page for an extension, press edit and copy everything in the 'Template' section over to the new page. Help for each section has been placed in the guidelines below and between HTML comments (<!-- and -->) in the template.

Contents

Guidelines for creating extension pages

If you create an article for an Extension, use the new template below.

Most important

  1. The new template places emphasis on describing features, usage and what the extension can be used for.
  2. Action, Condition and Expression lists are optional. Important Actions, Conditions and Expressions can be woven into the general text of the article, and separate lists for these should only be created if the extension has limited or no documentation, or if they need further explanation.
  3. Aim for clear, concise descriptions. Please keep in mind that the purpose of this extension database is to orient users who are unfamiliar with these extensions. Consider this: If you would be a user new to the extension or one trying to find an extension to suit a purpose, what kind of information would you need?
  4. At the end of the article, External links should be included (if they are available) for:
    1. The extension's website
    2. The extension's forum on the Clickteam forum
    3. Relevant examples and tutorials
  5. For good examples, see Surface and XLua.

Introductory text

  1. Even if there's nothing else about the article listed, the first sentences should make clear what the extension can be used for, and why it should be used for the given task it performs.
  2. The last paragraph of the introduction should mention any other crucial aspects of the extension, if they apply:
    1. If the extension is the successor of another extension, or if it has been replaced by another extension.
    2. If the extension is Developer-only, or has other limitations on use (for example, the author requires a license fee if the extension is used commercially), this should also be mentioned in the last paragraph.
    3. If the extension can not be used in the normal PC runtime (for example, in the case of Flash-only extensions.)

The template box

  1. First, fill in the icon's to-be filename. You can check the icons at Category:Object_Icon to see whether the extension already has an icon uploaded. If there is no icon for the extension, you can either choose to:
    1. Leave it as it is and wait for someone else to upload it.
    2. Upload an image yourself (recommended). If the extension has a website and there is an icon available already, just use that image file. If there's no icon available, you can go into Multimedia Fusion 2's Create New Object dialog, remove the check from the 'List' option and press printscreen. You can then copy and crop the extension icon with your image editing software of choice (if you don't have one, IrfanView is a good freeware choice). The end result should be a 32x32 image which you can then save in the PNG format and proceed with uploading to FusionWiki. After you finish uploading, edit your image page and add the text [[Category:Object_Icon]] to ensure the image shows up on Category:Object_Icon.
  2. For the author's name, the template's default link redirects to the Clickteam-related developers page where developers are listed. If a section is not yet created for this author, one can be created with the default markup written between the invisible HTML comments. If its a core extension, simply input [[Clickteam]].
  3. For the build section, enter the lowest build the extension works with. Especially in the case of older extensions, information may not be available for what build the extension requires. If the extension is very old (ie. 2006, 2007), it is safe to write All as builds that old are no longer available. Alternatively, to be on the safe side, you can use the {{Current build}} markup, which updates automatically as new builds come out. If the Extension is a built-in extension that comes with the program, the Build field can simply say Core.
  4. The Website field should link either to the Extension's website, to the developer's website, or if both are unavailable, to the extension's thread in the Released Extensions forum.
  5. The Download field, on the other hand, should link directly to the download file, or to the bonus back that the extension is contained in.
  6. If in doubt about what runtime versions the extension supports, input Unknown.

Final steps: linking in from the Extension hub

  1. When you are done, go to the Extensions article, find the category for the given extension and link the finished article in.
  2. In the first column, link in the
  3. Be sure to provide an easy to understand, one-sentence description for what the extension can be used for.
  4. If your extension article just contains basic information, be sure to include the kind of information that is to be written in the last column, called Article needs

The extension template

Extension page template
File:Extension-EXTENSION NAME-icon.png
General Information
Author: Author Name
Release Date: Year
Status: Released / Beta / In development / Obsolete / Private / Canceled / Unknown
Last updated: Unknown
Version: Unknown
Build: 249
Developer-only: Yes / No
Website: Website link
Download: Download link
Runtime Versions
HWA: Yes / No / Unknown
Flash: Yes / No / Unknown
Java: Yes / No / Unknown
Java Mobile: Yes / No / Unknown
Vitalize!: Yes / No / Unknown
Unicode: Yes / No / Unknown


Extension name is an extension for Multimedia Fusion 2 written by Author name.

Main features

  • Feature
  • Feature
  • Feature

Usage

This is an example, as seen on the get object's page

Here's an example of how to get a page with the Get object. A string object is used to indicate the progress, and a rich edit box is used for the page content.

1
  • Start of Frame

    •  : Get "http://www.clickteam.info/davidn/clickquote/index.php"

2
  •  : Get is pending
  • Only one action when event loops

    •  : Set Alterable String to "Getting URL..."

3
  •  : On get complete

    •  : Set text to Content$("")

     : Set Alterable String to "Get Complete!"

External links

Optional fields for an extension page

Include Action, Condition, Expression and property lists only if needed.

Actions, Conditions and Expressions

Actions

  • Some Action - List all actions like this


Conditions

  • Some Condition [Immediate] - List all immediate conditions like this
  • Some Condition [Negatable] - List all negatable conditions like this


Expressions

  • Some Expression (Expression$) - list all string expressions like this
  • Some Expression (Expression) - list all numeric expressions like this


Properties

Property category

  • Property
  • Property

Options

  • Property
Retrieved from "http://www.fusionwiki.com/wiki/Extension_page_template"
Personal tools