Meryam Sahin (talk | contribs)
No edit summary
Meryam Sahin (talk | contribs)
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Word Import''' allows you to import Word documents and convert their content into wiki pages. This functionality is provided by the '''ImportOfficeFiles''' extension. Depending on the structure of the document, the content is imported as a single page or split into a page with subpages. Images contained in the document are imported together with the page content. Imported pages can be used as a page collection to create a '''Book.'''
<status color="green" light="true">done</status> '''in real Helpdesk'''<br>
'''Word Import''' allows you to import Word documents and convert their content into wiki pages. This functionality is provided by the '''ImportOfficeFiles''' extension. Depending on the structure of the document, the content is imported as a single page or split into a page with subpages. Images contained in the document are imported together with the page content. Imported pages can be used as a page collection to create a '''Book.'''  
== Prepare a Word document for import ==
== Prepare a Word document for import ==
{{Textbox|boxtype=note|header=Note:|text=Word Import requires DOCX files to be enabled as an allowed upload file type in the wiki configuration. This is the default setting. Administrators can manage this setting in the '''Config Manager'''.|icon=yes}}
{{Textbox|boxtype=note|header=Note:|text=Word Import requires DOCX files to be enabled as an allowed upload file type in the wiki configuration. This is the default setting. Administrators can manage this setting in the [[Extension/BlueSpiceConfigManager|'''Config Manager''']].|icon=yes}}
Before importing a Word document, review its structure to ensure that the content can be converted correctly. During the import, the following elements are converted into wiki content:
Before importing a Word document, review its structure to ensure that the content can be converted correctly. During the import, the following elements are converted into wiki content:
* '''Document title''':
* '''Document title''':
Line 21: Line 22:
* '''Bullet points''':
* '''Bullet points''':
** Review imported bullet points and adjust them if necessary.
** Review imported bullet points and adjust them if necessary.
 
==Import a Word document==
 
'''Import a Word document:'''
 
#Select the '''New content''' button > '''New Word file import''' [[File:importword-menu.png|alt=Import menu|center|thumb|173x173px|Import menu]]
(STOPPED HERE!!!)
#Select '''Select a file''' and choose the Word document, or drag the document into the upload area.[[File:importword-upload.png|alt=Upload dialog|center|thumb|Upload dialog]]
 
#Select '''Next'''.
 
#Configure the import settings: [[File:importword-settings.png|alt=Settings|center|thumb|Settings]]
==Import a word document==
##'''Title:''' Enter the title of the main wiki page. If the content is split into multiple pages, the importated pages are created as subpages of this page.  
'''To import a Word document:'''
##'''Content structure:''' Select '''Split content to pages''' to create multiple wiki pages from the Word document. The heading levels in the Word document determine the page strucutre. Up to three heading levels are supported.  
 
##'''Conflicts with page title''': Select how to handle an existing page with the same title:  
#'''Click''' ''New > Import Word file'' in the top menu. [[File:importword-menu.png|alt=Import menu|center|thumb|173x173px|Import menu]]
##*'''Rename:''' Creates the imported page with a modified title, such as <code>Page name (1)</code>. Avoid this option for large Word documents that are split into multiple pages. The modified page name becomes part of the path of all imported subpages. For example, if the original page is names <code>Employee handbook</code>, the imported pages are created below <code>Employee handbook (1)</code>. If the preview shows a naming conflict, select '''Cancel''' and enter a different page title, or select '''Override''' to replace the existing page.
#'''Click''' ''Select a file'' or drag the Word file in the drop zone.[[File:importword-upoad.png|alt=Upload dialog|center|thumb|Upload dialog]]
##*'''Override''': Replaces the existing page with the imported content.
#'''Click''' ''Next''.
#Select '''Next'''.  
#'''Choose''' the import settings you want.[[File:importword-settings.png|alt=Settings|center|thumb|Settings]]
# Review the preview:
##'''Title:'''The title of the wiki page generated by the import. When the content structure is broken up, the chapters are created as sub-pages of this main page.
#* Check the names of the pages that will be created.
##'''Content structure:''' If the "Split content to pages" checkbox is activated, subpages are created from the heading levels of the Word document. This is possible up to 3 levels deep.
#* Select the '''arrow''' icon to view the files imported with an individual page.
##'''Conflicts with page title''':
#* Select the '''eye''' icon to preview the content of an indiviual page.  
##*''Rename:'' The imported page is created as <p''age name>'' (1). However, this should be avoided, especially with large Word files that are divided into additional levels. It is best to enter a new page title here as an alternative. A naming conflict is displayed in the preview. In this case, if necessary, click Cancel to start the import with a new title. Or select "Override" as a conflict resolution.
#Select '''Import'''.
##*''Override'': The existing page(s)  will be overwritten with a new version.
<br>
#'''Click''' ''Next''. <br />The preview shows: (1) the names of the pages that will be created   (2) via the arrow icon: the files that will be imported for the individual pages  (3) via the eye icon: the content of the individual wiki pages.
After the import is complete, the imported pages are available as a page collection. In an English-language wiki, the page collection is stored under '''MediaWiki:Page collection'''. You can use the page collection to create a book.
#'''Click''' ''<u>I</u>mport.'' After the import is complete, the created pages are displayed as a page collection in the wiki. You can view the pages from this page by clicking on the link.
==Create a book from imported pages==
{{Messagebox|boxtype=note|icon=|Note text=In a wiki installed with "English" as the content language (contentlanguage), the path to the page starts with ''MediaWiki:Page collection''.|bgcolor=}}
After importing the Word document, create a new book. For information about creating and managing books, see [[Extension/BlueSpiceBookshelf|books]]. <br>
 
'''Add imported pages to a book''':
==Create a book==
#Open the book's content page.  
It is easy to create a book from the imported pages:
#Select '''Add multiple pages'''.
 
#Select '''Page collection''' as the source.  
#'''Click''' the plus button.
#Select the page collection created by the Word import. All pages from the page collection are added to the book in the same order as they appear in the page collection. You can use drag and drop to change the order of the pages and create a hierarchy. By default, the chapter titles display the full page path of the imported pages. To change the chapter title, select the '''Actions menu''' at the end of the corresponding page and select '''Edit'''. In the dialog, enter the chapter title in the '''Text''' field.  
#'''Enter''' a book title and click Done.
#Save the book content page. <br>
#'''Click''' the Bulk Add button.
The book is now available on the '''Books overview''' page.  
#'''Select''' Page Collection as the source.
== Troubleshoot ==
#'''Select t'''he page name of the imported file.[[File:ImportOffice-pagecollection.png|alt=Select page collection|center|thumb|450x450px|Select page collection]]The pages have been added.[[File:ImportOffice-bookpages.png|alt=Add book pages and save chapter navigation|center|thumb|650x650px|Add book pages and save chapter navigation]]
#'''Choose''' ''Save and add book navigation to each wiki page'' from the '''Save''' menu.
#'''Click''' ''OK'' in the dialog "Change wikipage" associations. This will add the chapter navigation to each book in the page.[[File:ImportOffice-bookshelf tag.png|alt=add bookshelf tag to book pages|center|thumb|250x250px|add bookshelf tag to book pages]]
The book is now available on the Bookshelf page of your wiki.
 
=== Change the display title of your book chapters ===
Since the display titles of the book pages show the path of the imported subpages, it makes sense to edit the display titles afterwards. To do this, open the book page in source edit mode and remove the path with the trailing "/".
 
[[File:ImportOffice-booksource1.png|alt=Changing the chapter titles|center|thumb|650x650px|Changing the chapter titles]]
If the book has a lot of pages, you can copy the source code into an editor like Notepad++ and replace the following text:<div>
|Employee handbook/
</div>Replace the text and t'''ake care that the vertical pipe''' after the actual page name and before the page title '''is the replacement text'''.<div>
|
</div>Copy the source code back to the wiki and save the book page.
 
[[File:ImportOffice-updatedbooktitles.png|alt=Updated book titles|center|thumb|650x650px|Updated book titles]]
 
== Sources of error ==
 
=== Images are not imported ===
=== Images are not imported ===
 
* '''Images with a background or shadow''': Only the background or shadow is imported. Remove the background or shadow from the image before importing the Word document.  
* Images have a background/shadow and only the background/shadow is imported: These images are not supported. Solution: Remove the background/shadow before the import.
* '''Images are embedded as <code>.tmp</code> files''': The images are embedded as <code>.tmp</code> files in the Word document. Save the images locally and replace the original images in the Word document before importing it.
* Images are embedded as .tmp files in the Word document for an unknown reason. Solution: Before importing, save the images from the Word document locally and then use them to replace the original image in the Word document.
{{Box Links-en|Topic1=[[Reference:ImportOfficeFiles]]|Topic2=[[Manual:Extension/BlueSpiceBookshelf|Books]]}}{{translation}}

Latest revision as of 11:45, 19 October 2026

done in real Helpdesk
Word Import allows you to import Word documents and convert their content into wiki pages. This functionality is provided by the ImportOfficeFiles extension. Depending on the structure of the document, the content is imported as a single page or split into a page with subpages. Images contained in the document are imported together with the page content. Imported pages can be used as a page collection to create a Book.

Prepare a Word document for import

Note:Word Import requires DOCX files to be enabled as an allowed upload file type in the wiki configuration. This is the default setting. Administrators can manage this setting in the Config Manager.

Before importing a Word document, review its structure to ensure that the content can be converted correctly. During the import, the following elements are converted into wiki content:

  • Document title:
    • The document should contain only one title. If several titles exist, error messages are displayed in the wiki at the relevant locations.
  • Text:
    • Most text formatting is removed. Some formatting, such as bold and italic text, is retained.
    • Text boxes are converted to unformatted text.
  • Headings:
    • Use correct heading levels if you want the document to be converted into multiple subpages.
  • Images:
    • Images are imported into the wiki.
    • Image names are generated using the format Wiki-page-name_image_<consecutive number>.
    • Image overlays are not imported.
    • Image names are inserted below the image. Consecutive numbering of the images cannot be continued in the wiki.
    • Images are inserted as centered thumbnails by default.
Note:When uploading images, the system does not check whether the same image already exists in the wiki.
  • Tables:
    • Tables are converted into wikitext tables.
  • Bullet points:
    • Review imported bullet points and adjust them if necessary.

Import a Word document

Import a Word document:

  1. Select the New content button > New Word file import
    Import menu
    Import menu
  2. Select Select a file and choose the Word document, or drag the document into the upload area.
    Upload dialog
    Upload dialog
  3. Select Next.
  4. Configure the import settings:
    Settings
    Settings
    1. Title: Enter the title of the main wiki page. If the content is split into multiple pages, the importated pages are created as subpages of this page.
    2. Content structure: Select Split content to pages to create multiple wiki pages from the Word document. The heading levels in the Word document determine the page strucutre. Up to three heading levels are supported.
    3. Conflicts with page title: Select how to handle an existing page with the same title:
      • Rename: Creates the imported page with a modified title, such as Page name (1). Avoid this option for large Word documents that are split into multiple pages. The modified page name becomes part of the path of all imported subpages. For example, if the original page is names Employee handbook, the imported pages are created below Employee handbook (1). If the preview shows a naming conflict, select Cancel and enter a different page title, or select Override to replace the existing page.
      • Override: Replaces the existing page with the imported content.
  5. Select Next.
  6. Review the preview:
    • Check the names of the pages that will be created.
    • Select the arrow icon to view the files imported with an individual page.
    • Select the eye icon to preview the content of an indiviual page.
  7. Select Import.


After the import is complete, the imported pages are available as a page collection. In an English-language wiki, the page collection is stored under MediaWiki:Page collection. You can use the page collection to create a book.

Create a book from imported pages

After importing the Word document, create a new book. For information about creating and managing books, see books.
Add imported pages to a book:

  1. Open the book's content page.
  2. Select Add multiple pages.
  3. Select Page collection as the source.
  4. Select the page collection created by the Word import. All pages from the page collection are added to the book in the same order as they appear in the page collection. You can use drag and drop to change the order of the pages and create a hierarchy. By default, the chapter titles display the full page path of the imported pages. To change the chapter title, select the Actions menu at the end of the corresponding page and select Edit. In the dialog, enter the chapter title in the Text field.
  5. Save the book content page.

The book is now available on the Books overview page.

Troubleshoot

Images are not imported

  • Images with a background or shadow: Only the background or shadow is imported. Remove the background or shadow from the image before importing the Word document.
  • Images are embedded as .tmp files: The images are embedded as .tmp files in the Word document. Save the images locally and replace the original images in the Word document before importing it.