0 Votes

Start here if you're new

Version 2.1 by Ryan C on 2025/03/16 01:01


Getting Started with XWiki

This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.

📖 Table of Contents:


📎 Attachments and Images

You can easily upload files and images directly from the WYSIWYG editor:

Uploading Attachments:

  • Click Edit to enter the WYSIWYG editor.
  • Click on the Attachment icon (📎 paperclip icon).
  • Drag-and-drop or select your file to upload it instantly.
  • Uploaded files will automatically be listed as attachments at the bottom of your page.

Inserting Images with Enlargable Thumbnails

  1. In the editor, click the "Insert Image" icon from the toolbar.
  2. Upload or select the image.
  3. Choose the Thumbnail option to create a clickable enlargable preview automatically.

⚡ Using the / Macro Shortcut

The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:

  • Simply type / and start typing the macro name or feature you want to add.
  • You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
  • Example macros include:
    • /toc – Table of Contents
    • /box – Insert Box Macro
    • /gallery – Image Gallery
    • /footnote – Add footnotes to your text
    • /code – Code blocks for programming snippets

This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.


✏️ Basic Formatting and Links (Quick Guide)

  • Bold text: Select text, click the Bold button or press Ctrl + B.
  • Italic text: Select text, click "Italic" in the toolbar or use Ctrl+I.
  • Creating Links:
    • Highlight text and click "Link" or use shortcut Ctrl+K.
    • Paste or select the page URL to link internally.

🔍 Useful Tips & Best Practices

  • Save drafts frequently: Press Ctrl+S regularly.
  • Macros greatly simplify content formatting—use / often.
  • Edit attachments: Hover attachments directly below your page in view mode to manage or delete them.
  • Use minimal formatting to ensure readability.

⚡Guests can contribute

  1. Guests can edit pages in the main content area without signing up. If this becomes problematic I'll change it but for now I'd like everyone to have access with as little trouble as possible.
  2. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
  3. Leave comments, give suggestions, request features.

Content Guidelines

  • Ensure your content is well-researched, you don't need to include references in the format of footnotes for your material, but you should try to include studies or links to give credibility to your claims. For instance, just claiming that IQ is genetic is genetic wouldn't be valid unless you provide a study backing up that assertion, or more likely link to a page within this site that explains why IQ is not something that is purely determined by environmental factors. If such a page doesn't exist, create it, and start providing studies that show this.
  • Use clear, concise language and avoid using slurs, slang, or troll like language. This isn't supposed to be encyclopedia dramatica, I'd like things to remain relatively mature and well thought out.

Directories and Page URLs

  • The categories I have made up should cover most content, but if you feel your content doesn't fit under them, feel free to make a new category. Moving pages and reorganizing content in this wiki is very easy.

XWiki AI Chat