From 356d9c2bee98530ff1426c8fb771aff46b66d666 Mon Sep 17 00:00:00 2001 From: Adam Dupaski Date: Wed, 13 May 2020 14:03:17 +0200 Subject: [PATCH] Add link to documentation So that the documentation is easily available and only needs to be maintained in one place, the README for this component should feature a link to the proper component doc published in the App Store Guide. This is also the content that should appear on the **Documentation** tab in the App Store for the component upon the next and all future releases. Please update the App Store Guide as you update the component. You can contact me with any questions. --- README.md | 25 +------------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/README.md b/README.md index 14d5cf1..95f2752 100644 --- a/README.md +++ b/README.md @@ -1,24 +1 @@ -FileDocumentViewer [![Support](https://img.shields.io/badge/Mendix%20Support%3A-Platform-green.svg)](https://docs.mendix.com/community/app-store/app-store-content-support) -================== - -This widget allows to embed and view any System.FileDocument object inside a form. In the modeler, using microflows or the file downloader, documents can be opened as download or inside a new window. With this widget however, files can be opened inside dataviews. - -Please take note that this will only work for Documents that can normally be viewed in the browser. We support viewing PDF either natively (Chrome, Firefox) or through PDF.js. Files like Word or Excel are usually not viewable in the browser. If you try this with the FileDocumentViewer, the browser will not view the document, but download it. - -## Contributing -For more information on contributing to this repository visit [Contributing to a GitHub repository](https://world.mendix.com/display/howto50/Contributing+to+a+GitHub+repository)! - -## Configuration -Add the widget to a dataview. The context object should inherit from the System.FileDocument entity. - -## Features -The widget tries to display a document inside a form, however it might fail to do this (in which case a download popup is opened) since the browser settings determine whether it is allowed or not to open a document inside a form. For example IE might succeed in opening a .doc file inside a form and fail in opening a .png image inside a form, while exactly the opposite might be true for FireFox. - -## Properties - -* `Title` - String attribute of which the contents will be set in the header. -* `Show header` - Determines whether or not a header will be rendered. - -## PDFJS support - -In the Modeler there is the option `Use PDF js`. This will take over the rendering of the PDF, because native rendering is not supported on Android. That is why we include [PDF.js](https://mozilla.github.io/pdf.js/), created by Mozilla (PDF.js is actually a part of Firefox). Make sure the documents you are trying to view are PDF files, otherwise the widget will fail to show the document. Use this option if you are having trouble viewing the documents on mobile devices for example. +Please see [Document Viewer](https://docs.mendix.com/appstore/widgets/document-viewer) in the Mendix documentation for details.