racket / racket/scribble

scribble/html does not export the element structure

Open
#36 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
250
Forks
102
Avg merge
11d 11h
Merged PRs (30d)
1

Description

The module scribble/html does not export any structures.
That implies that it is not possible to do anything to the html
besides calling functions already defined in scribble/html

Consider this example:

#lang at-exp racket
(require scribble/html)

(define some-html @h2[id: "foo"]{bar})
; (element 'h2 '((id . "foo")) '("bar") #f)

(element-tag some-html)   ;; element-tag is unknown

(match some-html
  [(element tag atts contents ?)  ;; element is unknown
   tag])

I suspect simply adding element to the exports won't be enough,
since scribble/html defines a "smart constructor" named element
thus overriding the name.

This is the relevant file: https://github.com/racket/scribble/blob/master/scribble-html-lib/scribble/html/xml.rkt

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with scribble-html-lib/scribble/html/xml.rkt and inspect how scribble/html exports its structures and defines the smart constructor named element. Check how the example’s element-tag and element pattern are intended to resolve without the constructor conflict. Done means callers can inspect and match the HTML element structure through scribble/html.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.