Can we have relative links to raw code work? #499

harald commented 2024年12月04日 13:37:17 +01:00

I tried to link to some raw code in the README.md of a repository like

 [eglot-hierarchy.el](raw/branch/main/eglot-hierarchy.el)

as this seems to be the correct relative path as seen from the `README.md.

But this got an absolute URL prefixed to end up as ...../src/branch/main/raw....

It would be great if this could work.

If it is possible already, documentation in https://codeberg.org/Codeberg/Documentation/src/branch/main/content/markdown/using-links.md would be great.

(Not sure I am in the correct project. Should this rather go to pages-server or elsewhere?)

I tried to link to some raw code in the `README.md` of a repository like ```markdown [eglot-hierarchy.el](raw/branch/main/eglot-hierarchy.el) ``` as this seems to be the correct relative path as seen from the `README.md. But this got an absolute URL prefixed to end up as `...../src/branch/main/raw...`. It would be great if this could work. If it is possible already, documentation in https://codeberg.org/Codeberg/Documentation/src/branch/main/content/markdown/using-links.md would be great. (Not sure I am in the correct project. Should this rather go to pages-server or elsewhere?)

mahlzahn commented 2025年01月25日 01:03:31 +01:00

Hi @harald,

The README.md actually is in the same folder as the eglot-hierarchy.el. Thus, a simple eglot-hierarchy.el or eglot-hierarchy.el should do what you want?

Edit: Probably you wanted the following? It won't work for forks, but at least for the main page.
[README.md](/Codeberg/Documentation/raw/branch/main/README.md) → README.md

Hi @harald, The `README.md` actually is in the same folder as the `eglot-hierarchy.el`. Thus, a simple [eglot-hierarchy.el](eglot-hierarchy.el) or [[eglot-hierarchy.el]] should do what you want? Edit: Probably you wanted the following? It won't work for forks, but at least for the main page. `[README.md](/Codeberg/Documentation/raw/branch/main/README.md)` → [README.md](/Codeberg/Documentation/raw/branch/main/README.md)

harald commented 2025年01月25日 13:51:12 +01:00

What you suggest does not link to the raw code, but to a Forgejo rendering of the code. That's why my example has the raw/ in front of the path.

For the difference see: harald/Codeschnipselnotizen@ea7558d002/OrgmodeTryout.org

What you suggest does not link to the raw code, but to a Forgejo rendering of the code. That's why my example has the `raw/` in front of the path. For the difference see: https://codeberg.org/harald/Codeschnipselnotizen/src/commit/ea7558d002b91cb0d095bd4f49bdcd01440515f1/OrgmodeTryout.org

mahlzahn commented 2025年01月30日 15:20:46 +01:00

Yes, I think that it is currently not implemented. Only with the absolute raw link including owner and repository. Would you be happy with an appended URL parameter of e.g. ?display=raw? That also is not implemented, yet.

Yes, I think that it is currently not implemented. Only with the absolute raw link including owner and repository. Would you be happy with an appended URL parameter of e.g. `?display=raw`? That also is not implemented, yet.

harald commented 2025年02月01日 12:59:30 +01:00

Hmm, so currently we have

 [eglot-hierarchy.el](raw/branch/main/some/path/eglot-hierarchy.el)

Then we would have

[eglot-hierarchy.el](some/path/eglot-hierarchy.el?display=raw)

where some/path is the normal file system path inside the git repo.

Yet, what about links to specific commits then? Consider me clicking on a specific link in the repository. In the URL bar (of reasonable browsers 😄) I see:

https://codeberg.org/harald/monqjfa/src/commit/38ac67b48612c13bcf27042f4182ac3e19a3c700/src/buma/Buma.java

From this link I can naively deduce a path relative to README.md as src/commit/38ac67b48612c13bcf27042f4182ac3e19a3c700/src/buma/Buma.java. So in addition to display=raw we might need commit=... and what not. In addition, creating the relative URL does not require me to dig through the documentation to figure out if and that those parameters exist.

Insofar the main point of my request is not a feature request but rather to remove a what seems like a misfeature --- the change of totally nice relative URL.

I am somewhat undecided whether extra parameters are worth the effort, as I can always just use the full absolute URL starting with /myuser/myrepo. Adding to the documentation a warning that relative URLs won't work may be sufficient.

Hmm, so currently we have ```markdown [eglot-hierarchy.el](raw/branch/main/some/path/eglot-hierarchy.el) ``` Then we would have ```markdown [eglot-hierarchy.el](some/path/eglot-hierarchy.el?display=raw) ``` where `some/path` is the normal file system path inside the git repo. Yet, what about links to specific commits then? Consider me clicking on a specific link in the repository. In the URL bar (of reasonable browsers 😄) I see: ``` https://codeberg.org/harald/monqjfa/src/commit/38ac67b48612c13bcf27042f4182ac3e19a3c700/src/buma/Buma.java ``` From this link I can naively deduce a path relative to `README.md` as `src/commit/38ac67b48612c13bcf27042f4182ac3e19a3c700/src/buma/Buma.java`. So in addition to `display=raw` we might need `commit=...` and what not. In addition, creating the relative URL does not require me to dig through the documentation to figure out if and that those parameters exist. Insofar the main point of my request is not a feature request but rather to remove a what seems like a misfeature --- the change of totally nice relative URL. I am somewhat undecided whether extra parameters are worth the effort, as I can always just use the full absolute URL starting with `/myuser/myrepo`. Adding to the documentation a warning that relative URLs won't work may be sufficient.