In SX Microcontrollers, SX/B Compiler and SX-Key Tool, johncouture wrote:

<STYLE> li{margin: 10px;}</STYLE>
 BACKGROUND 
As all of us are aware, the resources for the SX chip are freely available on the Parallax site. This is a tremendous and very costly effort on the part of Parallax and I'm sure they ponder that every time they look at their year-end profit and loss statement.  The more you use the SX the more you thirst for information on the device and Parallax can only devote so many resources to finding answers and providing documentation, examples, etc.  A great source for information on the SX used to be the SXList but the owner, James Newton, has announced its termination.  Mr. Newton provided a valuable service to us but the project has become too much of a drain on his personal resources.  An effort is in the works to provide that content under new management but if the current thread is any indication, it may be a while before that becomes reality (read the thread about the demise of the SXList and you'll see what I mean).

THE PROPOSAL

A simple proposal is for those of us that use the SX MCU to start organizing the plethora of data that is available to us by our efforts, the discussion list, etc. and gather it into "Topics" or "Application Notes".  Let's submit them in a loosely defined format to the discussion list at Parallax with the idea that an individual can download it into a specified folder.  Parallax may want to create a area on their web server and I will probably create one on my college's web server so that individuals don't have to.  The point being is that the updates to the library will be available to everyone if they want to create their own archive.  Please understand that this means that the content will then be considered public domain.

HOW IS IT DIFFERENT FROM A DISCUSSION LIST or the SXList?

I guess my motivation for this project is simple.  When I am looking for a solution to a problem I get bogged down reading through hundreds of discussion list posts to find a simple and elegant solution.  This list has top talent that are great at posting solutions to everyday questions and problems ... some of this just needs to be extracted out and presented in such a way that it is short, easy to find, and grouped next to similar concepts.  

For example, you'll notice that Jon Williams often creates great solutions and occasionally cross references and / or modifies a bit of code from Gunther Daubach's book to illustrate a point.  As you read through the discussion list, many, many SX users come up with superb two paragraph illustrations/solutions that further explain the sometimes terse explanation in the SX documentation.  I would hope that our goal would be to create content, cross index it with other content and build it into an invaluable resource for all of us to enjoy.  

It will be different from the former SXList in that it will not rely on the labors of a single person.  Mr. Newton put a lot of time into maintaining the site and Parallax put a lot of resources into supporting that and many other sites.  This proposal utilizes the existing discussion list for distribution.  If Parallax or the new owner of the SXList content want to allocate web space for it, it will be their [b][i]option[/i][/b] not their [b][i]responsibility[/i][/b].

LET'S GET STARTED!

To get started, may I propose a set of guidelines:

<OL>
<LI>Request the creation of a single "sticky" discussion item under the SX discussion list titled something like "SX Resources" or "SX Library" or whatever.  Parallax probably has a better grasp on what would make a good title.  Posts can be moderated to include only "updates" to the library.  We can create other normal discussion lists for topics like how to manage the library, concepts that need to be added to the library, etc. 
<LI>Determine initial "CONCEPT" headings with the intent that others can be added at a later date.  Examples might be "Variables and Math" or "Interrupts". 
<LI>Each author shall create their content such that it fits into a folder (sub folders are ok too) that is uniquely named.  The folder will have, as a minimum, an index page called "index.htm" (this is a generic name that is supported by all operating systems, I think) then ZIP it for upload to the discussion list.  Unique folder names ensure that no one clobbers another's content. Authors can ensure folder name singularity by just incorporating their name or initials in the folder name.  
<LI>If a new SXList does materialize then a courtesy mirror site can be created that contains the latest updates. 
<LI>The key to the success of this project is the development of a master[b] Table of Contents[/b] and a master[b] Index[/b].  Periodic updates of those two pages can be done automatically. For example, the [b]Table of Contents[/b] can display a link to the index page in each folder and use the "title" tag in the page as its description.  The [b]Index[/b] can be created by scanning each folder for bookmark tags and include them in the master index.  Because the Table of Contents will list "CONCEPTS" rather than numbered chapters, the Table of Contents can be rearranged as needed by the moderator. 
<LI>Section numbers within a chapter would be allowed but it is recommended that HTML bookmark tags (a.k.a. anchor tags) be used.  That way the topic will be picked up and inserted in the master index. 
<LI>As this evolves, we can collectively figure out how to create XML tags so that cross indexing becomes easier.  An example that comes to mind would be when someone refers to Daubach's book.  Here it would be nice if we all used the same reference and the Table of Contents and Index knew that.   Another example is where you write content and you want a reference made to it in a certain part of the Table of Contents. I'm sure contemporary web indexing software can do this, I just don't know how to do it myself. 
<LI>Example programs should, as much as possible, be complete working examples and use the program template provided by Parallax in the SX Key compiler. 
* At some point we may have so many guidelines that the guidelines will also have to be cross indexed (just kidding, I was trying to keep it to less than five and failed)
</OL>
INITIAL SET OF CONCEPTS"? (yes, it is incomplete, but that is the point!)

<UL>
<LI>[b]Getting Started[/b] 
<UL>
<LI>Opening the box from Parallax (i.e. Handling static sensitive parts) 
<LI>Downloading and installing the software 
<LI>Connecting up a simple "Blink LED" circuit (which then links to either the Assembler or SX/B program tutorial)
 </LI></UL>
<LI>[b]SX Assembler[/b] 
<UL>
<LI>My First Program (i.e. Hello World ... ok, blink an LED) 
<LI>Outline of Gunther Daubach's book (as this is a copyrighted word and sold as a book, I would imagine that only the table of contents will be allowed) 
<LI>Link to Al Williams book on Parallax site (I've created an index to this and will augment it with a TOC and upload it) 
<LI>Those of you that use the assembler a lot might suggest topics / application notes for here 
 </LI></UL>
<LI>[b]SX/B  [/b]
<UL>
<LI>My First Program 
<LI>Simple Flow Control (i.e. Goto and Loops) 
<LI>Decisions (IF, Lookup) 
<LI>Variables and Math 
<LI>Subroutines 
<LI>Functions 
<LI>Interrupts 
<LI>Virtual Peripherals 
<LI>Using Sensors (a good start would be to just list the Parallax PDF's) 
<LI>How about a rewrite of the "What's a microcontroller" using the SX? 
* Cross reference from SX/B to assembler.  The compiler does this automatically but maybe a simpler explanation using simple variables and such.
</UL></LI></UL>
OK, WHAT AM I DOING

Personally, I am working on a couple of programs that require the use of Interrupts in SX/B and I'm struggling.  Al Williams presentation in "Exploring" is nice but I need to develop some examples that start simple and do not bounce between Assembler and Basic (that causes my head to hurt). My solution will be to write a tutorial for myself on how to use interrupts.  Thus, I will be able to post an application note in a couple of weeks on how to do simple interrupts using port B pins in SX/B.  I'll initially take on the responsibility for keeping the Table of Contents updated but eventually I would like to figure out a way to automate this with something like a form submission page or something like that.  The success of this simply depends on the submission of articles / topics / application notes.  (an old saying goes something like "run the flag up the pole and see if anyone salutes")

IN CLOSING

There is no deadline.  This will start as a single page (i.e. an organism)  and eventually evolve into two pages.

---------- End of Message ----------


You can view the post on-line at:
http://forums.parallax.com/forums/default.aspx?f=7&p=1&m=87649

Need assistance? Send an email to the Forum Administrator at forumadmin@parallax.com

The Parallax Forums are powered by dotNetBB Forums, copyright 2002-2005 (http://www.dotNetBB.com)