Tags:
create new tag
, view all tags

Feature Proposal: Categorize TWiki Variables & TWiki Variables Wizard

Motivation

The latest TWiki-5.1 release has over 170 TWikiVariables - it can be difficult to find a suitable variable for one's needs. There is already a search function, but it could help if one can browse and search by category.

Description and Documentation

  • Define a fixed list of categories in the TWikiVariables topic.
  • Add a new "Category" bullet to all TWiki Variables topic; add appropriate category or categories to each TWiki Variables topic.
At a later stage, the raw & WYSIWYG editors can give more help on variables bucketized by categories.

Proposed categories:

A category item contains one or more keywords separated by slash. All categories can be retrieved via %INCLUDE{ "%SYSTEMWEB%.TWikiVariablesSearch" section="categories" }% and then with a %GET{twVarCategories}%, which returns a comma-space delimited list of the categories.

The VarXXXX variables doc topics should only use the categories defined in TWikiVariablesSearch.

Variable List

VarACTIVATEDPLUGINS:

VarADDTOHEAD: VarALLVARIABLES: VarAQUA: VarATTACHURLPATH: VarATTACHURL: VarAUTHREALM: VarAUTOCOMPLETE: VarBASETOPIC: VarBASEWEB: VarBB2: VarBB3: VarBB4: VarBB: VarBLACK: VarBLUE: VarBROWN: VarBR: VarBULLET: VarCALC: VarCALCULATE: VarCARET: VarCHART: VarCOMMENT: VarCONTENTMODE: VarDASHBOARD: VarDATETIME: VarDATE: VarDISPLAYTIME2: VarDISPLAYTIME: VarEDITACTION: VarEDITTABLE: VarENCODE: VarENDBG: VarENDCOLOR: VarENDSECTION: VarENTITY: VarENV: VarEXLINK: VarFAILEDPLUGINS: VarFORMFIELD: VarGAUGE: VarGET: VarGMTIME2: VarGMTIME: VarGRAY: VarGREEN: VarGROUPS: VarHEADLINES: VarHIDE: VarHOMETOPIC: VarHTTPHOST: VarHTTPS: VarHTTP: VarH: VarICON: VarICONURLPATH: VarICONURL: VarIF: VarINCLUDE: VarINCLUDINGTOPIC: VarINCLUDINGWEB: VarI: VarJIRA: VarJQENDTABPANE: VarJQENDTAB: VarJQTABPANE: VarJQTAB: VarKINOSEARCH: VarLANGUAGES: VarLANGUAGE: VarLIME: VarLOCALSITEPREFS: VarLOGIN: VarLOGINURL: VarLOGOUT: VarLOGOUTURL: VarMAINWEB: VarMAKETEXT: VarMAROON: VarMASTERWEBSCRIPTURL: VarMDREPO: VarMETASEARCH: VarMETA: VarM: VarNAVY: VarNOP: VarNOTIFYTOPIC: VarN: VarOLIVE: VarORANGE: VarPARENTTOPIC: VarPINK: VarPLUGINDESCRIPTIONS: VarPLUGINVERSION: VarP: VarPUBURLPATH: VarPUBURL: VarPURPLE: VarQRCODE: VarQ: VarQUERYPARAMS: VarQUERYSTRING: VarREDBG: VarRED: VarREMOTEADDR: VarREMOTEPORT: VarREMOTEUSER: VarRENDERLIST: VarREVINFO2: VarREVINFO: VarSCRIPTNAME: VarSCRIPTSUFFIX: VarSCRIPTURL2: VarSCRIPTURLPATH2: VarSCRIPTURLPATH: VarSCRIPTURL: VarSEARCH: VarSENDMAIL: VarSERVERTIME2: VarSERVERTIME: VarSESSIONID: VarSESSIONVARIABLE: VarSESSIONVAR: VarSETGETDUMP: VarSET: VarSILVER: VarSITENAME: VarSLIDESHOWEND: VarSLIDESHOWSTART: VarSPACEDTOPIC: VarSPACEOUT: VarSTARTINCLUDE: VarSTARTSECTION: VarSTATISTICSTOPIC:
  • Category:
VarSTOPINCLUDE: VarS: VarSYSTEMWEB: VarTABLE: VarTEAL: VarTOC2: VarTOC: VarTOPICLIST: VarTOPICTITLE: VarTOPIC: VarTOPICURL: VarT: VarTWIKIWEB: VarTWISTY: VarURLPARAM: VarUSERINFO: VarUSERNAME: VarUSERREPORT: VarUSERSWEB: VarU: VarVARCACHE: VarVAR: VarVBAR: VarWEBLIST: VarWEBPREFSTOPIC: VarWEB: VarWHITE: VarWIKIHOMEURL: VarWIKILOGOALT: VarWIKILOGOIMG: VarWIKILOGOURL: VarWIKINAME: VarWIKIPREFSTOPIC: VarWIKITOOLNAME: VarWIKIUSERNAME: VarWIKIUSERSTOPIC: VarWIKIVERSION: VarX: VarYELLOW: VarY:

