You can view this as a regular page, or use the start presentation button below.

Start presentation

Slide 1: Welcome

This is a brief introduction to Foswiki, the wiki engine used by the Flatiron Institute Documentation Center.

The goal is to help you easily create your own pages, or edit existing ones.

If you want to play around and test things, you can go into the Sandbox under the Wiki Help menu.

Slide 2: Terminology

Web

a section of the documentation. Eg: SCC, Centers

Topic

a page in the documentation. Eg: MPI, Slurm

Wikiword

in Foswiki's lingo, a wiki word is something used to name a topic internally. eg: MyNewTopic

Category

related topics can be assigned categories. Categories are organized in a tree

Tag

topics can have tags, which will be used by the search engine when indexing

Slide 3: How to add new content?

• When you click on the + New button, you will be presented with a choice:
  • Default: this corresponds to a topic without a category
  • Category: create a new category
  • Classified Topic: this is what you most likely want to use when adding new content

Error: (3) can't find AddNewMarked.png in System

Slide 4: Creating a new topic

1. Click the + New button and select "Classified Topic"
2. Edit the page!
   • The tabs are used to set categories and tabs, but also to change the look and feel
   • If you do not like WYSIWYG editors, you can always disable it for a topic under Settings

Error: (3) can't find TopicEditTabs.png in System

Slide 5: The basics (1): sections and subsections

In order to create titles (which will be displayed in the Table of Contents) simply use the following:

• --- Followed by several plus + signs and a space are used to create sections, subsections etc.
  • Up to 5 +, a single one is reserved for topic titles
  • Example: ---++ My chapter
• To create bullets, simply use 3 spaces, a star * then a space    * My bullet
  • Sub-bullets: just add 3 more spaces for each level. Aka 6, then 9, then 12
• To created ordered lists, use 3 spaces, a character 1, then a space    1 First item
  • Use 1 everywhere, it will autoincrement!

• A new paragraph will be created if you put an empty line in your text.
  To create only a new line, use the HTML <br/>

Slide 6: The basics (2): links

• Links: they are created using the [[LinkTo][label]] syntax
  • LinkTo can be:
    • a topic on the same web [[OtherInformation]]
    • a topic on the server [[Main.Homepage]]
    • a section on the same page with an anchor [[#label]]
    • a url [[https://www.simonsfoundation.org]]
      url's are automatically linked: this is only useful with a label!
  • label is optional. It is what will be displayed on the page

• Wikiwords (using CamelCase) are automatically turned into link.
  Use ! in front of the word to avoid that. Eg: !NoAutomaticLink

Slide 7: The basics (3): formatting

• bold text is using *bold text*
• italics is using underscores: _italics_
• bold and italics uses two underscores: __bold and italics__
• Colored text is obtained using %COLOR_NAME%text%ENDCOLOR%

• There are several pre-defined info boxes (HTML div) that have CSS styles attached to them. Examples:

Slide 8: The basics (4): code

• To show highlighted code, use

<sticky>
%CODE{"language_used"}%
The code you want to demonstrate
%ENDCODE%
</sticky>

• For single lines of code, use the equal sign = Example: =code sample=

Slide 9: MediaWiki and Foswiki keywords

Slide 10: Structuring a page

You should try and do the following: (eg: Slurm)

1. A short description of what the topic is about
2. A cheatsheet showing the most used command <div class='fiCheatsheetMessage'>...</div>
3. The table of content: %TOC%
4. The content itself, using ---++ titles

Slide 11: Tips and Resources

• To get started, it is often worth looking at an existing topic.
  Use the More menu, then under View, View wiki markup
• When performing a search, the Foswiki-specific content is also searched for!
  You can also access the local documentation from here
• Foswiki uses a markup language called Topic Markup Language, its documentation is here
• Keywords of the form %KEYWORD% are detailed here
• As we have created different styles for FI, you can see the details: Flatiron Institute Wiki Notes