smc / payyans-go

ASCII <-> Unicode conversion library

payyans

Note: This repo's canonical source is at https://gitlab.com/smc/payyans-go. Contributions should be done in the canonical source. If you're seeing this from somewhere else, note that it's a mirror.

This is the Go port of payyans and freaknz together as a shared library. The goal is the logic abstraction through a shared library.

Usage

By default the payyanscli binary comes with some font map files. See list of fonts:

payyanscli -fonts

Convert:

# Output to terminal
./payyanscli -font ML-TTKarthika file-to-convert.txt

# Output to a file
./payyanscli -font ML-TTKarthika file-to-convert.txt output-file.txt

See payyanscli -h for more.

Development

go run cli.go -font ML-TTKarthika.map file-to-convert.txt
make test

Goals

• ASCII to Unicode conversion
• Write more unit tests for ASCII to Unicode conversion
• Unicode to ASCII conversion
• Include all the Malayalam ASCII fonts
• Shared library
• Make a WASM web app

payyans-go's Issues

User Story: Convert document to Unicode

As a user, once I have selected a font and reviewed the sample text, I want to convert the entire document's encoding from ASCII to Unicode. This conversion should preserve the selected formatting, ensuring that the document's appearance is maintained in the target encoding.

Once completed, I expect to download the converted document in its original (or a compatible) file format, now encoded in Unicode and adjusted to the selected font, ready for my use.

Dependent issue - #9

Epic - #7

Take ODF/DOC/DOCX/RTF Files as Input and Provide the Converted Output in the Same (or a Compatible) File Format.

As a user, I want to convert document files from ASCII to Unicode encoding while retaining the original format (ODF, DOC, DOCX, RTF). After uploading my document, I expect to see a snippet of the text extracted from it displayed in the user interface. This preview enables me to select the appropriate font for the conversion process, ensuring that the text's appearance meets my requirements. By seeing the converted output on this sample, I can make informed decisions about the font and mapping adjustments before proceeding with the final conversion. This feature is crucial for me because it allows me to verify the accuracy and formatting of the converted document, ensuring that the final output is both readable and visually appealing, before committing to the full conversion process.

Will split this requirement into multiple sub issues in the form of user stories.

User Story: Document Coversion - Upload and Extract Sample Text

As a user, I want to upload my document files (ODF, DOC, DOCX, RTF) and have the system automatically extract a sample text from the document. This feature will allow me to preview the content in its current encoding (ASCII) before initiating the conversion process.

This requirement is a sub-task of the epic #7

User Story: Document Conversion - Preview Text and Select Font

As a user, after uploading and viewing a sample of my document's text, I want to be able to select an appropriate font for the conversion process. This selection should immediately reflect on the sample text displayed, enabling me to preview the converted sample text in Unicode encoding with the selected font. This preview allows me to approve the conversion settings or make adjustments if necessary, ensuring that the document meets my requirements.

This is issue has a dependent issue #8

This issue is a sub-task of the epic #7

Make the tests work, add more font tests

Fix the handling of ോ