Changes for page Start here if you're new
Last modified by Ryan C on 2025/06/28 04:59
From 4.1 to 5.1
Show context
Hide context
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -85,3 +85,184 @@ 85 85 == Directories and Page URLs == 86 86 87 87 * 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. 88 + 89 +Here’s a consolidated guide tailored for your XWiki environment, integrating essential syntax, formatting options, and an overview of notable macros to enhance content creation and management. 90 + 91 +**1. XWiki Editing Modes** 92 + 93 +XWiki offers multiple editing modes to accommodate various user preferences and technical requirements: 94 + 95 +*. **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. citeturn0search0 96 +*. **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. 97 +*. **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. 98 + 99 +**Switching Between Syntaxes** 100 + 101 +XWiki supports multiple syntaxes, including XWiki 2.1, MediaWiki, and others. While it’s possible to switch a page’s syntax, exercise caution, as certain syntaxes may not fully support WYSIWYG editing. For instance, changing a page to MediaWiki syntax might limit the availability of the WYSIWYG editor. citeturn0search6 102 + 103 +**2. Essential Formatting Options** 104 + 105 +To ensure content is both engaging and accessible, utilize the following formatting techniques: 106 + 107 +*. **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. 108 + 109 + 110 +{{code}} 111 + + Heading Level 1 112 + ++ Heading Level 2 113 + +++ Heading Level 3 114 +{{/code}} 115 + 116 + 117 + 118 +*. **Text Formatting**: Apply styles such as bold, italics, and underlining to emphasize text. 119 + 120 +**. **Bold**: Surround text with double asterisks. 121 + 122 + 123 +{{code}} 124 +**bold text** 125 +{{/code}} 126 +**. **Italics**: Use double underscores. 127 + 128 + 129 +{{code}} 130 +__italic text__ 131 +{{/code}} 132 +**. **Underline**: Enclose text with double tildes. 133 + 134 + 135 +{{code}} 136 +~~underlined text~~ 137 +{{/code}} 138 +*. **Lists**: Create ordered and unordered lists for structured information. 139 + 140 +**. **Unordered List**: Begin lines with asterisk (*) or hyphen (-). 141 + 142 + 143 +{{code}} 144 +* Item 1 145 +* Item 2 146 +{{/code}} 147 +**. **Ordered List**: Start lines with a number followed by a period. 148 + 149 + 150 +{{code}} 151 +1. First item 152 +2. Second item 153 +{{/code}} 154 +*. **Links**: Insert internal and external links to connect related content. 155 + 156 +**. **Internal Link**: Use square brackets with the page name. 157 + 158 + 159 +{{code}} 160 +[[PageName]] 161 +{{/code}} 162 +**. **External Link**: Provide the URL directly. 163 + 164 + 165 +{{code}} 166 +[https://www.example.com] 167 +{{/code}} 168 +*. **Images**: Embed images to enrich content. 169 + 170 + 171 +{{code}} 172 + [[image:example.jpg]] 173 +{{/code}} 174 + 175 + 176 + 177 +**3. Utilizing XWiki Macros** 178 + 179 +Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider: 180 + 181 +1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information. 182 + 183 + 184 +{{code}} 185 +{{box}} 186 +Your content here. 187 +{{/box}} 188 +{{/code}} 189 + 190 + 191 +1. **Info Macro**: Displays an informational message, often used for tips or notes. 192 + 193 + 194 +{{code}} 195 +{{info}} 196 +This is an informational note. 197 +{{/info}} 198 +{{/code}} 199 + 200 + 201 +1. **Warning Macro**: Highlights warnings or important notices. 202 + 203 + 204 +{{code}} 205 +{{warning}} 206 +Caution: Proceed with care. 207 +{{/warning}} 208 +{{/code}} 209 + 210 + 211 +1. **Code Macro**: Renders code snippets with syntax highlighting. 212 + 213 + 214 +{{code}} 215 +{{code language="python"}} 216 +def hello_world(): 217 + print("Hello, world!") 218 +{{/code}} 219 +{{/code}} 220 + 221 + 222 +1. **Gallery Macro**: Creates an image gallery from attached images. 223 + 224 + 225 +{{code}} 226 +{{gallery}} 227 +[[image1.jpg]] 228 +[[image2.jpg]] 229 +{{/gallery}} 230 +{{/code}} 231 + 232 + 233 +1. **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. 234 + 235 + 236 +{{code}} 237 +{{toc/}} 238 +{{/code}} 239 + 240 + 241 +1. **Include Macro**: Embeds content from another page. 242 + 243 + 244 +{{code}} 245 +{{include reference="PageName"/}} 246 +{{/code}} 247 + 248 + 249 +1. **Display Macro**: Displays the content of another document or an object property. 250 + 251 + 252 +{{code}} 253 +{{display reference="PageName"/}} 254 +{{/code}} 255 + 256 + 257 +1. **Velocity Macro**: Executes Velocity scripts for dynamic content generation. 258 + 259 + 260 +{{code}} 261 +{{velocity}} 262 +#set($greeting = "Hello, $user.name!") 263 +$greeting 264 +{{/velocity}} 265 +{{/code}} 266 + 267 + 268 +1. **HTML Macro**: Allows the inclusion of
