0 Votes

Wiki source code of Start here if you're new

Version 14.1 by Ryan C on 2025/05/14 13:01

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 == **Essential Formatting Options** ==
100
101 To ensure content is both engaging and accessible, utilize the following formatting techniques:
102
103 * **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.
104
105 {{code}}
106 + Heading Level 1
107 ++ Heading Level 2
108 +++ Heading Level 3
109 {{/code}}
110
111
112 === **Text Formatting** ===
113
114
115
116 *
117 ** (((
118 === **Bold**: Surround text with double asterisks. ===
119 )))
120
121 {{code}}
122 **bold text**
123 {{/code}}
124
125
126 *
127 ** (((
128 === **Italics**: Use double underscores. ===
129 )))
130
131 {{code}}
132 __italic text__
133 {{/code}}
134
135
136 *
137 ** (((
138 === **Underline**: Enclose text with double tildes. ===
139 )))
140
141 {{code}}
142 ~~underlined text~~
143 {{/code}}
144
145
146 *
147 ** (((
148 === **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 )))
150
151 {{code}}
152 * Item 1
153 * Item 2
154 {{/code}}
155
156
157 *
158 ** (((
159 === **Ordered List**: Start lines with a number followed by a period. ===
160 )))
161
162 {{code}}
163 1. First item
164 2. Second item
165 {{/code}}
166
167
168 == **Links** ==
169
170
171
172 ==== **Internal Link**: Use square brackets with the page name. ====
173
174 {{code}}
175 [[PageName]]
176 {{/code}}
177
178
179
180 ==== **External Link**: Provide the URL directly. ====
181
182 {{code}}
183 [https://www.example.com]
184 {{/code}}
185
186 (((
187 === **Images** ===
188 )))
189
190 {{code}}
191 [[image:example.jpg]]
192 {{/code}}
193
194
195 == **Utilizing XWiki Macros** ==
196
197 Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
198
199 **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
200
201 {{code}}
202 {{box}}
203 Your content here.
204 {{/box}}
205 {{/code}}
206
207
208 === **Info Macro**: Displays an informational message, often used for tips or notes. ===
209
210 {{code}}
211 {{info}}
212 This is an informational note.
213 {{/info}}
214 {{/code}}
215
216
217 === **Warning Macro**: Highlights warnings or important notices. ===
218
219 {{code}}
220 {{warning}}
221 Caution: Proceed with care.
222 {{/warning}}
223 {{/code}}
224
225
226 === **Code Macro**: Renders code snippets with syntax highlighting. ===
227
228 {{code}}
229 {{code language="python"}}
230 def hello_world():
231 print("Hello, world!")
232 {{/code}}
233 {{/code}}
234
235
236 === **Gallery Macro**: Creates an image gallery from attached images. ===
237
238 {{code}}
239 {{gallery}}
240 [[image1.jpg]]
241 [[image2.jpg]]
242 {{/gallery}}
243 {{/code}}
244
245
246 === **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
247
248 {{code}}
249 {{toc/}}
250 {{/code}}
251
252
253 === **Include Macro**: Embeds content from another page. ===
254
255 {{code}}
256 {{include reference="PageName"/}}
257 {{/code}}
258
259
260 === **Display Macro**: Displays the content of another document or an object property. ===
261
262 {{code}}
263 {{display reference="PageName"/}}
264 {{/code}}
265
266
267 === **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
268
269 {{code}}
270 {{velocity}}
271 #set($greeting = "Hello, $user.name!")
272 $greeting
273 {{/velocity}}
274 {{/code}}
275
276 == See Also: ==
277
278 [[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]

XWiki AI Chat