0 Votes

Wiki source code of Start here if you're new

Version 13.1 by Ryan C on 2025/03/16 01:27

Show last authors
1 = =
2
3 ----
4
5 == ==
6
7 == 📖 Table of Contents: ==
8
9 {{toc/}}
10
11 ----
12
13 == Getting Started with XWiki ==
14
15 This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
16
17 == ==
18
19 == 📎 **Attachments and Images** ==
20
21 You can easily upload files and images directly from the WYSIWYG editor:
22
23 **Uploading Attachments:**
24
25 * Click **Edit** to enter the WYSIWYG editor.
26 * Click on the **Attachment** icon (📎 paperclip icon).
27 * Drag-and-drop or select your file to upload it instantly.
28 * Uploaded files will automatically be listed as attachments at the bottom of your page.
29
30 === **Inserting Images with Enlargable Thumbnails** ===
31
32 1. In the editor, click the **"Insert Image"** icon from the toolbar.
33 1. Upload or select the image.
34 1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
35
36 ----
37
38 == ⚡ **Using the / Macro Shortcut** ==
39
40 The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
41
42 * Simply type / and start typing the macro name or feature you want to add.
43 * You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
44 * Example macros include:
45 ** /toc – Table of Contents
46 ** /box – Insert Box Macro
47 ** /gallery – Image Gallery
48 ** /footnote – Add footnotes to your text
49 ** /code – Code blocks for programming snippets
50
51 This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
52
53 ----
54
55 == ✏️** Basic Formatting and Links (Quick Guide)** ==
56
57 * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
58 * **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
59 * **Creating Links**:
60 ** Highlight text and click **"Link"** or use shortcut Ctrl+K.
61 ** Paste or select the page URL to link internally.
62
63 ----
64
65 == 🔍 **Useful Tips & Best Practices** ==
66
67 * **Save drafts frequently:** Press Ctrl+S regularly.
68 * **Macros** greatly simplify content formatting—use / often.
69 * **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
70 * **Use minimal formatting** to ensure readability.
71
72 ----
73
74 = ⚡**Guests can contribute** =
75
76 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.
77 1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
78 1. Leave comments, give suggestions, request features.
79
80 == **Content Guidelines** ==
81
82 * 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.
83 * 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.
84
85 == **Directories and Page URLs** ==
86
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
90
91 == **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. citeturn0search0
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. citeturn0search6
102
103 == **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 {{code}}
110 + Heading Level 1
111 ++ Heading Level 2
112 +++ Heading Level 3
113 {{/code}}
114
115
116 === **Text Formatting** ===
117
118
119
120 *
121 ** (((
122 === **Bold**: Surround text with double asterisks. ===
123 )))
124
125 {{code}}
126 **bold text**
127 {{/code}}
128
129
130 *
131 ** (((
132 === **Italics**: Use double underscores. ===
133 )))
134
135 {{code}}
136 __italic text__
137 {{/code}}
138
139
140 *
141 ** (((
142 === **Underline**: Enclose text with double tildes. ===
143 )))
144
145 {{code}}
146 ~~underlined text~~
147 {{/code}}
148
149
150 *
151 ** (((
152 === **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
153 )))
154
155 {{code}}
156 * Item 1
157 * Item 2
158 {{/code}}
159
160
161 *
162 ** (((
163 === **Ordered List**: Start lines with a number followed by a period. ===
164 )))
165
166 {{code}}
167 1. First item
168 2. Second item
169 {{/code}}
170
171
172 == **Links** ==
173
174
175
176 ==== **Internal Link**: Use square brackets with the page name. ====
177
178 {{code}}
179 [[PageName]]
180 {{/code}}
181
182
183
184 ==== **External Link**: Provide the URL directly. ====
185
186 {{code}}
187 [https://www.example.com]
188 {{/code}}
189
190 (((
191 === **Images** ===
192 )))
193
194 {{code}}
195 [[image:example.jpg]]
196 {{/code}}
197
198
199 == **Utilizing XWiki Macros** ==
200
201 Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
202
203 **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
204
205 {{code}}
206 {{box}}
207 Your content here.
208 {{/box}}
209 {{/code}}
210
211
212 === **Info Macro**: Displays an informational message, often used for tips or notes. ===
213
214 {{code}}
215 {{info}}
216 This is an informational note.
217 {{/info}}
218 {{/code}}
219
220
221 === **Warning Macro**: Highlights warnings or important notices. ===
222
223 {{code}}
224 {{warning}}
225 Caution: Proceed with care.
226 {{/warning}}
227 {{/code}}
228
229
230 === **Code Macro**: Renders code snippets with syntax highlighting. ===
231
232 {{code}}
233 {{code language="python"}}
234 def hello_world():
235 print("Hello, world!")
236 {{/code}}
237 {{/code}}
238
239
240 === **Gallery Macro**: Creates an image gallery from attached images. ===
241
242 {{code}}
243 {{gallery}}
244 [[image1.jpg]]
245 [[image2.jpg]]
246 {{/gallery}}
247 {{/code}}
248
249
250 === **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
251
252 {{code}}
253 {{toc/}}
254 {{/code}}
255
256
257 === **Include Macro**: Embeds content from another page. ===
258
259 {{code}}
260 {{include reference="PageName"/}}
261 {{/code}}
262
263
264 === **Display Macro**: Displays the content of another document or an object property. ===
265
266 {{code}}
267 {{display reference="PageName"/}}
268 {{/code}}
269
270
271 === **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
272
273 {{code}}
274 {{velocity}}
275 #set($greeting = "Hello, $user.name!")
276 $greeting
277 {{/velocity}}
278 {{/code}}
279
280 == See Also: ==
281
282 [[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]

XWiki AI Chat