Simbel - Revision history

Alexander: Revisit the big picture

2025-05-22T06:34:39Z

Revisit the big picture

@@ Line 8: / Line 8: @@
 |lic=[[Artisan Software Licence#ASL 1.1|ASL 1.1]]
 }}
-'''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document tree that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print).
+'''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print).
 ==Conceptual overview==
-The central object of Simbel is a '''schematic''' which references all of the input in their various forms, including details about their placement, weight, truncation and other context. This schematic can then be rendered into one of several output formats described below, ''or'' it may be finalised and compressed as-is in the Abu format for preservation or further processing by other tools. The schematic itself never contains the content, not even text.
+The central object of Simbel is a '''schematic''' which references all of the input in their various forms, including details about their placement, weight, truncation and other context. This schematic can then be rendered into one of several output formats described below, ''or'' it may be finalised and compressed as-is in the Abu format for preservation or further processing by other tools. The schematic itself never contains the content, but is rather bundled with it, potentially in finalised Abu archives.
 ===Forms of input===
 Simbel ingests several forms of content input, including:
-* [[Cliffdoc]]s &mdash; a terse, source-embedded form of code documentation
+* Cliffdocs &mdash; a terse, source-embedded form of code documentation
 * Manual pages, or "manpages" &mdash; long-form literature text that explains code in-depth
 * Diagrams &mdash; flowcharts and other easily vectorised technical graphics that aid explanation
@@ Line 21: / Line 22: @@
 * Hypermedia &mdash; not a direct format but a property of the other input formats that is merged and collated
-===Abstract document model===
+===Canonical formats===
-The abstract document model, or ADM, is the master blueprint of what will ultimately be rendered into the various output formats. It has the following characteristics:
+Simbel uses the [[RFC format]] as its chief medium of text storage. Figures are reserved space in the document flow and embedded programmatically by Simbel at render time according to the desired format's needs. Textual data is encoded in this format and thereby as a superset of the self-evident ASCII-compatible [[TTY format]]. RFC means that authors should expect 72-column lines and 50-line pages, excluding margins, headers and footers which are managed separately.
-Here's a shorthand term list for the above:
+===Further rendering===
 Simbel targets the following formats for rasterization of its ADM:
 * XHTML 1.0 (for reading on tablets and computers)
 * LaTeX (to be translated into page description formats like PDF)
 * Abu format (see below)
-====Abu format====
+==Abu format==
 Simbel will provide a stabilised public ABI via a file format that contains all of the necessary data and metadata for output. This allows others to target new formats using nothing more than the knowledge of this file format, and it also allows dynamic rendering and navigation in the form of editor plugins. Abu also serves as the "intermediate representation" that Simbel uses to instantiate its templates for XHTML, HTML and LaTeX.
 ==Interface==

Alexander: LaTeX over DVI, and /* Syntax */ add anchor syntax

2024-07-23T03:24:09Z

LaTeX over DVI, and Syntax: add anchor syntax

← Older revision		Revision as of 03:24, 23 July 2024
Line 70:		Line 70:
	<* "mypalette" identifier must be defined in <# simbel logic #> *>		<* "mypalette" identifier must be defined in <# simbel logic #> *>

			<anchor id(123) wt(0.1)><* here is anchor #123, with a weight of 0.1 *>
	<lnk bcv(1,1,1):link to book 1, chapter 1, verse 1:>		<lnk bcv(1,1,1):link to book 1, chapter 1, verse 1:>
	</pre>		</pre>
Line 77:		Line 78:
	* XHTML 1.0 (for reading on tablets and computers)		* XHTML 1.0 (for reading on tablets and computers)
	** when rendering with this, dedicated space for blocks I and E are unnecessary, as hyperlinks can be embedded directly		** when rendering with this, dedicated space for blocks I and E are unnecessary, as hyperlinks can be embedded directly
	* ~~DVI~~ (to be translated into page description formats like PDF)		* LaTeX (to be translated into page description formats like PDF)
	* Abu format (see below)		* Abu format (see below)

Line 106:		Line 107:
	:: <code>--thin</code>, <code>-t</code> <sub>optional</sub> output a thin archive, only referencing all resources		:: <code>--thin</code>, <code>-t</code> <sub>optional</sub> output a thin archive, only referencing all resources
	:: <code>--lz4</code>, <code>-l</code> <sub>optional</sub> compress the archive with LZ4		:: <code>--lz4</code>, <code>-l</code> <sub>optional</sub> compress the archive with LZ4
	:: <code>--lzip</code>, <code>-L</code> <sub>optional</sub> compress the archive with ~~lzip~~		:: <code>--lzip</code>, <code>-L</code> <sub>optional</sub> compress the archive with Lzip
	:: <code>--uncompressed</code>, <code>-u</code> <sub>optional</sub> do not compress the archive		:: <code>--uncompressed</code>, <code>-u</code> <sub>optional</sub> do not compress the archive
	:: <code>--normal</code>, <code>-n</code> <sub>optional</sub> use normal compression levels with LZ4/Lzip (this is the default when a bare compression flag is given)		:: <code>--normal</code>, <code>-n</code> <sub>optional</sub> use normal compression levels with LZ4/Lzip (this is the default when a bare compression flag is given)

