Topic Structure For Foswiki Extensions

Please discuss on the discussion page.

Overview

Update the instructions on this page with your extension:
Extension Name:

Summary

  • Each extension has a topic with the same name as the extension in the Extensions, Support, Tasks, and Development webs on foswiki.org.
  • Support.ExtensionName is a hub that points to Tasks.ExtensionName and Development.ExtensionName.
  • The extension topic links to Foswiki:Support.ExtensionName and Foswiki:Development.ExtensionName.

Details

Each extension must have the following topics on foswiki.org:
  • An extension topic in the Extensions web with the same name as the extension. The extension topic (which is distributed with the extension) has the following two lines in the table at the bottom:
    Plugin Home: http://foswiki.org/Extensions/%TOPIC%
    Support: http://foswiki.org/Support/%TOPIC%
    If there is an appraisal link in the table, please remove it.
  • A support topic in the Support web with the same name as the extension. This topic contains links to the corresponding topics in the Tasks and Development webs. It consists solely of the following:
    %INCLUDE{"ExtensionHub"}%
  • A bug reporting topic in the Tasks web with the same name as the extension. It shows all open bugs and has a button to submit a new bug report. The topic consists solely of the following:
    %INCLUDE{"Component"}%
    
  • A development topic in the Development web with the same name as the extension. It is a free format discussion topic to be used to discuss features and ideas for the specific extension. An introduction at the beginning redirects bug reporters and those in need of support to the appropriate topics in the Tasks and Support web, so the development topic can be for development only. Include the following at the top to generate this introduction:
    %INCLUDE{"ExtensionInclude"}%
    Default extensions also have a paragraph that points to the feature proposal page, for submission of feature requests.

Checklist

Remember to do these steps for new/ported/updated extensions

  • Create topics in Tasks (normally already created), Support, and Development webs.
  • Replace content of any existing xxxDev topic in Extensions web by a link to the Support web Extension topic
  • Replace the link in the extension topic on SVN. It is OK to keep the version number if this is the only change you do.
  • Either manully edit the Extension topic or re-upload the extension using BuildContrib
  • If you port a plugin from TWiki, consider copying important notes from the old Dev topic to the extension topic in the Development web. If you never created a Dev page do not create one. Eventually the Dev topics will be deleted.
This should make the support experience better, and always using the Extension name as the topic name in all four webs makes it easy to remember for community members.
Topic revision: r6 - 22 Mar 2010, WillNorris - This page was cached on 19 Oct 2020 - 12:56.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy