IlyaSobolev/helpcenter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 27 Wiki Activity

Added Liferay Integration Getting Started

Browse Source
This commit is contained in:
Ilya Sobolev 2020-08-11 18:48:39 +03:00
parent fce6335e42
commit b263af6bd0
2 changed files with 98 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Web/Controls/Help/FAQ/Connectors/Connectors.ascx
View File

@ -296,4 +296,31 @@
</dd>
</dl>
<h2>Liferay</h2>
<p class="fq_expand"><span>Expand all</span></p>
<p class="fq_collapse"><span>Collapse all</span></p>
<dl class="faq_block" id="liferay_1">
<dt>How it works?</dt>
<dd>
<ul class="howitworks">
<li>User navigates to a <b>Documents and Media</b> section within Liferay and selects the <code>Edit in ONLYOFFICE</code> action.</li>
<li>Liferay prepares a JSON object for the Document Server with the following properties:
<ul class="howitworks">
<li><b>url</b> - the URL that ONLYOFFICE Document Server uses to download the document;</li>
<li><b>callbackUrl</b> - the URL that ONLYOFFICE Document Server informs about status of the document editing;</li>
<li><b>key</b> - the fileVersionId to instruct ONLYOFFICE Document Server whether to download the document again or not;</li>
<li><b>title</b> - the document Title (name);</li>
</ul>
</li>
<li>The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the docEditor configuration with the above properties.</li>
<li>Then ONLYOFFICE Document Server downloads the document from Liferay and the user begins editing.</li>
<li>ONLYOFFICE Document Server sends a POST request to the <em>callbackUrl</em> to inform Liferay that a user is editing the document.</li>
<li>Liferay locks the document, but still allows other users with write access the ability to collaborate in real time with ONLYOFFICE Document Server by leaving the Action present.</li>
<li>When all users and client browsers are done with editing, they close the editing window.</li>
<li>After <a target="_blank" href="https://api.onlyoffice.com/editors/save#savedelay">10 seconds</a> of inactivity, ONLYOFFICE Document Server sends a POST to the callback URL letting Liferay know that the clients have finished editing the document and closed it.</li>
<li>Liferay downloads the new version of the document, replacing the old one.</li>
</ul>
</dd>
</dl>
</div>

71
Web/Controls/Help/GettingStarted/Integration/Liferay/Liferay.ascx
View File

@ -0,0 +1,71 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Integration. Getting Started. Liferay";
MetaKeyWords = "integration, connector, online editing, liferay, edit, share, store";
MetaDescription = "Integrate ONLYOFFICE with Liferay digital experience platform software";
var guides = new GuidesModel();
guides.CaptionRelatedTips = "Related Tips & Tricks";
guides.Title = "Import Files from Other Sources";
guides.RelatedTips = "Do you have some documents stored in other web-sources like Zoho, Google Drive or Box? You can easily import them to the Documents module.";
guides.LearnMore = "Learn more...";
(Page as BasePage).Guides = guides;
}
</script>
<div class="MainHelpCenter GettingStarted">
<ul class="TableOfContents">
<li><span class="gs_link gs_active" id="all">All</span></li>
<li><span class="gs_link" id="Overview">Overview</span></li>
<li><span class="gs_link" id="OnlineEditorsIntegration">Online editors integration</span></li>
</ul>
<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/collaborative-editing/collaborative-editing.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/docker-version/docker-version.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/linux-version/linux-version.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/local-server/local-server.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/document-server/document-server.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/open-source-version/open-source-version.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/install-onlyoffice/install-onlyoffice.ascx" /></li>
</ul>
</div>
<div class="gs_content" id="Overview_block">
<h2>Overview</h2>
<div class="PortalHelp">
<p>Integrating ONLYOFFICE with Liferay digital experience platform through a connector, available in <a href="https://web.liferay.com/marketplace/-/mp/application/171169174" target="_blank"><b>Liferay Marketplace</b></a> or on ONLYOFFICE <a href="https://github.com/ONLYOFFICE/onlyoffice-liferay" target="_blank"><b>GitHub page</b></a>, allows you to edit Office documents within the document library.</p>
<p>ONLYOFFICE Connector for Liferay adds the following features:</p>
<ul>
<li>A new <b>ONLYOFFICE Edit/View</b> menu option within the <em>/em>Documents and Media</em> section for Office documents.</li>
<li>Co-editing documents in real-time: use two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat.</li>
<li>Editing the following formats: DOCX, XLSX, PPT. These are also available for viewing in PDF together with ODT, ODS, ODP, DOC, XLS, PPT formats.</li>
</ul>
<p>Visit our For <a href="https://api.onlyoffice.com/editors/liferay" target="_blank"><b>Developers page</b></a> to find out more about the ONLYOFFICE Connector for Liferay and how it works in details.</p>
</div>
</div>
<div class="gs_content" id="OnlineEditorsIntegration_block">
<h2>Online editors integration</h2>
<h3>Installing Liferay ONLYOFFICE integration app</h3>
<div class="PortalHelp">
<p>This <a href="https://github.com/ONLYOFFICE/onlyoffice-liferay" target="_blank"><b>app</b></a> enables users to edit office documents from <a href="https://www.liferay.com/" target="_blank"><b>Liferay</b></a> using ONLYOFFICE Document Server.</p>
</div>
<h3>Configuring Liferay ONLYOFFICE integration app</h3>
<div class="PortalHelp">
<p>In order to configure the app you must navigate to <b>System Settings</b> <code>(Control Panel -> Configuration -> System Settings)</code>. In <b>Platform</b> section click on <b>Connectors</b> category and select ONLYOFFICE.</p>
</div>
<h3>Compiling Liferay ONLYOFFICE integration app</h3>
<div class="PortalHelp">
<p>Simply run <code>gradle build</code>. Output .jar will be placed inside <code>build/libs</code> directory.</p>
</div>
</div>
</div>