Caution

This project is a work in progress.

If you want to learn more about the development journey, please join the Developer Sanctuary or Ivirius Community Discord servers to see the project in active development.

🪨 Rosetta

The Rosetta .NET compiler provides document format languages with rich code analysis APIs.

Rosetta is a project that aims to unify the way text is represented in apps. It creates a common format for all text document types to compile into, with support for a wide variety of features and an extensible framework that allows consumers to build their own custom controls for Rosetta. Its base is in XML with a custom namespace schema that allows for developing basic documents. It can be expanded using more namespaces, to include support for things like fonts, custom text controls, text formatting, and more!

🎁 Using Rosetta

🛠️ Building from source

1. Prerequisites

• Visual Studio 2022 with the following individual components:
  • .NET SDK
  • Windows App SDK development workload (if on Windows)
• Git

2. Clone the repository

git clone https://github.com/Lamparter/Rosetta

This will create a local copy of the repository.

3. Build the project

To build Rosetta for development, open the Rosetta.sln item in Visual Studio. Right-click on the Riverside.Markup project in solution explorer and select click 'Build'.

✍️ Specification

Rosetta and its syntax is derived from XML and inspired by XAML markup. It follows all the rules of XML. The root schema and its extensions are documented in this repository. This repository also provides tools for creating and distributing your own Rosetta extensions for building text elements that aren't already included in the BCL.

The BCL (Riverside.Markup) contains primitive classes that can be inherited for basic text abstraction, including paragraphs, headers, styling and text itself. The BCL also contains extensions that are not required to use Rosetta but contain text functions that are generally useful, such as Riverside.Markup.Typefaces which allows for use of fonts and Riverside.Markup.Formatting which gives basic Markdown-inspired rich text functionality.

---

Note

Here are a few examples of Rosetta in use. Rosetta is a very expandable language and these examples will change as development progresses.

I've chosen to only include markdown-style interpretations of what is possible with Rosetta as they appear best on GitHub.

Hello Person, what is going on with you? hi there.

<!--
    DO NOT MODIFY this file directly unless you are knowledgeable about
    Rosetta and have created a backup copy.  Incorrect changes to this
    file will make it impossible to load the document using an editor.
-->
<Document
    xmlns="http://iviri.us/schemas/2024/rosetta"
    xmlns:type="https://iviri.us/schemas/2024/commonfonts"
    xmlns:f="https://iviri.us/schemas/2024/formatting">

    <Paragraph>
        <Text> <!-- when Font argument is not provided the default is assumed, Aptos -->
            Hello <f:Bold>Person</f:Bold>, what is <f:Italic>going on with <f:Code>you</f:Code>?
        </Text>
        <Text Font="{type:Font Trebuchet}">
            hi there.
        </Text>
    </Paragraph>
</Document>

a BlockQuote element

what about a code block?

// here's a codeblock with a funny style

a heading!

another heading!!

example

^ you'll notice there's a new paragraph change here

<!--
    DO NOT MODIFY this file directly unless you are knowledgeable about
    Rosetta and have created a backup copy.  Incorrect changes to this
    file will make it impossible to load the document using an editor.
-->
<Document
    xmlns="http://iviri.us/schemas/2024/rosetta"
    xmlns:f="https://iviri.us/schemas/2024/syntax/formatting">
    <Paragraph>
        <BlockQuote>
            a <f:Code>BlockQuote</f:Code> element
        </BlockQuote>
        <FencedCode>
            what about a code block?
        </FencedCode>
        <FencedCode SyntaxHighlight="C#">
            // here's a codeblock with a funny style
        </FencedCode>
    </Paragraph>
    <Paragraph>
        <Heading Iteration="1">
            a heading!
        </Heading>
        <Heading Iteration="2">
            another heading!!
        </Heading>
        <Text>
            example
        </Text>
    </Paragraph>
        <Text>
            ^ you'll notice there's a new paragraph change here
        </Text>
    <Paragraph>
</Document>