{"_id":"@cnsumanth/ckeditor5-internalpagelink-plugin","_rev":"1-1e5666a15895bb83664623a1a1769ac2","name":"@cnsumanth/ckeditor5-internalpagelink-plugin","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.2":{"name":"@cnsumanth/ckeditor5-internalpagelink-plugin","version":"0.0.2","description":"A generic ckeditor plugin to create link between the pages containing.","keywords":["ckeditor","ckeditor5","ckeditor 5","ckeditor5-feature"],"dependencies":{"@ckeditor/ckeditor5-core":"^11.0.1","@ckeditor/ckeditor5-engine":"^11.0.0","@ckeditor/ckeditor5-ui":"^11.1.0","awesomplete":"^1.1.2","axios":"^0.18.0"},"devDependencies":{"@ckeditor/ckeditor5-editor-classic":"^11.0.1","@ckeditor/ckeditor5-enter":"^10.1.2","@ckeditor/ckeditor5-heading":"^10.1.0","@ckeditor/ckeditor5-paragraph":"^10.0.3","@ckeditor/ckeditor5-typing":"^11.0.1","@ckeditor/ckeditor5-undo":"^10.0.3","@ckeditor/ckeditor5-utils":"^11.0.0","eslint":"^5.9.0","eslint-config-ckeditor5":"^1.0.7","husky":"^0.14.3","lint-staged":"^7.0.0"},"engines":{"node":">=6.9.0","npm":">=3.0.0"},"scripts":{"lint":"eslint --quiet '**/*.js'","precommit":"lint-staged"},"lint-staged":{"**/*.js":["eslint --quiet"]},"eslintIgnore":["src/lib/**","packages/**"],"gitHead":"c755bc4237a7480acf9d9f37b33cdbaeca4c6b31","_id":"@cnsumanth/ckeditor5-internalpagelink-plugin@0.0.2","_nodeVersion":"13.14.0","_npmVersion":"6.14.4","dist":{"integrity":"sha512-QS9w1agNIRuCxpkGpJlOmUAuU3Bxfds+P6DD+z4Te50HAl04LKztPls+VRRdnnXLPGl/lklWZTt2AHxWql3gyw==","shasum":"eb08cd3a2056bec69427406f82017cab99ce3624","tarball":"https://registry.npmjs.org/@cnsumanth/ckeditor5-internalpagelink-plugin/-/ckeditor5-internalpagelink-plugin-0.0.2.tgz","fileCount":25,"unpackedSize":69586,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgojbsCRA9TVsSAnZWagAAxSMP/iXxe+soDIKyOtOPgQIo\nxYL6KC5vNrD++rYUCzdwes3aYw/FK7YfDlYqNqWvMmzzuGFfuOVQbBSI8N8S\n2K4K/f6tHwUnTalMlc8P3p7O2UOz2ZAKA1uZD8u85F/ozOMuJO50nHx6juIt\nxtGsQCFvz4FPchl0dHmOV3Mxs7NTVISGTn1cokU8fbFZ3t0F5J4JQLzFebdq\nLhYWzdB8Ad4U/g+zTUoy7h64WyW5WBeuTqErBsOOZ0OOIIGz3RMcm8VlpRTt\nH1E54Dp5OxTPIHFTG+me+eAM6H0dx9e17yymRcf8aHtqp61GHLXO/mT+5umx\nAg0pDnMEYl97KNZWBvHY5PFV9PUca4+eiW/yxXcmnrFghpqKNyfc8SrLhSSd\nRH+maKT6oE0wuAim4tavZmZW2uACpdR8jd7vJMWkeWxSA+TDrS69AZNkHbGh\nuDQsLFe4CAPkw1N4pxVSGWc/IM7WWCz6SesgockaPiWm0g8qBGmW9E1C3dTD\ntxDfV12LOcRt5/AR3pnc0xEAKEoVMVDch+iLQnIvSpvw8CN9DEIPQdPa41qz\nQm6lRg3qYfVwTMliuXkP2XklXUQFA/rVawgjp6DD2dCFojM2wMo/Cv2679iv\nwJYRO050OY1aTd44Cmjfy/QVlrl/SbhXMtyZA2ezKG+XT71sGL/IeefHyfgS\n5lqW\r\n=4rgJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD8oL9I0jep4aOsU3NblT80pbWJabG1SGDYRE10lfPWZwIgKqf2RldsPKcXKoA0OZFg74dEZiWM0Z3FftNmnw6xLRg="}]},"_npmUser":{"name":"cnsumanth","email":"cnsumanth@gmail.com"},"directories":{},"maintainers":[{"name":"cnsumanth","email":"cnsumanth@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ckeditor5-internalpagelink-plugin_0.0.2_1621243627942_0.19614567884405343"},"_hasShrinkwrap":false}},"time":{"created":"2021-05-17T09:27:07.891Z","0.0.2":"2021-05-17T09:27:08.122Z","modified":"2022-04-04T23:52:02.225Z"},"maintainers":[{"name":"cnsumanth","email":"cnsumanth@gmail.com"}],"description":"A generic ckeditor plugin to create link between the pages containing.","keywords":["ckeditor","ckeditor5","ckeditor 5","ckeditor5-feature"],"readme":"\n\n# ckeditor5-internallink-plugin\nA generic ckeditor plugin to create custom html tags containing an identifier to a referenced item.\nThe referencable items are found by an autocomplete input.\n\n## Overview\nThis plugin has the same features as the default link plugin except that it does not create regular link tags.\n\n![alt text](https://raw.githubusercontent.com/SamhammerAG/ckeditor5-internallink-plugin/master/README_Autocomplete.png)\n\nThe HTML-Tags of this plugin are looking as following:\n\n```\n<internallink internallinkid=\"123\">some text</internallink>\n```\n\n![alt text](https://raw.githubusercontent.com/SamhammerAG/ckeditor5-internallink-plugin/master/README_Preview.png)\n  \n## Features\n\n - Create and edit links\n - Remove links\n - Configurable autocomplete to find the referenceable item\n - Show a label (title) instead of the item id\n - Open the referenced item in a new tab\n - If text is marked the link will be added to it. Otherwise the item title with a link will be added to the text.\n - Configurable webservice urls to get the required data\n - Test mode to test the plugin without having to implement a webservice\n \n## How to use\nTo be able to use this plugin you need a custom build of ckeditor.\n\nFurther instructions can be found here:\nhttps://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html\n\nAdd the NPM-Package (https://www.npmjs.com/package/@samhammer/ckeditor5-internallink-plugin) by running one of the following commands (depending on your build environment):\n\n```bash\nyarn add @samhammer/ckeditor5-internallink-plugin\nnpm i @samhammer/ckeditor5-internallink-plugin\n```\n\ne.g.: https://github.com/SamhammerAG/ssp-ckeditor5-build-inline\n\nNote: We prefer yarn so it is only testet with this build tool.\n\n## Configuration\nConfiguration flags:\n\n| Flag name | Description | Example |\n| --- | --- | --- |\n| testmode | If set to true the plugin can be tested without autocompleteurl and titleurl | true or false |\n| autocompleteurl | Configure a json webservice that returns the autocomplete suggestions. The placeholder **{searchTerm}** is replaced by the search term that is entered to the autocomplete textbox. | http://www.example.com/autocomplete?term={searchTerm} |\n| titleurl | Configure a json webservice that returns the title for a referenced item. This service is called on editing an existing link. The placeholder **{internalLinkId}** is replaced by the id of the referenced item. | http://www.example.com/gettitle?itemid={internalLinkId} |\n| previewurl | The url that is used to open a preview of the referenced item in a new tab. The placeholder **{internalLinkId}** is replaced by the id of the referenced item. | http://www.google.de?q={internalLinkId} |\n\nExample:\n\n```js\nInlineEditor\n\t.create( editorElement, {\n\t\tinternallink: {\n\t\t\ttestmode: false,\n\t\t\tautocompleteurl: '',\n\t\t\ttitleurl: '',\n\t\t\tpreviewurl: ''\n\t\t}\n\t} )\n\t.then( ... )\n\t.catch( ... );\n```\n\n## Webservice response data format\n\nThis plugin requires webservices that are returning json data.\nWe are using axios to do HTTP-GET requests.\n\n### Autocomplete response\n\n```\n[\n    { label:  'Text1', value:  '1' },\n    { label:  'Text2', value:  '2' }\n]\n```\n\n### Get title response\n\nReturns a string with the title\n\n## How to publish\n\nFor publishing an npm account that is referenced to the organization is required.\n\nSee the following how to:\n\nhttps://yarnpkg.com/en/docs/publishing-a-package\n\nhttps://docs.npmjs.com/getting-started/publishing-npm-packages\n\nIf everything is configured correctly just count up the version number in our package.json and execute one of the following commands:\n\n```bash\nyarn publish\nnpm publish --access public\n```\n\n## License\n\nckeditor5-internallink-plugin is released under the MIT License. See LICENSE file for details.\n\n","readmeFilename":"README.md"}