mirror of
https://github.com/ONLYOFFICE/onlyoffice.github.io.git
synced 2026-02-10 18:05:06 +08:00
Merge pull request #1 from ONLYOFFICE/hellonadya-readme
Update README.md
This commit is contained in:
Sergey Linnik
99
README.md
99
README.md
@ -1,25 +1,96 @@
|
||||
## Mendeley ONLYOFFICE integration plugin
|
||||
# ONLYOFFICE Mendeley plugin
|
||||
|
||||
The add-ons for [ONLYOFFICE Document Server][2] and [ONLYOFFICE Desktop Editors][3]. Used for the developers to add specific functions to the editors which are not directly related to the OOXML format.
|
||||
Mendeley plugin allows users to create bibliographies in ONLYOFFICE editors using Mendeley service.
|
||||
|
||||
## Project Information
|
||||
The plugin is pre-installed in ONLYOFFICE Enterprise Edition, Community Edition (Document Server + Community Server), ONLYOFFICE cloud service, and ONLYOFFICE Personal.
|
||||
|
||||
Official website: [https://www.onlyoffice.com/](https://www.onlyoffice.com/?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlugins)
|
||||
For ONLYOFFICE Integration Edition as well as ONLYOFFICE Document Server integrated with a 3rd-party storage (e.g. ownCloud, Nextcloud, Seafile) manual installation is required.
|
||||
|
||||
Code repository: [https://github.com/ONLYOFFICE/web-apps](https://github.com/ONLYOFFICE/web-apps "https://github.com/ONLYOFFICE/web-apps")
|
||||
## How to use
|
||||
|
||||
SaaS version: [https://www.onlyoffice.com/cloud-office.aspx](https://www.onlyoffice.com/cloud-office.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlugins)
|
||||
1. Search references by author, title or year.
|
||||
|
||||
## Documentation
|
||||
2. Among search results, choose ones you want to add to your document.
|
||||
|
||||
To learn more about the plugin structure and find out how to integrate plugins with the editors, please refer to the [ONLYOFFICE Document Server Plugins](https://api.onlyoffice.com/plugin/basic "https://api.onlyoffice.com/plugin/basic") documentation.
|
||||
3. Choose style (e.g. Chicago Manual, American Psychological Association) and language.
|
||||
|
||||
For the detailed information about the plugin code, you can refer to the [ONLYOFFICE Document Builder](https://helpcenter.onlyoffice.com/developers/document-builder/index.aspx "https://helpcenter.onlyoffice.com/developers/document-builder/index.aspx") section.
|
||||
4. Press `Insert citation`.
|
||||
|
||||
## User Feedback and Support
|
||||
## How to install
|
||||
|
||||
If you have any problems with or questions about [ONLYOFFICE Document Server][2], please visit our official forum to find answers to your questions: [dev.onlyoffice.org][1].
|
||||
For **Integration Edition and Document Server integrated with a 3rd-party storage** (e.g. ownCloud, Nextcloud, Seafile) two installation ways are available:
|
||||
|
||||
[1]: http://dev.onlyoffice.org
|
||||
[2]: https://github.com/ONLYOFFICE/DocumentServer
|
||||
[3]: https://github.com/ONLYOFFICE/DesktopEditors
|
||||
1. Put the folder with the plugin code to ONLYOFFICE Document Server folder depending on the operating system:
|
||||
|
||||
For Linux - `/var/www/onlyoffice/documentserver/sdkjs-plugins/`.
|
||||
|
||||
For Windows - `%ProgramFiles%\ONLYOFFICE\DocumentServer\sdkjs-plugins\`.
|
||||
|
||||
The plugins will be available to all the users users of ONLYOFFICE Document Server.
|
||||
No service restart is required.
|
||||
|
||||
2. Edit the Document Server config to add the following lines:
|
||||
|
||||
```
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"editorConfig": {
|
||||
"plugins": {
|
||||
"autostart": [
|
||||
"asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
|
||||
"asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
|
||||
...
|
||||
],
|
||||
"pluginsData": [
|
||||
"https://example.com/plugin1/config.json",
|
||||
"https://example.com/plugin2/config.json",
|
||||
...
|
||||
]
|
||||
},
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
```
|
||||
|
||||
Mendeley plugin is installed by default for **Enterprise and Community Edition**.
|
||||
In case you need to install it yourself, do the following:
|
||||
|
||||
1. Clone repository
|
||||
|
||||
```
|
||||
git clone --branch community-server git@github.com:ONLYOFFICE/onlyoffice-mendeley.git
|
||||
```
|
||||
|
||||
2. Copy `onlyoffice-mendeley` directory to `<community-server>\web\studio\ASC.Web.Studio\ThirdParty\plugin\mendeley`
|
||||
|
||||
```
|
||||
cp src <community-server>\web\studio\ASC.Web.Studio\ThirdParty\plugin\mendeley
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
For **Enterprise and Community Edition**
|
||||
|
||||
1. Proceed to `Settings` -> `Integration` -> `Third Party Authorization`, find `Mendeley` and turn it on. Popup with configuration will appear.
|
||||
|
||||
2. Register the app here https://dev.mendeley.com/myapps.html. Use https://service.onlyoffice.com/oauth2.aspx as a redirect URL.
|
||||
|
||||
3. Press `Generate secret`, copy the secret and get the application id.
|
||||
|
||||
4. Paste the secret and the application id into the form in the popup configuration window.
|
||||
|
||||
For **Integration Edition and Document Server integrated with a 3rd-party storage** (e.g. ownCloud, Nextcloud, Seafile):
|
||||
|
||||
You will need to register the application.
|
||||
|
||||
1. Go to https://dev.mendeley.com/myapps.html.
|
||||
|
||||
2. Fill in the form using link provided in the plugin interface as a redirect URL.
|
||||
|
||||
3. Press `Generate secret` and copy it.
|
||||
|
||||
4. Insert the secret into the appropriate field in the plugin interface.
|
||||
|
||||
## User feedback and support
|
||||
|
||||
To ask questions and share feedback, use Issues in this repository.
|
||||
|
||||
Reference in New Issue
Block a user