{"id":29012187,"url":"https://github.com/liblouis/liblouisutdml","last_synced_at":"2025-06-25T18:15:21.776Z","repository":{"id":31528006,"uuid":"35092518","full_name":"liblouis/liblouisutdml","owner":"liblouis","description":"An open-source library providing complete braille  transcription services for xml, html and text documents","archived":false,"fork":false,"pushed_at":"2025-06-06T13:48:38.000Z","size":3737,"stargazers_count":26,"open_issues_count":36,"forks_count":17,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-06-06T14:35:08.693Z","etag":null,"topics":["accessibility","blind","braille","formatting"],"latest_commit_sha":null,"homepage":"http://liblouis.io","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/liblouis.png","metadata":{"files":{"readme":"README","changelog":"ChangeLog","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-05-05T10:19:28.000Z","updated_at":"2025-06-06T13:48:42.000Z","dependencies_parsed_at":"2023-01-14T19:14:44.599Z","dependency_job_id":"cc4c0935-8e8c-4456-a320-1bf17d283df5","html_url":"https://github.com/liblouis/liblouisutdml","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/liblouis/liblouisutdml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liblouis%2Fliblouisutdml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liblouis%2Fliblouisutdml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liblouis%2Fliblouisutdml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liblouis%2Fliblouisutdml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liblouis","download_url":"https://codeload.github.com/liblouis/liblouisutdml/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liblouis%2Fliblouisutdml/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261927691,"owners_count":23231383,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","blind","braille","formatting"],"created_at":"2025-06-25T18:15:20.618Z","updated_at":"2025-06-25T18:15:21.748Z","avatar_url":"https://github.com/liblouis.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Introduction\n\n[![Make check/distcheck](https://github.com/liblouis/liblouisutdml/actions/workflows/main.yml/badge.svg)](https://github.com/liblouis/liblouisutdml/actions/workflows/main.yml)\n\nLiblouisutdml is an open-source library providing complete braille\ntranscription services for xml, html and text documents. It translates\ninto appropriate braille codes and formats according to its style\nsheet and the specifications in the document. A command-line program,\n`file2brl` which uses this library is also included. The latest\nversion of liblouis is required. Java bindings are built in to the\nlibrary.\n\nThe library is licensed under the GNU Lesser General Public License\n(LGPL) version 3 or later. See the file COPYING.LIB.\n\nThe command line tools, are licensed under the GNU General Public\nLicense version 3.0 or later. See the file COPYING.\n\n# Documentation\n\nFor documentation, see `liblouisutdml.html` or `liblouisutdml.txt`.\nThese are in the docs directory. For an example of a configuration\nfile, see `liblouisutdml.ini` and `preferences.cfg`. For examples of\nsemantics-action files, see `dtbook.sem` and `nemeth.sem`. These files\nare in the `lbu_files` subdirectory. For examples of translation\ntables, see `en-us-g2.ctb`, `en-us-g1.ctb`, `chardefs.cti`,\n`nemeth.ctb` and whatever other files they may include. These are all\nin the `tables` directory of\n[liblouis][].\n\n# Installation\n\nFirst obtain the latest version of [liblouis][] and compile it. Before\ncompiling, you should chose between 16- and 32-bit Unicode, as\ndescribed in the README file and the documentation. liblouisutdml\ninherits this choice from liblouis.\n\nAfter unpacking the distribution tarball for liblouisutdml go to the\ndirectory it creates. After running `configure` run `make` and `make\ninstall`. You will need root privileges for the installation step.\n\nThis will produce the liblouisutdml library and the program\n`file2brl`. To compile the Java bindings go to the java subdirectory\nand run `ant`.\n\nNote that that the library and programs will not work properly unless\nyou have first installed the latest version of [liblouis][].\n\n# Docker\n\nThere are docker images for [liblouisutdml](https://hub.docker.com/r/liblouis/liblouisutdml/) and [liblouis](https://hub.docker.com/r/liblouis/liblouis/). So to run\nliblouisutdml from docker simply type the following command which will bring you into a shell where you can invoke `file2brl`:\n\n``` console\n$ docker run -it liblouis/liblouisutdml /bin/bash\nroot@74a8b1ad5e03:/usr/src/liblouisutdml# file2brl --help\nUsage: file2brl [OPTION] [inputFile] [outputFile]\nTranslate an xml or a text file into an embosser-ready braille file.\nThis includes translation into grade two, if desired, mathematical \ncodes, etc. It also includes formatting according to a built-in \nstyle sheet which can be modified by the user.\n\nIf inputFile is not specified or '-' input is taken from stdin. If outputFile\nis not specified the output is sent to stdout.\n\n  -h, --help          \t  display this help and exit\n  -v, --version       \t  display version information and exit\n  -f, --config-file       name a configuration file that specifies\n                          how to do the translation\n  -b, --backward      \t  backward translation\n  -r, --reformat      \t  reformat a braille file\n  -T, --text\t\t  Treat as text even if xml\n  -t, --html              html document, not xhtml\n  -p, --poorly-formatted  translate a poorly formatted file\n  -P, --paragraph-line    treat each block of text ending in a newline\n                          as a paragraph. If there are two newline characters\n                          a blank line will be inserted before the next paragraph\n  -C, --config-setting    specify particular configuration settings\n                          They override any settings that are specified in a\n                          config file\n  -w  --writeable-path    path for temp files and log file\n  -l, --log-file          write errors to file2brl.log instead of stderr\n\nReport bugs to \u003cliblouis-liblouisxml@freelists.org\u003e.\nroot@74a8b1ad5e03:/usr/src/liblouisutdml# \n```\n\n# Docker for cross-compiling\n\nYou can use a Dockerfile to cross-compile liblouisutdml using mingw\neither for 32 or for 64 bit architecture:\n\n``` console\n# for 32 bit architecture\ndocker build -f Dockerfile.win32 .\n# for 64 bit architecture\ndocker build -f Dockerfile.win64 .\n```\nThen grab the artifact from the docker container.\n\nOr instead let the Makefile do it all for you:\n\n``` console\nmake distwin\n```\n\n[liblouis]: http://www.liblouis.io/\n\n\u003c!-- Local Variables: --\u003e\n\u003c!-- mode: markdown --\u003e\n\u003c!-- End: --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliblouis%2Fliblouisutdml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliblouis%2Fliblouisutdml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliblouis%2Fliblouisutdml/lists"}