alan-if / alan-docs

Alan IF Documentation Project

Home Page:https://git.io/alan-docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Use New encoding Option with include:: Directives

tajmone opened this issue · comments

In the Beginners' Guide:

  • Use the new include:: encoding option to avoid having to convert Alan sources and transcripts from ISO-8859-1 to UTF-8.
    • Get rid of the temporary folder with the UTF-8 converted Alan files.
    • Update build scripts accordingly.
    • Update READMEs accordingly.

NOTE — No other documents in this repository are using the UTF-8 conversion and include:: system.


Currently the Beginners' Guide is relying on include:: directives to import external Alan sources and transcripts, which are first converted from ISO-8859-1 to UTF-8.

In 2019 I had submitted a feature request to enable support for other encodings, which was implemented and made its way into stable releases — but hasn't yet been documented! It's usage is as follows:

include::./somefile.alan[encoding=iso-8859-1]

References