{"id":41165560,"url":"https://github.com/oxygenxml/web-author-learn-words-plugin","last_synced_at":"2026-01-22T19:32:48.160Z","repository":{"id":43378878,"uuid":"152071843","full_name":"oxygenxml/web-author-learn-words-plugin","owner":"oxygenxml","description":"Plugin for adding learned/forbidden words functionality to Web Author spellchecking.","archived":false,"fork":false,"pushed_at":"2025-11-14T10:36:33.000Z","size":217,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":24,"default_branch":"BRANCH_OXYGEN_RELEASE_27_1","last_synced_at":"2025-11-14T12:23:59.243Z","etag":null,"topics":["oxygen-web-author-plugin"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oxygenxml.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-10-08T11:55:22.000Z","updated_at":"2025-05-06T09:43:20.000Z","dependencies_parsed_at":"2023-01-20T07:34:11.006Z","dependency_job_id":"3ed125b2-a1e7-4a08-bd23-21c735f71003","html_url":"https://github.com/oxygenxml/web-author-learn-words-plugin","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/oxygenxml/web-author-learn-words-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxygenxml%2Fweb-author-learn-words-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxygenxml%2Fweb-author-learn-words-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxygenxml%2Fweb-author-learn-words-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxygenxml%2Fweb-author-learn-words-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxygenxml","download_url":"https://codeload.github.com/oxygenxml/web-author-learn-words-plugin/tar.gz/refs/heads/BRANCH_OXYGEN_RELEASE_27_1","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxygenxml%2Fweb-author-learn-words-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28669176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T17:07:18.858Z","status":"ssl_error","status_checked_at":"2026-01-22T17:05:02.040Z","response_time":144,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["oxygen-web-author-plugin"],"created_at":"2026-01-22T19:32:48.073Z","updated_at":"2026-01-22T19:32:48.147Z","avatar_url":"https://github.com/oxygenxml.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"Web Author Learn Words Plugin\n=============================\n\nPlugin for adding learned/forbidden words functionality to Web Author spellchecking.\n\nHow it works\n------------\n\nThe list of words is stored in a file with the following structure:\n\n```\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003cDictionary\u003e\n    \u003cLearned\u003e\n        \u003cLanguage code=\"en\"\u003e\n            \u003cw\u003ewordexample\u003c/w\u003e\n            \u003cw\u003eworda\u003c/w\u003e\n            \u003cw\u003elongword\u003c/w\u003e\n            \u003cw\u003elearned word\u003c/w\u003e\n        \u003c/Language\u003e\n        \u003cLanguage code=\"fr\"\u003e\n            \u003cw\u003eworta\u003c/w\u003e\n            \u003cw\u003ewortb\u003c/w\u003e\n        \u003c/Language\u003e\n    \u003c/Learned\u003e\n    \u003cForbidden\u003e\n        \u003cLanguage code=\"en\"\u003e\n            \u003cw\u003esome\u003c/w\u003e\n            \u003cw\u003eforbidden\u003c/w\u003e\n            \u003cw\u003ewords\u003c/w\u003e\n        \u003c/Language\u003e\n        \u003cLanguage code=\"de\"\u003e\n            \u003cw\u003everboten\u003c/w\u003e\n        \u003c/Language\u003e\n    \u003c/Forbidden\u003e\n\u003c/Dictionary\u003e\n```\n\nThe file is loaded either from a the server's local file system, or from an external HTTP server (GET request). \n\nWhen a user chooses to learn a word the following action happens:\n1. If the plugin is configured to use a local file, the new word is added to that file.\n2. If the plugin is configured to load the file from an HTTP server, a POST request is sent to the URL of the file\nwith the following form parameters:\n\n| Parameter name | Parameter value                 |\n| -------------- |-------------------------------- |\n| `mode`         | One of `learned` or `forbidden` |\n| `lang`         | The language for which the word is added, e.g. `en`     |\n| `word`         | The word to be added            |\n\nInstallation\n------------\n\nTo install this plugin, download one of the releases ([link](https://github.com/oxygenxml/web-author-learn-words-plugin/releases)) and [upload it in your Web Author deployment](https://www.oxygenxml.com/doc/ug-webauthor/topics/webapp-configure-plugins.html).\n\nConfiguration through Administration page.\n-------------\nThe plugin can be configured from the [Web Author Administration Page](https://www.oxygenxml.com/doc/ug-waCustom/topics/webapp-admin-page.html).\nYou can set:\n- the number of suggestions to be shown from the learned words list. They will always be shown at the top of the list of suggestions.\n- the read-only mode, enabled by default. If turned off, a \"Learn word\" action is added to the contextual menu and any user can add words to the learned words list.\n- the dictionary. It may be a local file, or an HTTP server able to serve the list of learned words(GET) and add new learn words(POST).\n\n\n\nConfiguration through options.xml file\n-------------\nThe plugin can also be configured by [customizing options](https://www.oxygenxml.com/doc/ug-waCustom/topics/customizing-options.html) in Web Author's options.xml:\n- the number of suggestions to be shown from the learned words list\n```\n\u003centry\u003e\n    \u003cString\u003ePLUGIN_CUSTOM_OPTIONS.suggestions-no.name\u003c/String\u003e\n    \u003cString\u003e2\u003c/String\u003e\n\u003c/entry\u003e\n```\n- the read-only mode\n```\n\u003centry\u003e\n    \u003cString\u003ePLUGIN_CUSTOM_OPTIONS.lw.read-only-mode\u003c/String\u003e\n    \u003cString\u003eoff\u003c/String\u003e\n\u003c/entry\u003e\n```\n- use a local dictionary file\n```\n\u003c!--Use local file--\u003e\n\u003centry\u003e\n    \u003cString\u003ePLUGIN_CUSTOM_OPTIONS.file-selected.name\u003c/String\u003e\n    \u003cString\u003eon\u003c/String\u003e\n\u003c/entry\u003e\n\u003centry\u003e\n    \u003cString\u003ePLUGIN_CUSTOM_OPTIONS.file-path.name\u003c/String\u003e\n    \u003cString\u003ePATH_TO_FILE\u003c/String\u003e\n\u003c/entry\u003e\n```\n- OR use an HTTP server\n```\n\u003c!--Use URL to connect to an HTTP server--\u003e  \n\u003centry\u003e\n    \u003cString\u003ePLUGIN_CUSTOM_OPTIONS.url-selected.name\u003c/String\u003e\n    \u003cString\u003eon\u003c/String\u003e\n\u003c/entry\u003e\n\u003centry\u003e\n    \u003cString\u003ePLUGIN_CUSTOM_OPTIONS.url.name\u003c/String\u003e\n    \u003cString\u003ehttp://EXAMPLEURL\u003c/String\u003e\n\u003c/entry\u003e\n```\n\nCopyright and License\n---------------------\nCopyright 2021 Syncro Soft SRL.\n\nThis project is licensed under [Apache License 2.0](https://github.com/oxygenxml/web-author-learn-words-plugin/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxygenxml%2Fweb-author-learn-words-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxygenxml%2Fweb-author-learn-words-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxygenxml%2Fweb-author-learn-words-plugin/lists"}