Rename? - Githubissues

luavreis / org-mode-hs

Libraries and tool for parsing Org Mode documents with customizable exporters. 🦄

GNU General Public License v3.0

22 stars 5 forks source link

Rename? #7

Closed luavreis closed 1 year ago

luavreis commented 2 years ago

With #6, this is becoming more than just a parser. org-mode and orgmode and already taken in Hackage. Some ideas:

org-hs
Just org?
Leave it as it is :(

srid commented 2 years ago

Split into multiple libraries ?

luavreis commented 2 years ago

Split into multiple libraries ?

This makes sense, although it would be nice to have a common prefix to the libraries, and just org feels a bit pretentious. Maybe the org-parser prefix is fine, and I would do this:

org-parser -> parser
org-parser-cli -> provides a org-hs executable
org-parser-exporters -> common exporter functionality
org-parser-html
org-parser-pandoc
...

srid commented 2 years ago

What do the last two mean?

Also, what does org-parser-cli provide?

I'm trying to understand the various 'components' of this project.

luavreis commented 2 years ago

The org-parser-exporters library would basically include the Org.Exporters.Common file, that exports the ExportBackend class. Other libraries can create export backends by instantiating this class.

The name is awkward but org-parser-html and org-parser-pandoc basically just do this, I wrote the last two like that because org-parser-exporter-html and org-parser-exporter-pandoc are too awkward... lol

srid commented 2 years ago

horg -> cli exectuable
horg-parser -> the parser and AST
horg-exporter -> exporter core, along with default exporters (html and pandoc)
- can further be split into horg-exporter, horg-exporter-html and horg-exporter-pandoc if really must

luavreis commented 2 years ago

This division makes sense, but isn't org-hs better than horg?

srid commented 2 years ago

I'm not even a fan of horg; I'd come up with a really unique and memorable name, like Orgile.

luavreis commented 2 years ago

I think I'll do this: since it's available, the common prefix will be just org (so org-parser, org-cli, org-exporters). If people complain, yaorg. For some reason the other names sound to me like they're either about an app or some sort of new markup language, different from emacs' org.

Also, this library seems closer org-element than the other available Haskell parsers.

Edit: perhaps the CLI tool can have a nicer name, since it's more like an "app".