Flatiron Institute Wiki Notes

Some notes about Foswiki at FI

Editing the topics

If you have WYSIWYG editors, (or if you are writing your own HTML), you can click on the "wiki text" button to the right of the toolbar to disable it. If you find a page and you want to see its markup code, click on " More" then " View wiki markup"

Notes about the WYSIWYG editor

Creating a new web with categories

Do not use the standard Admin > Create a new web button, but use ManagingWebs instead. Remember to put the parent web at the beginning of the name to make sure the hierarchy is maintained.

Example: to create the subweb ProgrammingLanguages of web ComputerScience, in the field "Name of the new web" use: ComputerScience.ProgrammingLanguages

Then use the template _FlatironInstituteTemplate

Using icons in pages

%JQICON{"icon-name"}%

You can see the complete list of what is available here: JQueryFontAwesome and Material Icons

Using images in pages

First you need to upload the image to the page, as an attachment.

Then you can either:

• Use the standard html <img> (the easiest way is to go in WYSIWYG mode)
• Use the %IMAGE% syntax, which comes with ImagePlugin. This will automatically create thumbnails etc
• Create a gallery using %IMAGEGALLERY% from the ImageGalleryPlugin

Ignoring a WikiWord for a whole topic

This can be useful to not have to prepend every single occurence of the word with ! Simply use the ControlWikiWordPlugin:

<verbatim class='foswikiHidden'>
   * Set STOPWIKIWORDLINK = MyWikiWord
</verbatim>

Removing a title from the table of contents

Use !! in front of the name:

---++!! my title

Using code highlighting

Use the SyntaxHighlightingPlugin inside <sticky>, with the language as a parameter. For example:

<sticky>
%CODE{"c"}%
#include <stdio.h>
int main(int argc, char **argv) {
    printf("Hello world\n");
    return 0;
}
%ENDCODE%
</sticky>

Will produce:

#include <stdio.h>
int main(int argc, char **argv) {
    printf("Hello world\n");
    return 0;
}

Info boxes

Important information should pop, you can use the predefined classes inside div:

<div class="className">Your important message</div>

Some samples:

Links

Links to content in the wiki

Use dual brackets. By default the title of the topic will be displayed. You can use another set to display a different text instead. If you need to link to a page in a different web, you need its complete path. If you want a link to a complete web, link to its home topic (aka WebHome). To link to a specific title inside a page, use "#Section_name_with_underscores)

Examples:

[[InterestingFacts]]

[[InterestingFacts][some interesting facts]]

[[AnotherWeb.InterestingFacts]]

[[AnotherWeb.%HOMETOPIC%]]

---++ My useful section
[[AnImportantTopic#My_useful_section]]

Links to an external page

• If you want the link to be displayed as is, just write the link without any special syntax, it will be rendered automatically
• If you want to add a text for it, use the double bracket syntax with the

  [[url][display text]]

Emails

• You can write the email and a linkto will be automatically generated
• If you want a different text, use the double bracket syntax

  [[mailto:email][display name]]

Useful links

• TML (Topic Markup Language) https://foswiki.org/System/TopicMarkupLanguage
• Macros (aka %STUFF%) https://foswiki.org/System/MacrosQuickReference
• Font-awesome icons available https://foswiki.org/System/JQueryFontAwesome