Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
playground:howto [2025/11/15 07:16] – rahulplayground:howto [2025/11/15 07:36] (current) – rahul
Line 1: Line 1:
 +====== HOWTO ======
 +
 A user-friendly guide to adding and editing content on the IEEE Smart Village DokuWiki. A user-friendly guide to adding and editing content on the IEEE Smart Village DokuWiki.
 +
 +{{pdfjs 800,600>:playground:howto.pdf|?page-width}}
  
 ==== Getting Started: Creating a New Page ==== ==== Getting Started: Creating a New Page ====
Line 8: Line 12:
  
 **Create the page**: If the page doesn't exist, you'll see a "This topic does not exist yet" message. Click the "Create this page" button to open the editor. **Create the page**: If the page doesn't exist, you'll see a "This topic does not exist yet" message. Click the "Create this page" button to open the editor.
 +
 ==== Editing an Existing Page ==== ==== Editing an Existing Page ====
  
Line 18: Line 23:
 **Bold and Italic**: **Bold and Italic**:
  
-For **bold** text, wrap it in double asterisks: +For **bold** text, wrap it in double asterisks: ''%%**text**%%''
-<code> +
-**text**+
  
-</code>+For //italic// text, wrap it in double slashes: ''%%//text//%%''
  
-For //italic// text, wrap it in double slashes: +For **underlined** text, wrap it in double underscores: ''%%__text__%%''
-<code> +
-//text// +
- +
-</code> +
- +
-For **underlined** text, wrap it in double underscores: +
-<code> +
-__text__ +
- +
-</code>+
  
 **Headlines**: Use the equals sign = to create headlines. More equals signs create smaller headlines. **Headlines**: Use the equals sign = to create headlines. More equals signs create smaller headlines.
 <code> <code>
-====== Large Heading ======+====== Large Heading ====== 
  
 ===== Medium Heading ===== ===== Medium Heading =====
  
 ==== Small Heading ==== ==== Small Heading ====
- 
 </code> </code>
  
Line 51: Line 43:
  
 **Ordered Lists**: To create a numbered list, indent your text with two spaces and use a hyphen - for each item. **Ordered Lists**: To create a numbered list, indent your text with two spaces and use a hyphen - for each item.
 +
 ==== Creating Links ==== ==== Creating Links ====
  
 **Internal Links**: To link to another page within the wiki, use double square brackets. **Internal Links**: To link to another page within the wiki, use double square brackets.
-<code> 
-[[:playground:page_name|]] 
  
-</code>+''%%[[page_name]]%%'' will create a link to "page_name".
  
-will create a link to "page_name". +''%%[[page_name|link text]]%%'' will create a link to "page_name" with the text "link text".
-<code> +
- +
-[[:playground:page_name|link text]] +
- +
-</code> +
- +
-will create a link to "page_name" with the text "link text".+
  
 **External Links**: To link to an external website, simply paste the full URL. **External Links**: To link to an external website, simply paste the full URL.
-<code> 
  
