0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/06/28 04:59

From 21.1 to 22.1 From 34.1 to 35.1

From version

22.1

edited by Ryan C
on 2025/05/14 13:41

Change comment: There is no comment for this version

To version

34.1

edited by Ryan C
on 2025/05/14 16:06

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- 1747262485678-297.png

Details

Page properties

Content

@@ -12,191 +12,81 @@
  == Getting Started with XWiki ==
--The `{{example}}` macro in XWiki is an underrated powerhouse—great for *teaching*, *showcasing macros*, *hiding complex markup*, and *letting users play with source-output pairs*. Here are some **highly effective and interesting uses**:
++The example macro in XWiki is an underrated powerhouse—great for *teaching*, *showcasing macros*, *hiding complex markup*, and *letting users play with source-output pairs*. Here are some **highly effective and interesting uses**:
-----
--## 🧪 1. **Macro Showcase: Source-to-Output Toggle**
--Show how a macro works without cluttering the page with raw syntax.
++== 🔍 **Useful Tips & Best Practices** ==
--```xwiki
--== Gallery Macro ==
--{{example}}
--{{gallery}}
--[[image:photo1.jpg]]
--[[image:photo2.jpg]]
--{{/gallery}}
--{{/example}}
--```
++* **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.
--**Why it's good:** New users see both source and result without confusion.
++----
-----
++= ⚡**Guests can contribute** =
--## 📝 2. **Editable Template Snippets**
++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.
++1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
++1. Leave comments, give suggestions, request features.
--Use `{{example}}` to store reusable content that users can copy, paste, and modify.
++== **Content Guidelines** ==
--```xwiki
--== Boilerplate Box ==
--{{example}}
--{{box cssClass="highlight"}}
--Insert your highlighted content here.
--{{/box}}
--{{/example}}
--```
++* 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>>doc:Main Categories.Science & Research.Race & IQ.WebHome]] 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** ==
--## 🎓 3. **Educational Tutorials (e.g., Velocity or Groovy)**
++* 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.
--Teach scripting with real, live code examples.
--```xwiki
--== Velocity Greeting ==
--{{example}}
--{{velocity}}
--#set($name = "Visitor")
--Hello, $name!
--{{/velocity}}
--{{/example}}
--```
-----
++== **XWiki Editing Modes** ==
--## 🎯 4. **Comparing Macro Parameters**
++XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
--Demonstrate how different macro parameters change output—side-by-side.
++* **WYSIWYG (What You See Is What You Get) Editor**: Ideal for users unfamiliar with wiki syntax, this editor provides a user-friendly interface resembling traditional word processors. It allows for straightforward text formatting, image insertion, and link creation without delving into markup language. citeturn0search0
++* **Wiki Editor**: This mode enables direct editing using XWiki’s markup syntax. It’s suitable for users comfortable with wiki syntax and those requiring precise control over the content structure.
--```xwiki
--== Info vs Warning ==
--{{example}}
--{{info}}This is an info box.{{/info}}
++== **Essential Formatting Options** ==
--{{warning}}This is a warning box.{{/warning}}
--{{/example}}
--```
++To ensure content is both engaging and accessible, utilize the following formatting techniques:
-----
++* **Headings**: Organize content hierarchically using headings. In XWiki syntax, headings are defined by one to six plus signs (+), corresponding to heading levels 1 to 6.
--## 🧩 5. **Interactive Data Blocks (TOC, Footnotes, etc.)**
++{{code}}
++  + Heading Level 1
++  ++ Heading Level 2
++  +++ Heading Level 3
++{{/code}}
--Visually show what happens when you use certain macros together.
--```xwiki
--== Footnote Demo ==
--{{example}}
--This claim needs a source{{footnote}}Here it is.{{/footnote}}.
--{{putFootnotes/}}
--{{/example}}
--```
++== **Links** ==
-----
--## 🧪 6. **Live Scripting Playgrounds**
--Embed small self-contained scripting playgrounds where users can view or modify dynamic output.
++==== **Internal Link**: Use square brackets with the page name. ====
--```xwiki
--== Groovy Lookup ==
--{{example}}
--{{groovy}}
--def now = new Date()
--println("Current time: " + now)
--{{/groovy}}
--{{/example}}
--```
++{{code}}
++[[PageName]]
++{{/code}}
-----
--## 📦 7. **Component/API Call Demos**
--Useful for devs exploring the API.
++==== **External Link**: Provide the URL directly. ====
--```xwiki
--== Access Current User ==
--{{example}}
--{{velocity}}
--Current user: **$xcontext.user**
--{{/velocity}}
--{{/example}}
--```
--
-----
--
--## 📘 8. **Expandable Wiki Templates with Output**
--
--Pair `{{example}}` with `{{expandable}}` for full disclosure without visual clutter.
--
--```xwiki
--== Expandable Summary ==
--{{example}}
--{{expandable summary="🧠 Study Summary"}}
--Key findings go here.
--{{/expandable}}
--{{/example}}
--```
--
-----
--
--## 🔧 9. **Syntax Training: Bad vs Good**
--
--Side-by-side "Do this, not that" with toggles.
--
--```xwiki
--== List Formatting ==
--{{example}}
--*Bad formatting*
--* use - inconsistently
--** Good formatting:
--  * Consistent bullet style
--  * Indented items properly
--{{/example}}
--```
--
-----
--
--## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets
--
--```xwiki
--== Python Code ==
--{{example}}
--{{code language="python"}}
--def greet():
--    print("Hello World")
++{{code}}
++[https://www.example.com]
  {{/code}}
--{{/example}}
--```
-----
++(((
++===   ===
++)))
--Want me to generate a panel with these uses or make a macro gallery page pre-filled with them?
--
--This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
--
  ==   ==
