Difference between revisions of "Photonics Wiki Stylesheet"
Cmditradmin (talk | contribs) m (→Headings) |
Cmditradmin (talk | contribs) m |
||
| Line 1: | Line 1: | ||
The Photonics Wiki is meant to be more of textbook / tutorial presentation than a standard wiki. We hope that students will be able read a section from the main menu and follow a coherent presentation from page to page. The sections reflect the original recorded lectures that were transcribed and | The Photonics Wiki is meant to be more of textbook / tutorial presentation than a standard wiki. We hope that students will be able read a section from the main menu and follow a coherent presentation from page to page. The sections reflect the original recorded lectures that were transcribed and modified. Some styles we will use throughout. | ||
== Section Navigation buttons == | == Section Navigation buttons == | ||
| Line 6: | Line 6: | ||
== Headings == | == Headings == | ||
Every full article should have 3 plus headings so that the table of contents section is automatically generated. Take care to make the headings an subheadings instructive and parallel. Ideally the TOC provides a coherent outline of content to be covered and its conceptual organization. | Every full article should have 3 plus headings so that the table of contents section is automatically generated. Take care to make the headings an subheadings instructive and parallel. Ideally the TOC provides a coherent outline of content to be covered and its conceptual organization. | ||
== When to use internal links == | |||
Normal wiki articles depend heavily on many small articles that can be shared between overlapping topics by linking. A wiki book tends to have larger articles with links used as sidebars. If a topic within an article is cohesive but somewhat tangential or supporting and interrupts the main flow of the article then it can be changed to discrete article and linked to with single word using the wiki <nowiki>[[ article name ]]</nowiki> tag. | |||
== Math Equations == | == Math Equations == | ||
Full size equations should be done in Latex. Variables should be defined below using latex for the variable (or term) itself and followed by a definition of the term in plain text. | Full size equations should be done in Latex. Variables should be defined below using latex for the variable (or term) itself and followed by a definition of the term in plain text. | ||
== References == | == References == | ||
Revision as of 07:49, 11 August 2010
The Photonics Wiki is meant to be more of textbook / tutorial presentation than a standard wiki. We hope that students will be able read a section from the main menu and follow a coherent presentation from page to page. The sections reflect the original recorded lectures that were transcribed and modified. Some styles we will use throughout.
Each page within a section should have a Return to main menu button that takes you back to the main page outline at that section point in the outline. It should also have a "next topic" and "last topic" button to take you to the next page in that section. This is done with a short table at the top of the page. Longer scrolling pages should have the same table at the bottom of the page
Headings
Every full article should have 3 plus headings so that the table of contents section is automatically generated. Take care to make the headings an subheadings instructive and parallel. Ideally the TOC provides a coherent outline of content to be covered and its conceptual organization.
When to use internal links
Normal wiki articles depend heavily on many small articles that can be shared between overlapping topics by linking. A wiki book tends to have larger articles with links used as sidebars. If a topic within an article is cohesive but somewhat tangential or supporting and interrupts the main flow of the article then it can be changed to discrete article and linked to with single word using the wiki [[ article name ]] tag.
Math Equations
Full size equations should be done in Latex. Variables should be defined below using latex for the variable (or term) itself and followed by a definition of the term in plain text.
References
Article references should be mentioned where they are relevant in the text with "See Taylor" followed by the full article citation in ref tags. Include a DOI identifier when possible.
Graphics
Most graphics are positioned to the right using the thumb tag and 300 or 400px depending on the legibility of the info and space needs for surrounding text. Captions should restate the title or provide fuller explanation as derived from the main text. Progressive reveal builds from powerpoint should be output as a set with acrobat and embedded as a document. If slide notes are available for these they should be included at the time of pdf creation.
External links
Additional website links should be included at the end. Be conservative because these will add to our maintanence headaches.