Support:Documents:Examples:Instructions for Adding Your Own Example

From COMKAT wiki
Revision as of 21:01, 4 March 2008 by Deancool (talk | contribs)
Jump to navigation Jump to search

User access to create pages

You will have to contact us and get a sysop access to be allowed to create pages on this wiki.

Create an example page

Write some introduction to your example here.

For text that you want to appear as part of a MATLAB function or program, encase it inside a "pre" block.
Line 2 of pre block
    Line 3 (indented) of pre block.


Remember to include figures and plots in your example to make it look pretty and convey information. To insert a figure, create a figure file in png (preferred) or other graphic format.

figure
plot(1:10)
title('Example Figure')
ylabel('y-axis label')
xlabel('x-axis label')
set(1,'PaperPosition',[0.25 2.5 3 2])
print -dpng ExampleFigure.png


Next, upload the image file ("upload file" at the bottom of any wiki page) giving it a unique name.


Use double-square brackets to insert the figure into the page


ExampleFigure.png

Add your new example to the list of examples on the example index page by adding a line like this to the index page:

[http://comkat.case.edu/comkat/comkat_wiki/index.php?title=Support:Documents:Examples:Instructions_for_Adding_Your_Own_Example The title of you example]

Within the brackets, the first part is the URL address to your example page. Then you type your example title following that address. On the index page it will look like:

The title of you example


That is it. It is so simple that even a caveman (or professor) can do it.