This question about Documentation: Asked

Displaying parameter driven %SEARCH% results via AJAX

I have a series of tabs in a topic that categorize tables of links to the WebHome topics of a number of webs within our FOSWiki installation - these topics/web have "activity" characteristics such as "proposed", "active", "retired" - by default the tabs provide links to the "active" webs - but I would like to provide check boxes and change the content of the tabs to reflect which check boxes are checked without reloading the entire page (AJAX)...

JQueryLoader looks like it would be able to do the trick - but the way the documentation topic is written is difficult to understand

(as with an enormous number of FSOWiki documentation topics the reader is assumed to already understand a lot of things - this is a symptom of "developers" writing documentation - "developers" are by nature impatient in this part of delivering a feature or solution - typically unable to adopt the perspective of the person learning the technology - I understand the inclination to skip over a well articulated explanation of a feature within the documentation all too well - having been a full time C, COBOL, V/B coder for many years - hard to use documentation is a huge barrier to entry for the uninitiated - and when someone is simply looking to achieve a result (as opposed to learning the entire system) being confronted with abbreviated documentation is frustrating - my recommendation to any open source or commercial application that provides an API is to focus upon enabling the novice to jump into the middle and be productive even when using advanced features - multiple step by step examples that are fully formed (e.g. don't assume that the reader understands anything about the system - links back to basic documentation that is well written is valuable here - enthusiastic cross linking within the documentation is very helpful - and every example should be ultra-clean / straight to the point of the specific example (e.g. no digressions or side thoughts thrown in) --- digressions and tangential ideas work well when related to the example source via the main feature topic (footnote or "see also" reference))...

Can someone help me work through an example of the case that I would like to implement? I would gladly contribute the resulting documentation/example source to the FOSWiki site... and I would gladly work to perfect it as an archetype for other documentation that might be developed herein...

-- JohnHart - 29 May 2014

 

QuestionForm edit

Subject Documentation
Extension JQueryLoader
Version Foswiki 1.1.9
Status Asked
Related Topics
Topic revision: r1 - 29 May 2014, JohnHart - This page was cached on 15 Jan 2018 - 00:11.

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