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

Academic Writing #17

Open
d-r-a-b opened this issue Apr 23, 2023 · 1 comment
Open

Academic Writing #17

d-r-a-b opened this issue Apr 23, 2023 · 1 comment

Comments

@d-r-a-b
Copy link

d-r-a-b commented Apr 23, 2023

Many users have expressed interest in academic writing using norg-spec. At the moment, there are many features which are missing that would be needed to support a full academic-writing workflow. There are currently many competing priorities in the project, and the existence of this tracking issue should not be taken as commitment to support any particular feature set. Whether and when will be determined by if/when a (main or community) contributor is willing to commit to providing a particular implementation and able to work with the project maintainers to ensure it will integrate in an appropriate manner. Until and unless there is commitment from the norg-spec or neorg project, do not be surprised fi any of these features are deemed out of scope for the core project. As it stands, norg-spec offers extensions mechanisms that may allow third-parties to implement a feature even if norg or neorg deems it out of scope.

This issue is only meant to be a tracking issue for features which may assist academic writing, along with a link to the main thread discussing a given issue. Discussion of a particular feature should happen in its own dedicated thread. Of primary importance to this tracking issue, as a part of the norg-spec repo, is whether such features will benefit from or necessitate changes to norg-spec itself or would instead define their own extensions using the features that norg-spec already provides for this.

  • (discussion in progress) Citations
  • ( ) TOC generation
    • not really exportable, but gO provides some outlining in neorg at the moment
  • (pending) Tables/Figures with labels/captions
    • priority likely to be description of table semantics
  • ( ) Cross-ref
  • ( ) Pull data from an external store generated from some data-analysis pipeline
  • ( ) Output conforming to a style guide for a thesis
@d-r-a-b
Copy link
Author

d-r-a-b commented Apr 23, 2023

It would be preferred if comments in this issue are kept to a minimum. Open a separate issue or PR to discuss the particular feature you are interested in, and reference this issue there using #17 to generate a Github "mentioned this issue" link.

Worth stating explicitly as a message to any active maintainers: if at any point the above checklist is more than 1 month out of sync with what you see in the issues, feel free to close this tracking issue. A tracking issue only has value if the maintainer of the issue is actually tracking. If not, it's just clutter. If you are not actively engaged in maintenance of norg, neorg or related technologies, please also don't clutter this thread with requests for updates, asking for this to be closed if it is out of date, etc. Let the maintainers handle it. Thank you ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant