1# Rich Content in Event Descriptions
2
3The calendar plugin now supports rich content in event descriptions, including images, links, formatting, and unlimited length.
4
5## Supported Content Types
6
7### 1. **Images**
8
9#### DokuWiki Syntax:
10```
11{{image.jpg}}
12{{image.jpg|Alt text description}}
13{{namespace:image.png|Product screenshot}}
14```
15
16#### External Images:
17```
18{{https://example.com/image.jpg}}
19{{https://example.com/photo.png|Photo from website}}
20```
21
22#### Examples:
23- Internal: `{{wiki:logo.png|Company logo}}`
24- External: `{{https://picsum.photos/200|Random image}}`
25
26**Result:** Images display inline within the event description, automatically sized to fit.
27
28---
29
30### 2. **Links**
31
32#### DokuWiki Link Syntax:
33```
34[[wiki:page]]
35[[wiki:page|Link text]]
36[[namespace:subpage|Click here]]
37```
38
39#### External Links (DokuWiki):
40```
41[[https://example.com]]
42[[https://example.com|Visit website]]
43```
44
45#### Markdown-Style Links:
46```
47[Link text](https://example.com)
48[Documentation](https://docs.example.com)
49```
50
51#### Plain URLs:
52```
53https://example.com
54http://wiki.example.com/page
55```
56
57**Result:** All become clickable links. External links open in new tabs.
58
59---
60
61### 3. **Text Formatting**
62
63#### Bold:
64```
65**bold text**
66<strong>bold text</strong>
67<b>bold text</b>
68```
69
70#### Italic:
71```
72//italic text//
73<em>italic text</em>
74<i>italic text</i>
75```
76
77#### Code:
78```
79<code>inline code</code>
80```
81
82---
83
84### 4. **Line Breaks**
85
86Simply press Enter for a new line:
87```
88Line 1
89Line 2
90Line 3
91```
92
93---
94
95## Complete Examples
96
97### Example 1: Meeting with Agenda
98```
99**Agenda:**
1001. Review Q4 results {{reports:q4.pdf|Q4 Report}}
1012. Discuss new project [[projects:alpha|Project Alpha]]
1023. Team updates
103
104**Materials:**
105{{https://example.com/slides.pdf|Presentation slides}}
106
107**Zoom:** https://zoom.us/j/123456789
108```
109
110### Example 2: Product Launch
111```
112**Product Launch Event**
113
114{{products:banner.jpg|Launch banner}}
115
116Launch details: [[events:launch2026|Event page]]
117
118Registration: https://events.example.com/register
119
120**Key Points:**
121- New features
122- Demo at 2:00 PM
123- Q&A session
124
125Contact: [john@example.com](mailto:john@example.com)
126```
127
128### Example 3: Task with Screenshots
129```
130**Design Review Task**
131
132Review the new dashboard mockups:
133
134{{designs:dashboard-v1.png|Dashboard version 1}}
135{{designs:dashboard-v2.png|Dashboard version 2}}
136
137Feedback form: [[forms:design-feedback]]
138
139Due: **January 30, 2026**
140```
141
142### Example 4: Travel Planning
143```
144**Business Trip - New York**
145
146**Flight:**
147{{https://airline.com/qr-code.png|Boarding pass QR code}}
148Confirmation: [View on airline site](https://airline.com/booking/ABC123)
149
150**Hotel:**
151Hilton Midtown - https://hilton.com/nyc
152
153**Itinerary:**
154[[travel:nyc-jan2026|Full itinerary]]
155
156**Documents:**
157{{travel:passport-copy.pdf|Passport copy}}
158{{travel:visa.pdf|Visa}}
159```
160
161### Example 5: Event with External Content
162```
163**Conference Attendance**
164
165**Event website:** https://conference2026.com
166
167**Schedule:**
168{{https://conference2026.com/schedule.jpg|Conference schedule}}
169
170**My sessions:**
171- 9:00 AM - Keynote
172- 11:00 AM - Workshop [[conferences:workshop-notes|My notes]]
173- 2:00 PM - Panel discussion
174
175**Networking:** [LinkedIn group](https://linkedin.com/groups/conference2026)
176
177**Hotel:** {{https://maps.google.com/image.png|Map to hotel}}
178```
179
180---
181
182## Practical Use Cases
183
184### 1. **Project Management**
185- Link to project docs: `[[projects:alpha|Project Alpha]]`
186- Attach design files: `{{designs:mockup.png}}`
187- Reference tickets: `See [JIRA-123](https://jira.example.com/JIRA-123)`
188
189### 2. **Event Planning**
190- Show venue photos: `{{venues:hall-a.jpg|Main hall}}`
191- Link to RSVP: `https://eventbrite.com/event/123`
192- Display floor plans: `{{events:floorplan.pdf}}`
193
194### 3. **Travel & Logistics**
195- Boarding passes: `{{travel:boarding-pass.png}}`
196- Confirmation emails: Link PDFs from email attachments
197- Maps and directions: External Google Maps images
198
199### 4. **Documentation & Training**
200- Procedure documents: `[[procedures:onboarding]]`
201- Training videos: `[Watch training](https://youtube.com/watch?v=...)`
202- Reference guides: `{{guides:quickstart.pdf}}`
203
204### 5. **Sales & Client Meetings**
205- Client logos: `{{clients:acme-logo.png}}`
206- Product sheets: `{{sales:product-overview.pdf}}`
207- Proposal links: `[[proposals:acme-2026]]`
208
209---
210
211## Tips for Best Results
212
213### Image Optimization
214- **Resize large images** before uploading (max 800px wide recommended)
215- Use **PNG** for logos and diagrams
216- Use **JPG** for photos
217- Keep file sizes under 500KB for fast loading
218
219### Link Best Practices
220- Use **descriptive link text**: `[View report](url)` not `[Click here](url)`
221- For external sites, full URLs work: `https://example.com`
222- Internal links use DokuWiki syntax: `[[wiki:page]]`
223
224### Content Organization
225- **Keep descriptions concise** for quick scanning
226- **Use bold** for key information
227- **Use line breaks** to separate sections
228- **One image** per event is usually enough
229
230### Accessibility
231- **Always add alt text** to images: `{{image.jpg|Description}}`
232- **Use descriptive link text** instead of bare URLs
233- **Format text clearly** with bold for emphasis
234
235---
236
237## Technical Details
238
239### Supported Image Formats
240- PNG, JPG, JPEG, GIF, WebP
241- SVG (if server allows)
242- Internal DokuWiki media files
243- External image URLs (https://)
244
245### Supported Link Formats
246- DokuWiki internal: `[[page]]`, `[[page|text]]`
247- DokuWiki external: `[[https://url]]`, `[[https://url|text]]`
248- Markdown: `[text](url)`
249- Plain URLs: `https://example.com`
250
251### HTML Support
252The following HTML tags are supported in descriptions:
253- `<strong>`, `<b>` - Bold text
254- `<em>`, `<i>` - Italic text
255- `<u>` - Underline
256- `<code>` - Inline code
257- `<br>` - Line break (or just use Enter)
258- `<img>` - Images (via syntax conversion)
259- `<a>` - Links (via syntax conversion)
260
261### Security
262- All user input is sanitized
263- External links open in new tabs with `rel="noopener noreferrer"`
264- Only safe HTML tags are allowed
265- XSS protection enabled
266
267---
268
269## Limitations
270
271### What's NOT Supported
272- ❌ Embedded videos (use links instead)
273- ❌ JavaScript or active content
274- ❌ iframes
275- ❌ Forms
276- ❌ Tables (keep descriptions simple)
277- ❌ Complex DokuWiki plugins
278
279### Workarounds
280- **Videos:** Link to YouTube/Vimeo instead of embedding
281- **Complex content:** Create a wiki page and link to it
282- **Tables:** Screenshot the table as an image
283
284---
285
286## Migration from Plain Text
287
288If you have existing events with plain text descriptions:
2891. **They will continue to work** - no changes needed
2902. **Add images** by using `{{image.jpg}}` syntax
2913. **Add links** by using `[[page]]` or `[text](url)` syntax
2924. **No data loss** - all existing content preserved
293
294---
295
296## Examples Gallery
297
298### Before (Plain Text):
299```
300Team meeting to discuss Q4 results.
301See the report at wiki:reports:q4
302Contact John for details.
303```
304
305### After (Rich Content):
306```
307**Team meeting** to discuss Q4 results.
308
309�� Report: [[wiki:reports:q4|Q4 Results]]
310�� Contact: [John Smith](mailto:john@example.com)
311�� Zoom: https://zoom.us/j/123456789
312```
313
314### With Image:
315```
316**New Product Launch**
317
318{{products:hero-image.jpg|Product hero image}}
319
320Join us for the unveiling of our latest innovation!
321
322Details: [[events:product-launch-2026]]
323RSVP: https://events.example.com/rsvp
324```
325
326---
327
328## Quick Reference
329
330| Content Type | Syntax | Example |
331|--------------|--------|---------|
332| Internal image | `{{file.jpg}}` | `{{logo.png|Logo}}` |
333| External image | `{{https://...}}` | `{{https://example.com/pic.jpg}}` |
334| Internal link | `[[page]]` | `[[projects:alpha|Project]]` |
335| External link | `[[https://...]]` | `[[https://example.com|Site]]` |
336| Markdown link | `[text](url)` | `[Docs](https://docs.example.com)` |
337| Plain URL | `https://...` | `https://example.com` |
338| Bold | `**text**` | `**Important**` |
339| Italic | `//text//` | `//Note//` |
340| Code | `<code>text</code>` | `<code>API_KEY</code>` |
341
342---
343
344**Version:** 3.0 (Compact Edition with Rich Content)
345**Last Updated:** January 24, 2026
346