awesome-elisp icon indicating copy to clipboard operation
awesome-elisp copied to clipboard

Proposal: numbering all section levels

Open rswgnu opened this issue 5 years ago • 2 comments

This is fantastic. Thanks for the effort.

I would suggest numbering the sections so people can refer to them.

rswgnu avatar Oct 23 '20 22:10 rswgnu

Hi

Indeed, that would help, but there are 2 arguments against it:

  • the document is still rapidly evolving and we cannot guarantee that a numeric reference will remain valid for a long time
  • we follow the style of other awesome lists, which doesn't seem to favor numbering

An alternative when it comes to referring a section is simply link to it. Each section header provides an anchor. E.g.Development Tools > Code Editing > Jump to definition > elisp-defcan be shared (and referred to) as https://github.com/p3r7/awesome-elisp#elisp-def.

There is just one limitation: html anchors have no notion of hierarchy (IMHO, they did a bad design on this). We currently have an issue w/ elisp-demos which is listed under both Resources > Cookbooks and Development Tools > Documentation & Introspection. A way to circumvent this would be to alter one of the title to generate a different html anchor reference.

p3r7 avatar Oct 24 '20 07:10 p3r7

Yes, the anchors are fine for written communication. I was thinking about verbal references where people were looking at the same version of the list, knowing that across time, the section numbers could change.

-- Bob

On Oct 24, 2020, at 3:12 AM, Jordan Besly [email protected] wrote:

 Hi

Indeed, that would help, but there are 2 arguments against it:

the document is still rapidly evolving and we cannot guarantee that a numeric reference will remain valid for a long time we follow the style of other awesome lists, which doesn't seem to favor numbering An alternative when it comes to referring a section is simply link to it. Each section header provides an anchor. E.g.Development Tools > Code Editing > Jump to definition > elisp-defcan be shared (and referred to) as https://github.com/p3r7/awesome-elisp#elisp-def.

There is just one limitation: html anchors have no notion of hierarchy (IMHO, they did a bad design on this). We currently have an issue w/ elisp-demos which is listed under both Resources > Cookbooks and Development Tools > Documentation & Introspection. A way to circumvent this would be to alter one of the title to generate a different html anchor reference.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

rswgnu avatar Oct 24 '20 13:10 rswgnu