Physlib.Meta.Notes.HTMLNote
3 declarations
of note information
#ofNodeInfoGiven a structure of type `NoteInfo` containing information about a declaration or note, this function converts it into an `HTMLNote` structure.
HTML note of a formal declaration
#ofFormalGiven a formal declaration name , this function constructs an `HTMLNote` structure within the `CoreM` monad. It retrieves the line number , the file name, and the literal source code string associated with from the environment. The function generates an HTML block containing: 1. A GitHub link to the source code at line within the `physlib` repository. 2. The source code of the declaration (retrieved via `getDeclString`) enclosed in HTML `<pre><code>` tags for display. The resulting `HTMLNote` object includes this formatted HTML content along with the source file and line number metadata.
HTML note of an informal declaration
#ofInformalGiven a declaration name , this function constructs an `HTMLNote` structure within the `CoreM` monad. It retrieves the line number , the file name, and the documentation string associated with from the environment. Based on whether the declaration is an `InformalDefinition` or an `InformalLemma`, the function generates an HTML block containing: 1. A GitHub link to the source code at line . 2. The name of the declaration . 3. The contents of the documentation string, where newlines are replaced by HTML line breaks. The resulting `HTMLNote` includes this formatted HTML content along with the source file metadata.
