{"id":19774194,"url":"https://github.com/jabref/jabref-word-addin","last_synced_at":"2025-04-30T18:33:00.547Z","repository":{"id":39145617,"uuid":"369268651","full_name":"JabRef/JabRef-Word-Addin","owner":"JabRef","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-01T15:23:31.000Z","size":6892,"stargazers_count":20,"open_issues_count":44,"forks_count":7,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-04-14T22:56:18.335Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JabRef.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-20T16:16:09.000Z","updated_at":"2024-03-04T09:26:18.000Z","dependencies_parsed_at":"2023-02-17T07:15:48.523Z","dependency_job_id":null,"html_url":"https://github.com/JabRef/JabRef-Word-Addin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JabRef%2FJabRef-Word-Addin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JabRef%2FJabRef-Word-Addin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JabRef%2FJabRef-Word-Addin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JabRef%2FJabRef-Word-Addin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JabRef","download_url":"https://codeload.github.com/JabRef/JabRef-Word-Addin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224219555,"owners_count":17275477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-12T05:12:11.994Z","updated_at":"2024-11-12T05:12:12.839Z","avatar_url":"https://github.com/JabRef.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JabRef-Word-Addin\n\n## Getting started\n\n- Install [Node.js](https://nodejs.org/).\n- Create .env file in the root directory containing the `HOST_API_URL` key\n\n  e.g., `API_HOST = \"https://mango-pebble-0224c3803.1.azurestaticapps.net/\"`\n\n- Run `yarn install`\n\n## Loading and Testing the Plugin\n\n### How to test the add-in in Word\n\n- Run `yarn start` in the root directory. This starts the local web server and opens Word with add-in loaded.\n  On Windows, you have to do that with Administrator rights (at the very first run) in order to setup the correct certificates.\n- In Word, open a new document, choose the Home tab, and then choose the Show Task Pane button in the ribbon to open the add-in task pane.\n\n### How to test add-in in Word on a browser\n\n- Open [Word](https://www.office.com/launch/word) on the web. Using the \"New blank document\" option, open a new Word document. In this new document, select Share in the ribbon, select Copy Link in the dropdown, and copy the URL.\n- In the project root directory, open the `.env` file. Add a `DOCUMENT_URL` key with the URL you copied as the value. For example, `DOCUMENT_URL=\u003cURL\u003e`.\n- In the command line starting at the root directory, run `yarn start:web`.\n- The Word document should now be opened in a new browser tab. Confirm that you would like to enable developer mode (this is needed for sideloading addins).\n- You will see a second dialog box, asking if you wish to register an Office Add-in manifest from your computer. Select Yes.\n- Choose the Reference tab, and then click on the JabRef icon to open the add-in task pane.\n  ![JabRef on Word's Task Pane](docs/img/jabref-on-word-task-pane.png)\n\n### How to sideload Add-in in Office on the web manually\n\n- Open Office on the web. Open a document in Word. On the Insert tab on the ribbon in the Add-ins section, choose Office Add-ins.\n- On the Office Add-ins dialog, select the MY ADD-INS tab, choose Manage My Add-ins, and then Upload My Add-in.\n- Browse to the add-in manifest file, and then select Upload.\n- Choose the Reference tab, and then click on the JabRef icon to open the add-in task pane.\n\n## Yarn Commands\n\n| Command          | Description                                                                                                                                  |\n| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `yarn start`     | To test add-in in Word, run this command in the root directory. This starts the local web server and opens Word with add-in loaded.          |\n| `yarn start:web` | To test your add-in in Word on a browser, run this command in the root directory. When you run this command, the local web server will start |\n| `yarn build`     | To start server in production.                                                                                                               |\n\nNote: If you're testing add-in on Mac, run `yarn dev-server` to start the local web server.\n\n## Recommended VS Code Extension\n\n- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode): Format code and enforces consistent style.\n\n## Technologies used\n\n- [React.js](https://reactjs.org): UI framework [Documentation](https://reactjs.org/docs/getting-started.html)\n- [Microsoft Office Add-in](https://docs.microsoft.com/en-us/office/dev/add-ins/)\n- [Citation Style Language (CSL) project](https://citationstyles.org/) is used to format citations according to various styles.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjabref%2Fjabref-word-addin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjabref%2Fjabref-word-addin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjabref%2Fjabref-word-addin/lists"}