--== 📎 **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.
--1. Upload or select the image.
--1. 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:
@@ -210,150 +210,131 @@
  ** /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.
++This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
  ----
--== ✏️** Basic Formatting and Links (Quick Guide)** ==
++## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
--* **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.
++In this section we will go over many of the common macros used. The source code is how you use the macro editing in Wiki mode. If you are doing standard WYSIWYG edit mode (the default mode you get when you click edit instead of the dropdown), you can call most of these macros by simply typing /thecommand
------
--== 🔍 **Useful Tips & Best Practices** ==
++=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
--* **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.
------
++{{code}}
++{{toc/}}
++{{/code}}
--= ⚡**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.
--1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
--1. Leave comments, give suggestions, request features.
++== **Gallery Macro** `/gallery` ==
--== **Content Guidelines** ==
++{{example}}
++{{gallery}}
++[[1747262485678-297.png]]
++[[image:photo2.jpg]]
++{{/gallery}}
++{{/example}}
--* 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>>doc:Main Categories.Science & Research.Race & IQ.WebHome]] 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** ==
++== **Alternatively** `/carousel` ==
--* 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.
++{{example}}
++{{carousel/}}
++
++{{/example}}
++== **Boilerplate Box** ==
--== **XWiki Editing Modes** ==
++{{example}}
++{{box cssClass="highlight"}}
++Insert your highlighted content here.
++{{/box}}
++{{/example}}
--XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
++==   ==
--* **WYSIWYG (What You See Is What You Get) Editor**: Ideal for users unfamiliar with wiki syntax, this editor provides a user-friendly interface resembling traditional word processors. It allows for straightforward text formatting, image insertion, and link creation without delving into markup language. citeturn0search0
--* **Wiki Editor**: This mode enables direct editing using XWiki’s markup syntax. It’s suitable for users comfortable with wiki syntax and those requiring precise control over the content structure.
--* **Inline Form Editing**: Used primarily for pages containing structured data or custom applications, this mode presents editable fields directly within the page view, streamlining data entry and updates.
++== **Info vs Warning **`/info box` ==
--== **Essential Formatting Options** ==
++{{example}}
++{{info}}
++This is an info box.
++{{/info}}
--To ensure content is both engaging and accessible, utilize the following formatting techniques:
++{{warning}}
++This is a warning box.
++{{/warning}}
++{{/example}}
--* **Headings**: Organize content hierarchically using headings. In XWiki syntax, headings are defined by one to six plus signs (+), corresponding to heading levels 1 to 6.
++== **Footnote Demo** `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
--{{code}}
--  + Heading Level 1
--  ++ Heading Level 2
--  +++ Heading Level 3
--{{/code}}
++{{example}}
++footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
++{{putFootnotes/}}
++{{/example}}
--=== **Text Formatting** ===
++==   ==
++== **Expandable Summary** `/expandable`  VERY USEFUL MACRO ==
--*
--** (((
--=== **Bold**: Surround text with double asterisks. ===
--)))
++{{example}}
++{{expandable summary="🧠 Study Summary"}}
++Key findings go here.
++{{/expandable}}
++{{/example}}
--{{code}}
--**bold text**
--{{/code}}
++==   ==
++== 📎 **Attachments and Images** ==
--*
--** (((
--=== **Italics**: Use double underscores. ===
--)))
++You can easily upload files and images directly from the WYSIWYG editor:
--{{code}}
--__italic text__
--{{/code}}
++**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.
--*
--** (((
--=== **Underline**: Enclose text with double tildes. ===
--)))
++== **Audio Embedding** for attached media its better to use the code sometimes but you can embed media with `/embed content` for external media and `/embed JWPlayer` ==
--{{code}}
--~~underlined text~~
--{{/code}}
++{{example}}
++{{html}}
++<audio controls>
++  <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
++  Your browser does not support the audio element.
++</audio>
++{{/html}}
++{{/example}}
++This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
--*
--** (((
--=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
--)))
++=== **Inserting Images with Enlargable Thumbnails** ===
--{{code}}
--* Item 1
--* Item 2
--{{/code}}
++1. In the editor, click the **"Insert Image"** icon from the toolbar.
++1. Upload or select the image.
++1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
++[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
--*
--** (((
--=== **Ordered List**: Start lines with a number followed by a period. ===
--)))
--{{code}}
--1. First item
--2. Second item
--{{/code}}
--== **Links** ==
++=== **Alternatively: `~[~[image~:image.png]]`** ===
++{{example}}
++[[image:1747262485678-297.png]]
++{{/example}}
--==== **Internal Link**: Use square brackets with the page name. ====
--{{code}}
--[[PageName]]
--{{/code}}
++==   ==
++----
--
--==== **External Link**: Provide the URL directly. ====
--
--{{code}}
--[https://www.example.com]
--{{/code}}
--
--(((
--=== **Images** ===
--)))
--
--{{code}}
--  [[image:example.jpg]]
--{{/code}}
--
--
  == **Utilizing XWiki Macros** ==
  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
@@ -376,18 +376,8 @@
  {{/code}}
--== Footnote Macro ==
++== **Code Macro**: Renders code snippets with syntax highlighting. ==
--The Footnote macro adds footnotes to the page.
--
--{{example}}
--This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
--{{putFootnotes/}}
--{{/example}}
--
--
--=== **Code Macro**: Renders code snippets with syntax highlighting. ===
--
  {{code}}
  {{code language="python"}}
  def hello_world():
@@ -396,26 +396,8 @@
  {{/code}}
--=== **Gallery Macro**: Creates an image gallery from attached images. ===
++== **Video Macro**: `/video` The Video macro embeds videos. ==
--{{code}}
--{{gallery}}
--[[image1.jpg]]
--[[image2.jpg]]
--{{/gallery}}
--{{/code}}
--
--
--=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
--
--{{code}}
--{{toc/}}
--{{/code}}
--
--== Video Macro ==
--
--The Video macro embeds videos.
--
  {{example}}
  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
  {{/example}}
@@ -424,12 +424,12 @@
  == Example Macro ==
  The example macro displays the output of a macro or script or anything that you like
++
  == Expandable Macro ==
  The following example demonstrates how to present complex information cleanly using `
  {{example}}
--
  {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
  **Source:** *Twin Research and Human Genetics (Cambridge University Press)*
  **Date of Publication:** *2013*
@@ -499,4 +499,4 @@
  {{/example}}
--
++

1747262485678-297.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.AdminAngriff

Size

...	...	@@ -1,0 +1,1 @@
	1	+1.6 MB

Content