Issues with the Component Codex

Please list ideas here that you have about the component codex and how it can improve. Link to codex

Requests list

Todo List

• Describe Swarm Variables. What you can visualise needs to be documented some time. It would be nice to describe the attributes that can be visualised when you include a given component. Example, many of the components in UnderWorld use SwarmVariables to calculate quantites on the particles. gLucifer can visualise SwarmVariables, thus a user could obverse those quantities. Only problem is that - you can only know what is a SwarmVariable if you read through the actual code. Which most people don't do.

• Get individual and project based htmls happening. This has now been done. Components are now split into six project pages using the predesigned stylesheets.

• Equation numbering. Currently you can only have 1 equation picutre per component meta file. This is currently causing some errors in the html document because the 1st equation is repeated in place of the 2nd, 3rd, etc equation pictures.

• Fill in examples tag and script a check for it. Populate as many of the example tags as possible, but more importantly write a script that validates if the example xml exists or not.

• Get headings of Projects linking to repective wikis. Should be simple

-- JulianGiordani - 14 Sep 2006 -- KathleenHumble - 26 Jun 2008
to top