bauer/django-signposting
1
0
Fork 0
mirror of https://github.com/dnlbauer/django-signposting.git synced 2026-09-10 14:05:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

add middleware to add signposting links into html head (#3)

Browse Source 
* add middleware to add signposting links into html head
This commit is contained in:
Daniel Bauer
2024-11-25 15:44:46 +01:00
committed by GitHub
parent 06d745e4a4
commit b29f19d78a
6 changed files with 530 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -128,9 +128,36 @@ signposts = jsonld_to_signposts(json_ld)
add_signposts(response, **signposts)
```
### Add signposts as HTML links instead of headers
In cases where you want to include signposting directly in the HTML response rather than as HTTP headers
(for example because headers are overwritten by a proxy or something else),
you can use the `HtmlSignpostingMiddleware` instead of `SignpostingMiddleware`.
This middleware automatically adds <link> elements to the HTML <head> section based
on the detected signposting metadata and produces output similar to the one shown here:
```HTML
<!DOCTYPE html>
<html>
<head>
(...)
<link href="http://schema.org/WebSite" rel="type"/>
<link href="http://schema.org/Dataset" rel="type"/>
<link href="https://orcid.org/0000-0001-9447-460X" rel="author"/>
<link href="https://creativecommons.org/licenses/by/4.0/" rel="license"/>
<link href="https://example.com" rel="cite-as"/>
<link href="https://example.com/download.zip" rel="describedby" type="application/zip"/>
<link href="https://example.com/metadata.json" rel="describedby"/>
<link href="http://example.com/image.png" rel="item" type="image/png"/>
<link href="http://example.com/image2.png" rel="item" type="image/png"/>
</head>
...
</html>
```
## TODO
- [ ] Option to add signposts in HTML via <link> elements.
- [ ] Add support for link sets
- [ ] Add support for specifying profile extension attribute