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

Is it possible to create cell notes? #22

Open
nvivo opened this issue Mar 26, 2023 · 2 comments
Open

Is it possible to create cell notes? #22

nvivo opened this issue Mar 26, 2023 · 2 comments
Labels
feature request Features that could improve the functionality of the library

Comments

@nvivo
Copy link

nvivo commented Mar 26, 2023

I`d like to write cell notes in a spreadsheet.

Is it supported? If not, could you point me to how to add this support? I could do a PR.

@rabanti-github
Copy link
Owner

rabanti-github commented Mar 26, 2023

Hi,
This feature is currently not supported. However, that feature would perfectly fit into the further development (I was already thinking about it and have added it now to the development backlog).

There are some considerations to make regarding comments. Comments can be inline-formatted. Inline-formatting is not yet implemented but on top of the backlog. In a first step, plain text comments could be implemented. Since I try to provide any function of PicoXLSX to NanoXLSX (the successor project that has reader support, has now the development lead and is also more active recently), a reader for comments should also provided as well. Comments should probably managed in a new class 'Comment' or 'Note' and stored in a Dictionary on the worksheet, where the key ist the cell address of the comment and the value the comment instance. The instance would probably hold meta information like visible state, size, comment creator, etc.

If you have already code - even if no reader or formatting is included - it would be great if you could share it. Any help is appreciated.

How I recently handle PRs:

  1. Clone NanoXLSX(*), create a feature branch and add your code
  2. Create a PR that is pointing to the dev-pr branch of NanoXLSX
  3. I will review it, and will do some comments if fundamental things should be fixed
  4. After fixing the mentioned things, I will merge the branch and will add further things
    • Comments where necessary and documentation
    • Minor changes for consistency reasons
    • Tests if none are defined
    • Updating of the change log and readme if necessary
  5. When everything is ready, I will merge dev-pr to dev and create a release with a NuGet package
  6. After releasing, dev will be merged to master
  7. All writer-features will be ported from NanoXLSX to PicoXLSX by myself ASAP and also released

(*)If you want to do a PR, but NanoXLSX is not the thing you are looking for, a PR to the dev-pr branch of PicoXLSX is also possible. In this case, the feature porting would be from PicoXLSX to NanoXLSX

Thank you in advance

@rabanti-github rabanti-github added the feature request Features that could improve the functionality of the library label Mar 26, 2023
@nvivo
Copy link
Author

nvivo commented Mar 29, 2023

Thanks for the help. I'll try it here, if I'm able to do it I'll do the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Features that could improve the functionality of the library
Projects
None yet
Development

No branches or pull requests

2 participants