gemlog links #3

New Issue

swiftmandolin · 2020-09-09T04:54:45Z

swiftmandolin commented

2020-09-09 04:54:45 +00:00

general thoughts

As of now, providing a footnote at the end of a section (denoted by ##) for links seems to be the best way to go. Let me give an example:

## My Thoughts
blah blah...

This is all building up and becoming a lot to keep track of when writing, and this leads me to my next point: maybe there should be a new standard[1] or style guide that people can use to help keep geminispace easier to read and less messy.

=> https://xkcd.com/927/ [1] https://xkcd.com/927 (no, we don't need another standard)

inline formatting

So, I'm thinking the best format is to use bracket-number-bracket after the relevant word or phrase, with no space.

Example:

standard[1]

link formatting

All links should be grouped at the end of each section (##) and not subsection (###) and formatted like so:

=> url [x] any text to label the url (even if its the url)

Example:

=> https://xkcd.com/927/ [1] Relevant xkcd

I mentioned showing/revealing links as a possible "courtesy" but honestly, that still leaves the user to trust that that is the right link. I believe its up to the user to verify all links clicked, so use what ever text you want to cover the link.

Are there any other thoughts?

## general thoughts As of now, providing a footnote at the end of a section (denoted by ##) for links seems to be the best way to go. Let me give an example: ``` ## My Thoughts blah blah... This is all building up and becoming a lot to keep track of when writing, and this leads me to my next point: maybe there should be a new standard[1] or style guide that people can use to help keep geminispace easier to read and less messy. => https://xkcd.com/927/ [1] https://xkcd.com/927 (no, we don't need another standard) ``` ## inline formatting So, I'm thinking the best format is to use bracket-number-bracket after the relevant word or phrase, with no space. Example: ``` standard[1] ``` ## link formatting All links should be grouped at the end of each section (##) and not subsection (###) and formatted like so: => url [x] any text to label the url (even if its the url) Example: ``` => https://xkcd.com/927/ [1] Relevant xkcd ``` I mentioned showing/revealing links as a possible "courtesy" but honestly, that still leaves the user to trust that that is the right link. I believe its up to the user to verify all links clicked, so use what ever text you want to cover the link. Are there any other thoughts?

swiftmandolin added the

discussion

label 2020-09-09 04:54:45 +00:00

nytpu commented

2020-09-09 23:08:11 +00:00

Just a minor thing, but I think that links should be placed at the end of the content but before the next header.

Example:

# title

hello[1], world!

=> https://en.wiktionary.org/wiki/hello [1]: definition of hello

## section

good morning america[1]

=> gemini://vault.transjovian.org:1965/text/en/Good%20Morning%20America [1]: gemini wikipedia — good morning america

### subsection

infinite content[1]

=> gemini://vault.transjovian.org:1965/full/en/Everything%20Now [1]: the album everything now has a song called "infinite content"

It just doesn't look as good like this, especially if you imagine multiple long (i.e. taller than the display viewport) subsections:

# title

hello[1], world!

=> https://en.wiktionary.org/wiki/hello [1]: definition of hello

## section

good morning america[1]

### subsection

infinite content[2]

=> gemini://vault.transjovian.org:1965/text/en/Good%20Morning%20America [1]: gemini wikipedia — good morning america
=> gemini://vault.transjovian.org:1965/full/en/Everything%20Now [2]: the album everything now has a song called "infinite content"

Just a minor thing, but I think that links should be placed at the end of the content but before the next header. Example: ``` # title hello[1], world! => https://en.wiktionary.org/wiki/hello [1]: definition of hello ## section good morning america[1] => gemini://vault.transjovian.org:1965/text/en/Good%20Morning%20America [1]: gemini wikipedia — good morning america ### subsection infinite content[1] => gemini://vault.transjovian.org:1965/full/en/Everything%20Now [1]: the album everything now has a song called "infinite content" ``` It just doesn't look as good like this, especially if you imagine multiple long (i.e. taller than the display viewport) subsections: ``` # title hello[1], world! => https://en.wiktionary.org/wiki/hello [1]: definition of hello ## section good morning america[1] ### subsection infinite content[2] => gemini://vault.transjovian.org:1965/text/en/Good%20Morning%20America [1]: gemini wikipedia — good morning america => gemini://vault.transjovian.org:1965/full/en/Everything%20Now [2]: the album everything now has a song called "infinite content" ```

nytpu commented

2020-09-09 23:16:54 +00:00

A few other things to decide on are:

should the footnote numbers be persistent throughout the whole document or "reset" after every section/subsection?
should the text for the link be aligned (this is more the writer's preference over the consumer's preference but still)

example:

=> gemini://gemini.circumlunar.space/capcom/ [1]: capcom geminispace aggregator
=> gemini://gus.guru                         [2]: gemini univeral search

A few other things to decide on are: 1. should the footnote numbers be persistent throughout the whole document or "reset" after every section/subsection? 2. should the text for the link be aligned (this is more the writer's preference over the consumer's preference but still) example: ``` => gemini://gemini.circumlunar.space/capcom/ [1]: capcom geminispace aggregator => gemini://gus.guru [2]: gemini univeral search ```

swiftmandolin commented

2020-09-10 03:19:57 +00:00

Just a minor thing, but I think that links should be placed at the end of the content but before the next header.

Ya know what, I think you're right. I was envisioning shorter articles, but yeah, people will probably be writing some lengthy stuff so yeah, let's go with that!

should the footnote numbers be persistent throughout the whole document or "reset" after every section/subsection?

I would say be persistent because some browsers like bombadillo number them anyway and don't care about sections. For instance, from one of your articles, bombadillo renders the footnotes like:

[2]   [1]: (https) https://daringfireball.net/projects/markdown/syntax#link
[3]   [2]: /photos/20200904_Coopers_2_small.png
[4]   [3]: /photos/20200513_Red-Tailed_2_small.png

By having mismatched numbers, it can get confusing on first glance. But, I'm not sure whether or not we should even take this into account, since not everyone uses browsers like that, but I just wanted to bring that up. If a user were to provide a navigation link in the top, the next footnote could start with 2, instead of 1 to match the numbering the browser would do. Probably a stupid idea, but just a thought!

should the text for the link be aligned (this is more the writer's preference over the consumer's preference but still)

I personally like this. It looks clean.

> Just a minor thing, but I think that links should be placed at the end of the content but before the next header. Ya know what, I think you're right. I was envisioning shorter articles, but yeah, people will probably be writing some lengthy stuff so yeah, let's go with that! > 1. should the footnote numbers be persistent throughout the whole document or "reset" after every section/subsection? I would say be persistent because some browsers like bombadillo number them anyway and don't care about sections. For instance, from one of your articles, bombadillo renders the footnotes like: ``` [2] [1]: (https) https://daringfireball.net/projects/markdown/syntax#link [3] [2]: /photos/20200904_Coopers_2_small.png [4] [3]: /photos/20200513_Red-Tailed_2_small.png ``` By having mismatched numbers, it can get confusing on first glance. But, I'm not sure whether or not we should even take this into account, since not everyone uses browsers like that, but I just wanted to bring that up. If a user were to provide a navigation link in the top, the next footnote could start with 2, instead of 1 to match the numbering the browser would do. Probably a stupid idea, but just a thought! > 2. should the text for the link be aligned (this is more the writer's preference over the consumer's preference but still) I personally like this. It looks clean.

nytpu commented

2020-09-10 04:57:55 +00:00

I think for shorter stuff with fewer links the end of section style looks better and less fragmented, but for longer stuff the end of subsection style looks better and is easier to navigate. Maybe say that if you have <2–3 links in each subsection and/or the section is short enough move it to the end of the section instead, but it's your call on whether you want to have two separate options for people or not.

I agree on the persistent link numbering, there's no harm in doing it even if the browser doesn't number links, and it makes it easier if you want to search for a specific link you could search for "[3]" to find just that one link.

I think for shorter stuff with fewer links the end of section style looks better and less fragmented, but for longer stuff the end of subsection style looks better and is easier to navigate. Maybe say that if you have \<2–3 links in each subsection and/or the section is short enough move it to the end of the section instead, but it's your call on whether you want to have two separate options for people or not. I agree on the persistent link numbering, there's no harm in doing it even if the browser doesn't number links, and it makes it easier if you want to search for a specific link you could search for "[3]" to find just that one link.

swiftmandolin commented

2020-09-12 02:38:21 +00:00

and it makes it easier if you want to search for a specific link you could search for “[3]” to find just that one link.

Oh yes, really good point here.

but it’s your call on whether you want to have two separate options for people or not.

Hm, I think this may complicate it a bit if we start adding variations. I say lets go with your original idea of adding links at the end of any section/subsection.

> and it makes it easier if you want to search for a specific link you could search for “[3]” to find just that one link. Oh yes, really good point here. > but it’s your call on whether you want to have two separate options for people or not. Hm, I think this may complicate it a bit if we start adding variations. I say lets go with your original idea of adding links at the end of any section/subsection.

swiftmandolin commented

2020-09-12 02:40:31 +00:00

should the text for the link be aligned (this is more the writer’s preference over the consumer’s preference but still)

Also, coming back to to this question, I was writing last night and I had some really long links in which this doesn't really work. So while I personally like the idea (if the links are short enough), I don't know if it fits within the style guide since links may be too long to acheive this.

> should the text for the link be aligned (this is more the writer’s preference over the consumer’s preference but still) Also, coming back to to this question, I was writing last night and I had some really long links in which this doesn't really work. So while I personally like the idea (if the links are short enough), I don't know if it fits within the style guide since links may be too long to acheive this.

Sign in to join this conversation.

No Label

correction

discussion

No Milestone

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: swiftmandolin/gemini-style-guide#3