Microsoft Word add-in for the Accord Project
License: Apache License 2.0
This repository has been moved to https://github.com/accordproject/cicero-word-add-in
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
The add-in lacks the links some useful links.
I was going through the documentation to setup the add-in on a widows (batch shell) machine and have realized that the copy command for cicero-word-add-in.xml file is incorrect for windows, if it was not intentional to skip the configuration for windows. I would like to point out that the following command:
cp cicero-word-add-in.xml /Users/<NAME>/Library/Containers/com.microsoft.Word/Data/Documents/wef/
should be updated to the following for windows.
copy cicero-word-add-in.xml \Users\<NAME>\Library\Containers\com.microsoft.Word\Data\Documents\wef\
Similarly, in the start script, the following command,
export HTTPS=true&&react-scripts start
should be updated to the following for windows.
set HTTPS=true&&react-scripts start
If yes, I would like to work on this.
Is your feature request related to a problem? Please describe.
We would want to add content controls to variable nodes identfied in the CiceroMark DOM to be able to add styling and perform others actions with these content controls in the Word document.
Describe the solution you'd like
Currently, it is not possible to add content controls with the insertion of HTML (the mechanism we currently have) so we would have to walk through the CiceroMark DOM and identify node types (Paragraphs, Headings, Variables) simultaneously inserting the text, breaks and content controls.
Additional context
I'd like to work on this.
As per the discussion with @Michael-Grover, the tabs are to be sticky along with the header, in the word add-in.
OS configuration:- MacOS Catalina(v10.12.0)
We can add functionality for showing the user a list of smart clauses that he/she has added to the word document. After this UI is made, I would also start with other functionalities that I have in mind incrementally.
We can start with a basic user interface first.
The link for sideloading add-in is currently present as a separate link , which instead should be present as the a hypertext inside the line which says to sideload the add-in.
@DianaLease @dselman Can i work on this issue?
#57 Some instances of Smart Clause are still there in the add-in's ribbon.
I am working on this.
Some of the classes which were removed in the recent PR's still have their CSS left in index.css file
Enhancement:- Tabs in the Add-In should occupy full Width
Tabs are compressed
Tabs should occupy full Width
When Sideload Office Add-ins is clicked in localhost it should open the link in the new tab rather than opening in the same tab where localhost React App is running in browser.
@DianaLease Should I work on this issue?
Moving conditional checks to TabContainer itself instead of checking it in TopNavigation
Currently, the loading page which can be seen on localhost:3000 has some inline styles. I gathered some resources regarding this which conclude that having inline styles like this causes the reconciliation algorithm to break and cause unnecessary re-renders.
##Description
Header using Tab to render Add-In header which makes it unnecessary clickable and its not in centered
Currently, the addToContract function does not add the contract to the current cursor position but rather adds it to the end of the document.
OS config:- Mac OS Catalina (v10.15.2)
I would like to work on this.
Line 60:20: clauseId is assigned a value but never used no-unused-vars
Line 60:29: templateId is assigned a value but never used no-unused-vars
Based on the discussion with @Michael-Grover, the logo for cicero needs to be added on the banner of the add-in project.
Currently, the use of "that" is used in many places in the code in order to get the this instance. This can be replaced by using arrow functions which bubble up this, rather than normal functions.
Addition of husky and lint-staged would avoid committing poor code to the repository
The cicero logo was added in the word add-in based on the decisions taken with @Michael-Grover. The react webpage which can be seen on opening the project on the browser and visiting localhost:3000 should also have the same logo.
OS config:- Mac OS Catalina(v10.12.0)
Should this repository be renamed to "Verbatim" per the accord project documentation at https://docs.accordproject.org/ ?
Currently, some components in the word add-in have a check for correct proptypes, but some don't.
@DianaLease @dselman, I am working on the PR for this.
Right Now the label are already red , but they should be red only when there is a error, we can solved this issue by maintaining a state for error but I think it should be much elegant if we add any form-validation library
Right now label are already in red color , but that should be only when there is any error after the fields are dirty or touched
Form should validate the field and should convey the user what is missing only if the user touched the field or try submitting the form without entering data
I would like to work on it
Currently, the list which displays the clause templates list does not have a fallback UI or a spinner. Steps to reproduce the issue:-
Templates tabOS details:-
Mac OS Catalina (v10.15.2)
Working with functional based components is much easier as compared to working with class based components.
Add-ins generally have a proper footer indicating some copyrights or something like that along with that footers mentions name of organisation which is maintainig it.
Footer color is different from the header
Footer color is different then rest of the theme design, and header
Footer color should be same as the header
New Smart clause dialog preserving the state of the text box
Steps to Reproduce:
I am working on this
The project header can be fixed to the top. Currently, it scrolls along with the content.
OS config:- Mac OS Catalina(v10.5.2)
Chunk the document into clauses and then identify smart clauses from existing template libraries. Could use a service like this:
https://dandelion.eu/docs/api/datatxt/sim/v1/
Description:-
There is some useless code which is there but not contributing to the respective feature
Curently, an eslintrc file is present , but the app does not enforce linting. Therefore, linting rules need to be modified in the app, and also linting should be made mandatory , i.e build should fail if linting rules are not adhered to.
After entering clauseId and templateId user can click enter button to confirm those changes.
I am working on this
Currently the new smart clause floating button is not present at the right place in the UI, creating a jarring experience.
OS details:- Mac OS Catalina(v10.15.2)
The color of the text inside the main input is white. The text can be seen when highlighted as shown :-
OS :- MacOS Cataline (v10.15.2)
When enter Template id and clause id without selecting a text for binding and press OK It renders Smart Clause List. It should rather display a warning that text is not selected for binding.
Should I work on it @DianaLease @dselman ?
The term "Smart Clause" is the IP of another company. We have to change all instances of "Smart Clause" to "Clause Template"
We have two scrollbar in the add-in one for the whole add in and one for the templates, if we are using scrollbar for the template I don't think there is any need of the outside scrollbar. We can use scrollable tabs also which also cater tabs and header scrolling issue.
Two scrollbar in which outside scrollbar is unnecessary
Scrollbar is needed if there is any content which is not visible, but actually we are using scroll in template list. So we can have one scroll and we can scrollable tabs also for more content which cater the problem header and tab scrolling issue in add in.
I would like to work on it
The onClose eventhandler in NewSmartClasueDialog is referencing to wrong function.
I am working on this issue.
Some of the text and AP logo is not well adjusted in the taskpane. I would like to work on this issue
I want to work on this issue :)
The tabs do not occupy equal width. The expected behaviour is that they should be having equal dimensions for the sake of consistency of the UI.
One tab has a width of 185 and the other has a width of 144.
The console.log statements should not be present in the app.
OS config:- Mac OS Catalina (v10.15.2)
The selected text is scanned. Any text in between [ and ] is captured as a variable. The variable delimiter characters SHOULD be configurable.
A template model is created, with a property for each variable. The type of the variable is by default String.
The user can specify a different type for each variable, as well as rename the variable.
Example:
Lorem
[ipsum]dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.[Duis]aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est[laborum].
A dialog (?) is displayed that confirms the variables and types:
ipsum [String]
Duis [String]
laborum [String]
Press a drop-down (?) for the type name to specify a different type. The dialog MAY allow the user to add/remove variables.
Initially perhaps we start with only supporting primitive types. In the future, the ability to specify the URL for an external model and to use custom (complex) types would be useful. E.g.
Address,MonetaryQuantityetc.
Once the types have been confirmed/edited the grammar, model and package.json for the template is generated (in memory?).
concept TemplateModel {
o String ipsum
o String Duis
o String laborum
}
The Add-in uses the MS Word Bindings feature to persist the link from the text to the template. When the document is re-opened the text is already linked to the published template and the user can review the metadata for the template in the task pane.
As discussed with @Michael-Grover, the floating action button is rarely seen in desktop apps. Therefore this should be changed to a normal button.
OS info:-
Mac OS Catalina(v10.15.2)
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.