Style Guide

From ControlTheoryPro.com

Jump to: navigation, search
Symbol.gif
Style Guide
Green carrot left.gif
Help
Green carrot.jpg
In order to prevent spam, users must register before they can edit or create articles.


1 Style Guide for ControlTheoryPro.com

The Control Systems wikibook has a manual of style. So does wikipedia. This is the style guide for ControlTheoryPro.com.

These are not hard and fast rules just preferences.

1.1 Style Guide for Headers

One of the primary formatting tools used by the Control Systems wikibooks is the header. ControlTheoryPro.com has a header template similar to the wikibook's header template. The header template is particularly useful for offering related links at the top of the page.

For a header without links

 {{Header}}
Symbol.gif
Style Guide
Green carrot left.gif
Green carrot.jpg
In order to prevent spam, users must register before they can edit or create articles.



You can add up to 2 links to the header template. If you wanted to add a link to the Help category and the Math Markup then the header template command would be

 {{Header|:Category:Help|Math Markup}}
Symbol.gif
Style Guide
Green carrot left.gif
:Category:Help Math Markup
Green carrot.jpg
In order to prevent spam, users must register before they can edit or create articles.


 Note that the Category link requires the colon, :, in the front fo the link.


A message can be added to the header using the 3rd header template input. {{Header|:Category:Help|Math Markup|Message Here}}

Symbol.gif
Style Guide
Green carrot left.gif
:Category:Help Math Markup
Green carrot.jpg
Message Here
In order to prevent spam, users must register before they can edit or create articles.



In order to mask the link, and get rid of irratating characters like the colon, the 4th and 5th template inputs were added. They are used like this {{Header|:Category:Help|Math Markup|Message Here|Help|Math}}

Symbol.gif
Style Guide
Green carrot left.gif
Help Math
Green carrot.jpg
Message Here
In order to prevent spam, users must register before they can edit or create articles.



1.2 Style Guide for Math

I've copied the Math Markup from wikipedia to this site. I've done my best to install all the necessary software for the equations that wikipedia has. However, some markup features don't work the same. I will clean up the Math Markup article as I get the time.

Lots of articles will require equations. Significant equations should be put into articles using the Eqn template. {{Eqn|eqnValue=<math>F=ma=m\ddot{x}</math>|number=Newton's 2<sup>nd</sup> Law}}

LaTeX: F=ma=m\ddot{x} Newton's 2nd Law


where

LaTeX: F is force,
LaTeX: m is mass, and
LaTeX: a=\ddot{x} is acceleration.

Use the edit button for this section to see all of the desired formatting.

1.3 Style Guide for Search Engine Optimization

You may be asking what Search Engine Optimization (SEO) has to do with style. Well we all want our articles to be read by others and the best way to do this is to show up on the first page of Google searches for the article's topic.

1.3.1 Meta Data

The Google algorithm uses HTML meta data as well as article content. The meta data cannot be controlled through the mediawiki editor. The only meta data that can be controlled are the links in the Header template.

1.3.2 Article Content

Google likes to see key words between header tags. This can be accomplished with simple substitutions. For example, the Introduction section of an article on MEMS Gryos would be substituted in this manner

 ==Introduction==
 
 can be substituted with
 
 ==Introduction to MEMS Gyros==

Also, we have a tendency to use pronouns instead of the topic name. So we may text such as

 MEMS gyros can be modeled by a 2nd order transfer function.  These sensors typically have a bandwidth of...

replace this with

 MEMS gyros can be modeled by a 2nd order transfer function.  MEMS Gyros typically have a bandwidth of...

Obviously use some discretion or the content will become cumbersome to read.

1.4 Style Guide for References

ControlTheoryPro.com strongly requests the inclusion of references. People work hard on their books, journal articles, etc - please give them due credit. ControlTheoryPro.com is not picky about what reference style you use as long as it is a recognized bibliography standard. Use OttoBib for references that are automatically generated from the ISBN (at least for books). Please include the ISBN number at the end whenever possible. If you wish to help in site support then add the <amazon> tag. For ISBN 0201331535 the tags would be this

<amazon>0201331535</amazon>

1.5 Useful Templates

Eqn: For adding important equations to an article
TODO: For leaving yourself (or others) a TODO note to finish something or fix something
DynPageList: Provides a dynamically generated list of the most recently changed articles on the wiki or in a category
SideNote: Provides a nice way of putting a little note, with supplemental text, on the right side of the page
Mbox: Provides a quick means of putting a message on the page (aligns center)
Mbox-side: Provides a quick means of putting a message on the page (aligns right)
SeeAlso: Like Mbox-side only the title is fixed as See Also and the text should typically be another article on the site
CTPLogoBlue: Provides quick access to the Hex value of the Blue color in the CTP logo
CTPLogoGreen: Provides quick access to the Hex value of the Green color in the CTP logo
CTPLogoBlack: Provides quick access to the Hex value of the Black color in the CTP logo
SecondOrderSystems: Provides article text relating to a standard 2nd order system
BigPicture: Provides text about what the big picture is when designing a control system
Modeling Stages‏: A simple reminder of the stages of modeling, it shows up in a box similar to SideNote
SystemMetrics‏‎: Quick access (for the reader) to vital system metrics like Phase and Gain margin, Closed loop bandwidth, etc.
SecondOrderPerformance: Quick access to vital 2nd order system performance equations