Info Tab Example
Do you have questions or comments about this model? Ask them here! (You'll first need to log in.)
## WHAT IS IT?
This model shows you how to use the Info tab.
You edit the Info tab as unformatted plain text. When you're done editing, the plain text you entered is displayed in a more attractive format.
To control how the formatted display looks, you use a "markup language" called Markdown. You may have encountered Markdown elsewhere; it is used on a number of web sites. (There are other markup languages in use on the web; for example, Wikipedia used a markup language called MediaWiki. Different markup languages differ in their details.)
The remainder of this document shows how to use Markdown.
## Headings
A heading begins with one or more hash marks (`#`). First level headings get one hash, second level headings get two, and so on up to four levels.
#### Input
# First-level heading
## Second-level heading
### Third-level heading
#### Fourth-level heading
## Paragraphs
#### Example
This is a paragraph. There are no spaces before the word 'This'.
This is another paragraph. The first line has two sentences.
The entire paragraph has two lines and three sentences.
Line breaks in the input,
Make line breaks in the output,
Like this.
#### Formatted
This is a paragraph. There are no spaces before the word 'This'.
This is another paragraph. The first line has two sentences. The entire paragraph has two lines and three sentences.
Line breaks in the input,
Make line breaks in the output,
Like this.
## Italicized and bold text
#### Example
For italics, surround text with underscores:
_hello, world_.
For bold, surround text with two asterisks:
**hello, world**.
You can also combine them:
_**hello**_ and **_goodbye_**
#### Formatted
For italics, surround text with underscores:
_hello, world_.
For bold, surround text with two asterisks:
**hello, world**.
You can also combine them:
_**hello**_ and **_goodbye_**
## Ordered lists
#### Example
We are about to start an ordered list.
1. Ordered lists are indented 2 spaces.
1. Subitems are indented 2 more spaces (4 in all).
2. The next item in the list starts with the next number.
3. And so on...
#### Formatted
We are about to start an ordered list.
1. Ordered lists are indented 2 spaces.
1. Subitems are indented 2 more spaces (4 in all for a second level item).
2. The next item in the list starts with the next number.
3. And so on...
## Unordered lists
#### Example
We are about to start an unordered list.
* Like ordered lists, unordered lists are also indented 2 spaces.
* Unlike ordered lists, unordered lists use stars instead of numbers.
* Sub items are indented 2 more spaces.
* Here's another sub item.
#### Formatted
We are about to start an unordered list.
* Like ordered lists, unordered lists are also indented 2 spaces.
* Unlike ordered lists, unordered lists use stars instead of numbers.
* Sub items are indented 2 more spaces.
* Here's another sub item.
## Links
### Automatic links
The simplest way to create a link is to just type it in:
#### Example
http://ccl.northwestern.edu/netlogo
#### Formatted
http://ccl.northwestern.edu/netlogo
### Links with text
If you want to use your own text for the link, here's how:
[link text here](link.address.here)
#### Example
[NetLogo](http://ccl.northwestern.edu/netlogo)
#### Formatted
[NetLogo](http://ccl.northwestern.edu/netlogo)
### Local links
It is also possible to link to a page on your computer, instead of a page somewhere on the Internet.
Local links have this form:
[alt text](file:path)
Any spaces in the path must be converted to %20. For example, this:
file:my page.html
must be written as:
file:my%20page.html
The path is relative to the directory that the model file is in.
#### Example
The easiest way to link to files on your computer is to put them into the same directory as your model. Assuming you have a file named `index.html` in the same directory as your model, the link would look like this:
[Home](file:index.html)
#### Example
Here is another example where the file lives in a directory called docs, and docs is in the same directory as your model:
[Home](file:docs/index.html)
## Images
Images are very similar to links, but have an exclamation point in front:
![alt text](http://location/of/image)
(The alternate text is the text that gets displayed if the image is not found.)
#### Example
![NetLogo](http://ccl.northwestern.edu/netlogo/images/netlogo-title-new.jpg)
#### Formatted
![NetLogo](http://ccl.northwestern.edu/netlogo/images/netlogo-title-new.jpg)
### Local images
Also very similar to links, it is possible to display an image on your computer instead of an image somewhere on the Internet. Assuming you have an image named `image.jpg`, local images look like this:
![alt text](file:path)
The path is relative to the directory that the model file is in.
As with local links, any spaces in the name of the file or the path must be converted to %20.
#### Example
Like local links, the easiest way to display images on your computer is to put them into the same directory as your model. This example displays the image "Perspective Example.png", which resides in the same directory as this model (Info Tab Example).
![Example](file:Perspective%20Example.png)
#### Formatted
![Example](file:Perspective%20Example.png)
## Block quotations
Consecutive lines starting with > will become block quotations.
You can put whatever text you like inside of it and you can also style it.
#### Example
> Let me see: four times five is twelve, and four times six is thirteen,
> and four times seven is --- _oh dear!_
> I shall never get to twenty at that rate!
#### Formatted
> Let me see: four times five is twelve, and four times six is thirteen,
> and four times seven is --- _oh dear!_
> I shall never get to twenty at that rate!
## Code
To include a short piece of code in a sentence, surround it with backticks (`).
#### Example
You can create a single turtle with the `crt 1` command.
#### Formatted
You can create a single turtle with the `crt 1` command.
## Code blocks
It is also possible to have blocks of code. To create a code block, indent every line of the block by 4 spaces.
#### Example
About to start the code block.
Leave a blank line after this one, and then indent four spaces:
; a typical go procedure
to go
ask turtles
[ fd 1 ]
tick
end
#### Formatted
About to start the code block.
Leave a blank line after this one, and then indent four spaces:
; a typical go procedure
to go
ask turtles
[ fd 1 ]
tick
end
## Superscripts and subscripts
Superscripts and subscripts are useful for writing formulas, equations, footnotes and more. Subscripts appear half a character below the baseline, and are written using the HTML tag ``. Superscripts appear half a character above the baseline, and are written using the HTML tag ``.
#### Example
H2O
2x4 + x2
WWW[1]
#### Formatted
H2O
2x4 + x2 + 42
WWW[1]
## Notes on usage
* Paragraphs, lists, code blocks and other features should be separated from each other with a blank line. If you find that something isn't formatted the way you expected, it might be because you need to add a blank line before it.
* To prevent a special character from being treated as markup, put a backslash (`\`) before it.
* We use GitHub flavored newlines (http://github.github.com/github-flavored-markdown/) instead of traditional Markdown handling of newlines. This means that newlines are treated as real line breaks, instead of being being combined with the previous line into a single paragraph.
## Other features
Markdown has additional features that we have not shown here.
We have tested the features shown above on a variety of systems. If you use other Markdown features, you may find that they work on your computer, or not. Even a feature that works on your computer might work differently, or not work at all, for someone with a different operating system or Java virtual machine.
If you want all NetLogo users to be able to read your Info tab, use only the features shown above.
More information about Markdown is at http://daringfireball.net/projects/markdown/. For rendering Markdown, NetLogo uses the [Pegdown](http://github.com/sirthias/pegdown) library.
[netlogo-link]: http://ccl.northwestern.edu/netlogo
Comments and Questions
; The purpose of ths model is to show how to write model documentation in the Info tab. ; Click the Info tab for more information. to startup giant-arrow end to giant-arrow clear-all create-ordered-turtles 1 [ set size 10 set color red setxy -7.25 10 ] create-turtles 1 [ set color red setxy -7.25 -5 ] ask turtle 0 [ create-link-with turtle 1 [ set color red set thickness 1.5 ] ] create-turtles 1 [ set color black setxy 8 12 set label "Click the info tab!" ] end ; Public Domain: ; To the extent possible under law, Uri Wilensky has waived all ; copyright and related or neighboring rights to this model.
There are 3 versions of this model.
Attached files
File | Type | Description | Last updated | |
---|---|---|---|---|
Info Tab Example.png | preview | Preview for 'Info Tab Example' | over 11 years ago, by Uri Wilensky | Download |
This model does not have any ancestors.
This model does not have any descendants.