Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Semantic overhaul of Scribble with RDFa

Đang mở
  • Có gì không ổn?
#228 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
15/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation, search

Hướng nghiên cứu

Issue không nêu tên tệp, kiểm thử hoặc entry point nào trong repository. Hãy bắt đầu bằng cách phân rã công việc cần thực hiện —RDF Turtle/NQuads, JSON-LD, phân tích RDFa, HDT FFI, một ontology OWL, các thay đổi đối với đầu ra Scribble và việc truy vấn HDT hoặc triple store— rồi xác định phạm vi trước khi triển khai; công việc được xem là hoàn tất khi hoàn thành việc đại tu đầu ra ngữ nghĩa và truy vấn như mô tả.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

This is a proposal for an overhaul of current Scribble implementation.

The goal of the project is for every document generated by Scribble to be semantically annotated with RDFa + JSON-LD and search to be (also) implemented with HDT/SPARQL as engine.

The benefits:
  • Flexible Datalog like querying for every facet of document
  • Possibility of building Natural Language Querying on top of RDF data and SPARQL- Ease of extending properties thanks to Open World Assumption of OWL.
  • Data annotation can be as granular as needed (e.g. it could include source code line on github for every paragraph).
  • Semantic annotation is accessible for search engines crawlers.
  • If packagsrc would implement semantic data the data integration between these 2 would be seamless (e.g. you could search for all packages that use SomeFunction)
  • Ability to reason about documentation (e.g. list documentation that doesn't fulfill certain criteria)
The means/Required work:
  1. implement RDF toolset in Racket:
  • RDF turtle/NQuads
  • JSON-LD (implemented by @cwebber)
  • RDFa parser
  • HDT ffi (for data storage and querying)
  1. Building OWL ontology for Scribble documentation/code
  2. Rework of Scribble output to replace current class based annotation with RDFa. If you are not familiar with Semantic annotation take a look at https://schema.org/Article especially scroll to the bottom to the RDFa tab.
  3. Data querying based on data stored in HDT files for local documentation and possibly triple store (e.g. RDF4J) for the server side documentation. http://www.rdfhdt.org/what-is-hdt/

If you have any questions regarding benefits/implementation details feel free to ask here.

Ngôn ngữ chính
Racket
Star
251
Fork
101
Merge trung bình
11 ngày 9 giờ
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của racket/scribble

Tất cả issue của racket/scribble

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.