-[[http://www.example.com|http://www.example.com]]+''%%http://www.example.com%%'' will create a link to that URL.
  
-</code> +''%%[[http://www.example.com|link text]]%%'' will create a link with custom text.
- +
-will create a link to that URL. +
-<code> +
- +
-[[http://www.example.com|link text]] +
- +
-</code> +
- +
-will create a link with custom text.+
  
 ==== Adding Images ==== ==== Adding Images ====
Line 89: Line 63:
  
 **Embed the image**: To embed an image into a page, use double curly braces. **Embed the image**: To embed an image into a page, use double curly braces.
-<code> 
  
-[[:playground:image.jpg?id=playground%3Ahowto&media=playground:image.jpg|{{:playground:image.jpg|image.jpg}}]] +''%%{{image.jpg}}%%''
- +
-</code>+
  
 ==== Saving Your Work ==== ==== Saving Your Work ====
  
 Once you are finished editing, you will see a "Save" button. Click this to save your changes. It's a good practice to also use the "Preview" button to see how your changes will look before saving. Once you are finished editing, you will see a "Save" button. Click this to save your changes. It's a good practice to also use the "Preview" button to see how your changes will look before saving.
 +
 +Here is a guide on how to embed PDFs and import content from Microsoft Word files into your DokuWiki pages.
  
 ==== Embedding PDF Files ==== ==== Embedding PDF Files ====
Line 103: Line 76:
 While DokuWiki doesn't natively display PDFs directly on the page, you can link to them. A common way to embed a PDF is by using the pdfjs plugin, which displays the PDF in a viewer within the wiki page. While DokuWiki doesn't natively display PDFs directly on the page, you can link to them. A common way to embed a PDF is by using the pdfjs plugin, which displays the PDF in a viewer within the wiki page.
  
-  - Upload the PDF: First, use the "Media Manager" to upload your PDF file to the wiki. +**Upload the PDF**: First, use the "Media Manager" to upload your PDF file to the wiki.
-  - Embed the File: To embed the uploaded PDF, insert the following syntax into your page, replacing your_file.pdf with the name of your uploaded file: +
-<code>+
  
-{{pdfjs>;your_file.pdf}} +**Embed the File**: To embed the uploaded PDF, insert the following syntax into your page, replacing your_file.pdf with the name of your uploaded file: ''%%{{pdfjs>your_file.pdf}}%%''
- +
-</code>+
  
 This will display the PDF with a default width of 100% and a height of 300px. This will display the PDF with a default width of 100% and a height of 300px.
  
-Customizing the Viewer Size+**Customizing the Viewer Size**
  
 You can customize the height and width of the PDF viewer. You can customize the height and width of the PDF viewer.
  
-  * To set only the height (e.g., to 500 pixels):+To set only the height (e.g., to 500 pixels): ''%%{{pdfjs>your_file.pdf|500}}%%''
  
-<code> +To set both width and height (e.g., 800 pixels wide by 600 pixels high): ''%%{{pdfjs>your_file.pdf|800,600}}%%''
-{{pdfjs>;your_file.pdf|500}}+
  
-</code>+==== Adding Content from Microsoft Word ====
  
-  * To set both width and height (e.g., 800 pixels wide by 600 pixels high): +When dealing with content from .docx files, especially troublesome ones, you can use the "Paste from Word" feature available in the CKEditor.
-<code>+
  
-{{pdfjs>;your_file.pdf|800,600}}+**Using the "Paste from Word" Button**
  
-</code>+**Copy from Word**: Select and copy the content from your Microsoft Word document.
  
-==== Adding Content from Microsoft Word ====+**Click in the Editor**: In the DokuWiki editor, you must first click inside the text window where you want the content to go.
  
-When dealing with content from .docx files, especially troublesome ones, you can use the "Paste from Word" feature available in the CKEditor.+**Paste from Word**: Locate the "Paste from Word" button on the far right of the CKEditor toolbar and click it. This will open a dialog box.
  
-Using the "Paste from Word" Button+**Paste and Insert**: Paste your content into the text window of the dialog box and click "OK."
  
-  - Copy from Word: Select and copy the content from your Microsoft Word document. +**Limitations and Tips**
-  - Click in the Editor: In the DokuWiki editor, you must first click inside the text window where you want the content to go. +
-  - Paste from Word: Locate the "Paste from Word" button on the far right of the CKEditor toolbar and click it. This will open a dialog box. +
-  - Paste and Insert: Paste your content into the text window of the dialog box and click "OK."+
  
-=== Limitations and Tips ===+Be aware of the following limitations when pasting from Word:
  
-Be aware of the following limitations when pasting from Word:+**Basic Lists Only**: The tool currently has basic support for lists. 
 + 
 +Only one list can be inserted at a time. 
 + 
 +Nested (multi-level) lists are not supported.
  
-  * Basic Lists Only: The tool currently has basic support for lists. +**Cleaning Complex Lists**: For complex lists, it is best to paste them directly into the main CKEditor window first. Then, select the pasted list with your mouse and open the "Paste from Word" dialog. The list will load into the text window, and clicking "OK" will clean up the formatting for DokuWiki.
-  * Only one list can be inserted at a time. +
-  * Nested (multi-level) lists are not supported. +
-  * Cleaning Complex Lists: For complex lists, it is best to paste them directly into the main CKEditor window first. Then, select the pasted list with your mouse and open the "Paste from Word" dialog. The list will load into the text window, and clicking "OK" will clean up the formatting for DokuWiki. +
-  * Precise Selections: For both lists and tables, try to make your selection as exact as possible in the Word document before copying.+
  
 +**Precise Selections**: For both lists and tables, try to make your selection as exact as possible in the Word document before copying.