Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

suspension - cross-format merging through token suspension

This library enables the transfer of text changes from one document to another, while preserving unique tokens in the destination document.

These tokens must be context-free, which is generally quite an issue, but certain formats such as Markdown and Wiki can handle it OK.

Components

  • Suspender - Removes the given set of tokens from the document, storing them in an offsets table (lossless).
  • Unsuspender - Joins a base document and an offsets table together to procude a single output document.
  • TextReplayer - Push changes from one document to another while preserving unique tokens in the destination document.
  • RelativeSuspendedTokens - (De)serialize a tab-delimited syntax for the offsets.
  • TokenReplacer - Push token offsets from one document to another.
  • TokenRemover - Remove tokens from a document.

How to run specs

Run entire spec suite:

rake

or just run a single spec file:

ruby specs/repositext_tokens_spec.rb

Command line utility (incomplete)

	suspend push text from-file to-file [-tokens]
	TextReplayer.new(from-text, to-text).replay

	suspend push [:subtitle_mark] from-file to-file
	TokenReplacer.new(from-text,to-text, Suspension::REPOSITEXT_TOKENS, Suspension::REPOSITEXT_TOKENS).replace([:subtitle_mark]) --> to_file

	suspend strip frome-file to-file [-tokens]
	Suspender.new(from-text,Suspension::REPOSITEXT_TOKENS).suspend.filtered_text

	suspend export from-file to-file [-tokens]
	Exports the token offset list.

	Suspender.new(from-text,Suspension::REPOSITEXT_TOKENS).suspend.suspended_tokens.to_relative.serialize

	suspend import offset-file text-file, to-file
	Merges the offset and text file

Diagrams

Repositext tokens overview

Repositext tokens

Workflow: Sync text changes from PT to AT

Retaining repositext tokens in AT.

Repositext tokens

Workflow: Sync subtitle_marks from ST to AT

Retaining plain text and other repositext tokens in AT.

Repositext tokens

Workflow: Convert AT to PT

Retaining kramdown-subset tokens, discarding at-specific tokens.

Repositext tokens

Workflow: Sync record_mark tokens from AT V2 to AT V1

Retaining all other tokens in AT V1.

Repositext tokens

About

Enables cross-format merging through token suspension.

Resources

License

Releases

No releases published

Packages

No packages published

Languages