Impact

WhatDoesItAffect: Documentation, Vars

Implementation

-- Contributors: PeterThoeny - 2012-10-21

Discussion

Please provide feedback on categories.

For comparison, categories in:

Support web app:
  • API
  • Access Control
  • Add Ons
  • Applications
  • Attachments
  • Authentication
  • Automation
  • Browser
  • Deployment
  • Documentation
  • Editing
  • Email
  • Error
  • Forms
  • Hosting
  • Installation
  • Internationalization
  • Java Script
  • Localization
  • Missing Functionality
  • Performance
  • Plugins
  • Registration
  • Rendering
  • Search
  • Security
  • Skin
  • Statistics
  • Templates
  • Version Control

Tagged extensions in Plugins web:
  • access_control
  • accessibility
  • admin_tool
  • ajax
  • archive_me
  • attachments
  • authentication
  • automation
  • backup
  • bibliography
  • blogging
  • brainstorming
  • bugs
  • build
  • caching
  • cairo
  • calendar
  • changes
  • classification
  • comment
  • compatibility
  • component
  • configuration
  • contrib
  • css
  • customer_focus
  • database
  • database_store
  • date_time
  • deployment
  • dev_essential
  • development
  • diagram
  • discussion
  • documentation
  • drawing
  • easy_install
  • editing
  • email
  • export
  • findability
  • forms
  • geolocation
  • graphing
  • images
  • import
  • information_design
  • installation
  • integration
  • interaction_design
  • internationalization
  • javascript
  • knowledge_base
  • latex
  • ldap
  • linking
  • localization
  • math
  • media
  • menu
  • mod_perl
  • navigation
  • notification
  • openid
  • opinion
  • pdf
  • performance
  • plotting
  • plugin
  • poll
  • preferences
  • presentation
  • process
  • productivity
  • publish
  • quality
  • rating
  • redirect
  • rendering
  • replication
  • rest
  • scalability
  • scheduling
  • search
  • security
  • shell
  • skin
  • sorting
  • spam
  • spelling
  • spreadsheet
  • sso
  • statistics
  • store
  • structured_wiki
  • syndication
  • syntax_highlighting
  • tables
  • tagging
  • taxonomy
  • template_system
  • timeline
  • tracker_apps
  • transformation
  • translation
  • tree
  • twiki_application
  • twiki_community
  • twiki_form_field
  • twistyplugin
  • upgrade
  • usability
  • user_interface
  • users
  • version_control
  • visualization
  • web_application
  • web_services
  • windows
  • workflow
  • wysiwyg
  • xml
Proposed in OrganizeTWikiVariables:
  • Searching and Listing - SEARCH,
    WEBLIST, TOPICLIST, ...
  • Controlling Formatting - BR,
    BULLET, RED, IF, ...
  • Access Controls - ALLOWTOPICCHANGE,
    DENYTOPICVIEW, NOSEARCHALL...
  • Getting Environment - USERINFO,
    GMTIME, SCRIPTNAME, ...
  • Controlling Environment -
    HTTP_EQUIV, NEWTOPICBGCOLOR...
  • Active content - links and forms -
    SCRIPTURL, QUERYSTRING, ...
  • Web Control - WEBTOPICLIST,
    WEBBGCOLOR, WEBCOPYRIGHT, ...
  • User Settings - EDITBOXWIDTH,
    EDITBOXHEIGHT, EDITBOXSTYLE...
  • Email Settings - ...

-- PeterThoeny - 2012-10-21

Mentioned at JerusalemReleaseMeeting2012x10x26:

  • Add category picklist to TWikiVariables and TWikiVariablesSearch
  • At a later point add wizard to editors to pick a category, show a list of variables, pick one to insert into text area.

-- PeterThoeny - 2012-10-26

This is now accepted by 7 day feedback period.

-- PeterThoeny - 2012-11-01

Now that we have categorized TWiki variables, I am adding a wizard to select and build variables. Tracked in TWikibug:Item7040.

-- PeterThoeny - 2012-11-16

New wizard is taking shape:

twiki-variables-wizard.png

The variable doc is loaded via an Ajax call on each click. Works pretty fast.

Next step, out of scope of this feature proposal:

  • Add wizard to WYSIWYG editor
  • Add wizard to raw text editor

-- PeterThoeny - 2012-11-16

Edit | Attach | Watch | Print version | History: r13 < r12 < r11 < r10 < r9 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r13 - 2013-09-19 - 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.