commonform-markup-parse supersedes this package. New development is focused on that package.
Typing Guide
Common Form markup utilizes rarely-used symbols you can type with your keyboard to structure agreements and indicate definitions, uses of defined terms, fill-in-the-blanks, and cross-references between provisions. For example:
Preamble \\ This Agreement (this ""Agreement"") is made effective as of[Effective Date] by and between [Seller's Legal Name] (""Seller"") and[Buyer's Legal Name] (""Buyer""). Definitions \\ For purposes of this <Agreement>, the following termshave the following meanings: \\ ""Capital Stock"" means the capital stock of the Company,including, without limitation, the <Common Stock> and the <PreferredStock>. \\ ""Dissolution Event"" means: \\ a voluntary termination of operations pursuant to {VoluntaryShutdown}; \\ a general assignment for the benefit of the <Company>'screditors or \\ any other liquidation, dissolution or winding up of the<Company> (excluding a <Liquidity Event>), whether voluntary orinvoluntary.
Each provision of the form begins with \\
. If the provision has a heading, it goes before the slashes, like Definitions \\ ...
. Subprovisions are set below their parent provisions by indenting with four spaces.
Within a provision, defined terms are set in ""double quotation marks""
and uses of defined terms are typed <within angle brackets>
. A cross-reference to a provision with a {Particular Heading}
is with braces. [Blanks to be filled in]
use square brackets.
The Module
.parse
and .stingify
pass the commonform-markup-tests suite.