Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Styling of the clause block #434

Open
K-Kumar-01 opened this issue Aug 3, 2021 · 7 comments
Open

Styling of the clause block #434

K-Kumar-01 opened this issue Aug 3, 2021 · 7 comments
Labels
Difficulty: Medium Help Wanted 🆘 Extra attention is needed Type: Feature Request 🛍️ New feature or request

Comments

@K-Kumar-01
Copy link
Collaborator

Discussion 🗣

Currently, the transformation of the clause to OOXML looks like this.
Clause
As visible from the image, the clause transformation is not visually distinguishable from the others as in case of templatemark-dingus or contract-editor.

Any ideas on how to distinguish the clause contents present in a template are welcomed.

Context

Raised with relation to the PR #432

@dselman
Copy link
Contributor

dselman commented Aug 5, 2021

I think wrapping it in the content control is sufficient.

@jolanglinais
Copy link
Member

@K-Kumar-01 does #432 close this Issue, or is this separate?

@K-Kumar-01
Copy link
Collaborator Author

@irmerk This is a bit different, there wasn't a firm discussion on styling so I went with the basic one there which Dan approved at the time since we were focused on conversion. This needs some discussion on how we want it to look.

@jolanglinais jolanglinais added Difficulty: Medium Help Wanted 🆘 Extra attention is needed Type: Feature Request 🛍️ New feature or request labels Dec 1, 2021
@jolanglinais
Copy link
Member

Pinging @Michael-Grover on this.

@Michael-Grover
Copy link

Hi @K-Kumar-01 , I'm having a bit of trouble understanding this issue, partially because I can't run this locally to see if for myself. Please excuse my many questions:

What does "wrapping it in the content control" mean? Can a Microsoft Word user see what content is wrapped in the content control versus what is not?

I'm not familiar with the styling constraints on a Microsoft Word plugin. What are some options we have for visually distinguishing a clause from the content around it?

My understanding is that the inside of this red box I drew is the clause. Is that correct? What is the grey box, and why does it wrap content that is not part of the clause? As a user I would expect the clause to have something like the gray box wrapped around it.
image

@K-Kumar-01
Copy link
Collaborator Author

@Michael-Grover
Apologies for the late reply.

What does "wrapping it in the content control" mean? Can a Microsoft Word user see what content is wrapped in the content control versus what is not?

Yes a user can see if text is wrapped in content control or not. A border appears around the content wrapped when hovered as shown above.

I'm not familiar with the styling constraints on a Microsoft Word plugin. What are some options we have for visually distinguishing a clause from the content around it?

Not too sure myself. From what I have worked upon, one can try few of the following:
coloring the text, highlighting the text, changing the font, changing the size.
Although these are not good ones as size changes need to be specific. If a user will change the size, then we won't be able to say that it will still lie in a clause. Same for the other things.

My understanding is that the inside of this red box I drew is the clause. Is that correct? What is the grey box, and why does it wrap content that is not part of the clause? As a user I would expect the clause to have something like the gray box wrapped around it.

The gray part is the template area.It was implemented by @algomaster99 in his GSoC period. Later, I, @dselman, and @algomaster99 decided to wrap only the clause. But on thinking deeply, there was a problem which I found. That was how to determine which templates are already inserted and bind things.
Explanation: Suppose a template contains 2 clauses. Then we need to wrap both clauses along with content controls.
Also, there shouldn't be more than one template of the same kind. This is only possible via an id if given to the template which we do as of now. If only the clause is wrapped, then some ids need to be given to each clause which is associated with the template and on reopening further processing so that content controls are properly matched.

@Michael-Grover
Copy link

@K-Kumar-01 I would suggest looking into popular Word plugins that also differentiate a block of text from the whole document, and see some ways they achieve this. I don't think we should necessarily use styling such as font and size to differentiate clause text, because the author of the document may want their contract to look visually consistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: Medium Help Wanted 🆘 Extra attention is needed Type: Feature Request 🛍️ New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants