Tags:
create new tag
, view all tags

Feature Proposal: Extension documentation to be made end user friendly

Motivation

An extension (plug-in, add-on, or contrib package) has its documentation on the topic of its name (e.g. SpreadSheetPlugin). That topic has description for both administrators and end users and is sometimes confusing for end users especially for new comers.

Description and Documentation

How about making it a rule to put information for administrators at the bottom of those topics, clearly say it is for administrators, and folded by default?

Examples

Impact

WhatDoesItAffect: Documentation

Implementation

-- Contributors: HideyoImazu - 2012-12-21

Discussion

Good idea. I presume this is mainly for the sections:

  • Plugin Settings
  • Plugin Installation Instructions

Correct?

I think we still should have those sections with headings, but content hidden in twisties.

-- PeterThoeny - 2012-12-28

You are correct. My intention is to make it clear how to use the features provided by an extension (for users) and how to install/configure it (for administrators).

-- HideyoImazu - 2013-01-03

I changed the state to ImplementedAsExtension.

I am working on this one. Extension owners are encouraged to fix their extensions too. Let's all use TWikibug:Item7123 for this work.

Sample extensions that have been fixed, for reference:

  • DatePickerPlugin - hides Detailed Documentation, and Installation Instructions; Installation Instructions shows short note outside of twisty
  • SpreadSheetPlugin - hides Plugin Settings, Installation Instructions, and Change History in Info Table (long history); pre-installed plugin shows short note outside of twisty in Installation Instructions

Special note on using a twisty in the Plugin Info table: It is not possible to collapse/expand multiple table rows. The next best thing is to show three consecutive tables: Normal rows, twisty rows (with Change History), normal rows. In order to align the columns properly, a =%TABLE{ tablewidth="100%" columnwidths="170," }% is used for all three consecutive tables.

-- Peter Thoeny - 2013-01-10

Edit | Attach | Watch | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r6 - 2013-01-10 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.