USFMToolsSharp.Renderers.USX 0.1.0

.NET Standard 2.0
dotnet add package USFMToolsSharp.Renderers.USX --version 0.1.0
NuGet\Install-Package USFMToolsSharp.Renderers.USX -Version 0.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="USFMToolsSharp.Renderers.USX" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add USFMToolsSharp.Renderers.USX --version 0.1.0
#r "nuget: USFMToolsSharp.Renderers.USX, 0.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install USFMToolsSharp.Renderers.USX as a Cake Addin
#addin nuget:?package=USFMToolsSharp.Renderers.USX&version=0.1.0

// Install USFMToolsSharp.Renderers.USX as a Cake Tool
#tool nuget:?package=USFMToolsSharp.Renderers.USX&version=0.1.0

GitHub Travis (.com) branch Nuget Nuget

USFMToolsSharp

A .net parser and rendering toolkit for USFM.

Description

USFMToolsSharp is a parser and a collection of renderers for .net

Installation

You can install this package from nuget https://www.nuget.org/packages/USFMToolsSharp/

Requirements

We targeted .net standard 1.0 so .net core 1.0, .net framework 4.5, and mono 4.6 and higher are the bare minimum.

Building

With Visual Studio just build the solution. With the .net core tooling use dotnet build

Contributing

Yes please! A couple things would be very helpful

  • Testing: Because I can't test every single possible USFM document in existance. If you find something that doesn't look right in the parsing or rendering please submit an issue.
  • Adding support for other markers to the parser. There are still plenty of things in the USFM spec that aren't implemented.
  • Adding support for other markers to the HTML renderer
  • Adding other renderers (LaTeX, PDF, EPUB, JSON, etc.). Some of those renderers might not be possible in .net standard and if that is the case we'll just need to create another repo to contain the renderer

Usage

There a couple useful classes that you'll want to use

USFMDocument

This class is a tree of objects that represent a USFM document There are a couple of methods and properties that you'll find useful

USFMDocument output = new USFMDocument();
// The contents of the document
output.Contents;
// To find all the child markers of a certain type (in this case chapters)
output.GetChildMarkers<CMarker>();
// To merge the contents of one USFMDocument with another
USFMDocument otherDocument = new USFMDocument();
output.Insert(otherDocument);

USFMParser

This class creates an abstract syntax tree from a USFM string. It can also be passed a list of specific markers as strings into its constructor to ignore them if needed.

Example:

USFMParser parser = new USFMParser();
var contents = File.ReadAllText("01-GEN.usfm");
USFMDocument output = parser.ParseFromString(contents);

Renderers

HTMLRenderer

For more information, please look into the repository.

HTML Renderer for USFM

DocxRenderer

For more information, please look into the repository.

Docx Renderer for USFM

JSONRenderer

For more information, please look into the repository.

JSON Renderer for USFM

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.0 227 3/9/2022
0.0.1 231 11/8/2021