Lady’s Gitweb - Codemark/blob - PROFILE.lesml

   1 #!lesml@en$
   2 ## SPDX-FileCopyrightText: 2026 Lady <https://www.ladys.computer/about/#lady>
   3 ## SPDX-License-Identifier: CC-BY-SA-4.0
   4
   5 ⁌ 🧮🖍 Codemark Les·M·L Output
   6
   7 This document describes the expected Les·ML output of the
   8   `./sh/codemark.sh´ script, which is identified via the profile
   9   `urn:fdc:ladys.computer:20260226:codemark:prf:out´.
  10
  11 § Lines Of Code
  12
  13 Lines of code which represent the literal text of the program are
  14   recorded as plain (toplevel) preformatted lines.
  15 The first line will begin with a comment of the form `syntax:XXX´,
  16   where `XXX´ is the syntax identifier.
  17
  18 It is important that code does not accidentally contain Les·M·L
  19   formatting, as no escaping is done.
  20 In most cases, only the acute quote is problematic, as it pairs with
  21   the grave quote common in source code.
  22
  23 § Code Formatting
  24
  25 The following conventions are used :⁠—
  26
  27 • Variable names are underlined (`⸤´ and `⸥´).
  28
  29 • Comments are marked as inline notes (`⟦´ and `⟧´).
  30
  31 • Labels are marked as titles (`⟪´ and `⟫´).
  32
  33 • Strings, numbers, and other values are made offset (`⟨´ and `⟩´).
  34   They are given a class indicating the type of value; one of :⁠—
  35
  36 ◦ ☞︎`string´:☜︎ Characters, codepoints, or sequences there·of.
  37
  38 ◦ ☞︎`numeric´:☜︎ Numeric values of various types.
  39
  40 ◦ ☞︎`boolean´:☜︎ True or false.
  41
  42 ◦ ☞︎`enum´:☜︎ An enumerated value of some sort.
  43
  44 ◦ ☞︎`nullish´:☜︎ Null, undefined, or similar language values.
  45
  46 • Keywords and commands are made bold (`⦃´ and `⦄´).