Alexander: image, not emblem

2024-06-20T04:49:50Z

image, not emblem

← Older revision		Revision as of 04:49, 20 June 2024
Line 1:		Line 1:
	{{stub}}{{infobox swproj		{{stub}}{{infobox swproj
	\|name=Simbel		\|name=Simbel
	\|~~emblem~~=Simbel.jpg		\|image=Simbel.jpg
	\|by=Alexander Nicholi		\|by=Alexander Nicholi
	\|langs={{wp\|C (programming language)\|C}}, [[C*]]		\|langs={{wp\|C (programming language)\|C}}, [[C*]]

Alexander: /* Syntax */ new section

2024-05-05T04:20:07Z

Syntax: new section

← Older revision		Revision as of 04:20, 5 May 2024
Line 37:		Line 37:

	Simbel solves this problem intelligently using '''anchors and weights'''. Anchors are invisible points within your leading text body that are placed in an editor program, relative to which you can tie another piece of content, such as a graphic. They are also used to place both internal and external references. Every visually active anchor (i.e. all anchors containing content except reference anchors) has a weight associated with it, which is a normalised number in the range <math>(0, 1]</math>. A weight of <math>1</math> is equivalent to black hole level gravity and will force the anchor's content to be as close to the content in block B as physically possible. The value will compete with the weights of other nearby visually active anchors, so make sure not to put too many highly weighted anchors nearby, as this will destroy the fabric of your document.		Simbel solves this problem intelligently using '''anchors and weights'''. Anchors are invisible points within your leading text body that are placed in an editor program, relative to which you can tie another piece of content, such as a graphic. They are also used to place both internal and external references. Every visually active anchor (i.e. all anchors containing content except reference anchors) has a weight associated with it, which is a normalised number in the range <math>(0, 1]</math>. A weight of <math>1</math> is equivalent to black hole level gravity and will force the anchor's content to be as close to the content in block B as physically possible. The value will compete with the weights of other nearby visually active anchors, so make sure not to put too many highly weighted anchors nearby, as this will destroy the fabric of your document.

			====Syntax====
			Here is a work-in-progress example of how an ADM source file could look:
			<pre><* this is a comment <* yes it can nest > >
			<# simbel logic goes here <* comments also work *> #>

			<* none of the above RENDERS in any case *>
			<* to render literal angle brackets, double them up
			* so "<<" renders as "<" and ">>" renders as ">" *>

			<h1:"Corpus" or whole-document level heading:>
			<h2:"Book" level heading:>
			<h3:"Chapter" level heading:>

			<ol:<li:Ordered list item one:>
			<li:Ordered list item two
			<ol:<li:Ordered sublist item one:>
			<li:Ordered sublist item two:>:>:>
			<li:Ordered list item three
			<ul:<li:Unordered sublist item one
			<ol:<li:Ordered sublist within unordered sublist item one:>:>:>:>:>:>
			<parbrk><* that is a paragraph break *>
			This is a paragraph of normal text. <b:this is bold text.:>
			This is still on the same paragraph: <i:italic:>, <u:underlined:>,
			<sup:superscript:>, <sub:subscript:>,

			<pgbrk><* that is a page break *>
			<col cmyk8(0,1,2,3):this is 8-bit-per-channel CMYK coloured text:>
			<* other col functions include cmyk4, cmyk16, rgb5, rgb10, gray8,
			* gray16 and pal *>
			<col pal(mypalette, 69):this is palette-coloured text:>
			<* "mypalette" identifier must be defined in <# simbel logic #> *>

			<lnk bcv(1,1,1):link to book 1, chapter 1, verse 1:>
			</pre>

	===Handling output===		===Handling output===

Alexander: Use Template:infobox swproj

2023-09-23T06:26:11Z

Use Template:infobox swproj

← Older revision		Revision as of 06:26, 23 September 2023
Line 1:		Line 1:
	{{stub}}[[~~File:Simbel.svg~~\|~~thumb~~\|~~right~~\|~~The emblem for the Simbel software~~.]]		{{stub}}{{infobox swproj
			\|name=Simbel
			\|emblem=Simbel.jpg
			\|by=Alexander Nicholi
			\|langs={{wp\|C (programming language)\|C}}, [[C*]]
			\|systems=[[Sirius DOS]]
			\|archs={{wp\|Intel 80286\|i286}}
			\|lic=[[Artisan Software Licence#ASL 1.1\|ASL 1.1]]
			}}
	'''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document tree that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print).		'''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document tree that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print).

Alexander: /* Interface */ add compression options to pack verb

2023-07-31T20:14:08Z

Interface: add compression options to pack verb

← Older revision		Revision as of 20:14, 31 July 2023
Line 62:		Line 62:
	:: <code>--fat</code>, <code>-f</code> <sub>optional</sub> output a fat archive, embedding all resources (this is the default when no flag is given)		:: <code>--fat</code>, <code>-f</code> <sub>optional</sub> output a fat archive, embedding all resources (this is the default when no flag is given)
	:: <code>--thin</code>, <code>-t</code> <sub>optional</sub> output a thin archive, only referencing all resources		:: <code>--thin</code>, <code>-t</code> <sub>optional</sub> output a thin archive, only referencing all resources
			:: <code>--lz4</code>, <code>-l</code> <sub>optional</sub> compress the archive with LZ4
			:: <code>--lzip</code>, <code>-L</code> <sub>optional</sub> compress the archive with lzip
			:: <code>--uncompressed</code>, <code>-u</code> <sub>optional</sub> do not compress the archive
			:: <code>--normal</code>, <code>-n</code> <sub>optional</sub> use normal compression levels with LZ4/Lzip (this is the default when a bare compression flag is given)
			:: <code>--max</code>, <code>-m</code> <sub>optional</sub> use maximum compression levels with LZ4/Lzip

	[[Category:Byblos components]]		[[Category:Byblos components]]

Alexander: /* Interface */ new section

2023-07-31T08:21:52Z

Interface: new section

@@ Line 39: / Line 39: @@
 ====Abu format====
 Simbel will provide a stabilised public ABI via a file format that contains all of the necessary data and metadata for output. This allows others to target new formats using nothing more than the knowledge of this file format, and it also allows dynamic rendering and navigation in the form of editor plugins. Abu also serves as the "intermediate representation" that Simbel uses to instantiate its templates for XHTML, HTML and LaTeX.
 [[Category:Byblos components]]

Alexander: /* Conceptual overview */ add opening paragraph, plus details about output modes

2023-07-31T08:09:43Z

Conceptual overview: add opening paragraph, plus details about output modes

← Older revision		Revision as of 08:09, 31 July 2023
Line 3:		Line 3:

	==Conceptual overview==		==Conceptual overview==
			The central object of Simbel is a '''schematic''' which references all of the input in their various forms, including details about their placement, weight, truncation and other context. This schematic can then be rendered into one of several output formats described below, ''or'' it may be finalised and compressed as-is in the Abu format for preservation or further processing by other tools. The schematic itself never contains the content, not even text.

	===Forms of input===		===Forms of input===
	Simbel ingests several forms of content input, including:		Simbel ingests several forms of content input, including:
Line 30:		Line 32:
	===Handling output===		===Handling output===
	Simbel targets the following formats for rasterization of its ADM:		Simbel targets the following formats for rasterization of its ADM:
	* XHTML 1.0		* XHTML 1.0 (for reading on tablets and computers)
	* ~~HTML 5~~ with ~~ES6~~		** when rendering with this, dedicated space for blocks I and E are unnecessary, as hyperlinks can be embedded directly
	* ~~LaTeX~~ (~~for~~ PDF ~~and print~~)		* DVI (to be translated into page description formats like PDF)
	* Abu format (see below)		* Abu format (see below)

Alexander: /* Conceptual overview */ new

2023-03-11T19:31:52Z

Conceptual overview: new

@@ Line 1: / Line 1: @@
 {{stub}}[[File:Simbel.svg|thumb|right|The emblem for the Simbel software.]]
 '''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document tree that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print).
 [[Category:Byblos components]]

Alexander: Created page with "{{stub}}The emblem for the Simbel software. '''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document tree that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print). Category:Byblos components"

2023-03-04T17:46:28Z

Created page with "{{stub}}thumb|right|The emblem for the Simbel software. '''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document tree that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print). Category:Byblos components"

New page

{{stub}}[[File:Simbel.svg|thumb|right|The emblem for the Simbel software.]]
'''Simbel''' is a document generation tool that consumes several categories of input information to create an abstract document tree that can then be rendered logically into various publication mediums including XHTML, HTML5, and PDF (and therefore including print).

[[Category:Byblos components]]