gardener, Interface administrators, Administrators
1,546
edits
Changes
Jump to navigation
Jump to search
'''While a git repository URL ''should'' work and is the most elegant wayAs an module author, it doesn’t really work at makes sense to subscribe to the moment (2023[https://mailman.ntg.nl/mailman3/lists/dev-05), because it creates `context.tarntg.gz` archives that the installer can’t handlenl/ developers mailing list].'''
updated list of contributed modules
mtxrun --script install-modules --install --all
==Installation by script (old)==
Previously, the ConTeXt LMTX distribution did not provide a built-in way to install or update modules.
# Update the ConTeXt file database.
mtxrun --generate
==Installation by script (MkIV) ==
* {{code|s-cdr-00.tex}}: CD-ROM cover style
* {{code|s-faq-00.tex}} to `-03`: FAQ styles
* {{code|s-pre-00.tex}} to `-96`: Several old presentation styles(replaced by the following) in `texmf-context/tex/context/modules/mkiv`:* {{code|s-present-*.tex}}: Several presentation styles (examples in `texmf-context/doc/context/presentations/examples`)
… many more …
=Contributed Modules=
(as of 2024-04-21)
For a list of contributed modules see [http://modules.contextgarden.net the modules section] on contextgarden.net:
* [http://modules.contextgarden.net/account t-account] draw T-accounts(2009, but works with LMTX)* [http://modules.contextgarden.net/algorithmic t-algorithmic] like LaTeX algorithmic(2013)* [http://modules.contextgarden.net/animation t-animation] create animations(2013)* [http://modules.contextgarden.net/annotation t-annotation] todo lists(2013)* [http://modules.contextgarden.net/aquamints aquamints] AquaMints symbol support (2005, obsolete)* [http://modules.contextgarden.net/t-bnf t-bnf] BNF grammar(2006)* [http://modules.contextgarden.net/chromato t-chromato] chromatograms(2008)* [http://modules.contextgarden.net/cmscbf t-cmscbf] bold small caps(2006, outdated)* [http://modules.contextgarden.net/cmttbf t-cmttbf] bold typewriter(2006, outdated)* [http://modules.contextgarden.net/environment-for-collating-marks collating-marks] collating marks (signature marks, DE Flattermarken) for multi-signature books (2023)* [http://modules.contextgarden.net/tCollection-of-calendars-based-on-PocketDiary-module calendar-examples] Examples for the PocketDiary module (2023)* [http://modules.contextgarden.net/construction-plan t-construction-plan] figures with defined scale(2008)* [http://modules.contextgarden.net/crossref crossref] cross-document references (2012, obsolete)* [http://modules.contextgarden.net/cyrillicnumbers cyrillic numbers] traditional Cyrillic numerals (2018, MkIV)* [http://modules.contextgarden.net/tdate-driven-lists date-driven-lists] Extension for the PocketDiary module (2023)* [http://modules.contextgarden.net/degrade t-degrade] downsampling (degrading ) JPEG images(2009, outdated)* [http://modules.contextgarden.net/enigma.zip enigma] Enigma I cipher (2013)* [http://modules.contextgarden.net/fancybreak t-fancybreak] thought breaks(2015)* [http://modules.contextgarden.net/filter t-filter] run external programs on inline code(2022, works with LMTX)* [http://modules.contextgarden.net/french french] settings for French documents (2011, obsolete)* [http://modules.contextgarden.net/fullpage fullpage] equal margins without {{cmd|setuplayout}} (2017)* [http://modules.contextgarden.net/fixme t-fixmegantt gantt] Gantt charts (2012)* [http://modules.contextgarden.net/gnuplot gnuplot] like LaTeX fixmeinclude GNUplot graphics, context and tikz terminals (2013)* [http://modules.contextgarden.net/t-french t-frenchgreek Greek]Ancient (polytonic) Greek support (2013, obsolete)* [http://modules.contextgarden.net/fullpage t-fullpagehandlecsv handlecsv]CSV support for mail merging etc. (2024)* [http://modules.contextgarden.net/games thigh high] syntax highlighting (2017; [https://bitbucket.org/philexander/context-gameshighlight/src/master/ 2021 version] board games)* [http://modules.contextgarden.net/gantt t-ganttinifile inifile] Gantt charts.ini files (2008, outdated)* [http://modules.contextgarden.net/gnuplot t-gnuplotkarnaugh karnaugh] include GNUplot graphicsKarnaugh maps (2021)* [http://modules.contextgarden.net/t-layout t-layout]first version of {{cmd|showlayout}} (2007, obsolete)* [http://modules.contextgarden.net/letter t-letter] formal letters AKA correspondence(2021, works with LMTX)* [http://modules.contextgarden.net/letterspace.mkiv letterspace] letterspacing (2013, MkIV, obsolete)* [http://modules.contextgarden.net/tlua-widow-control lua-lettrine twidow-lettrinecontrol] decorative paragraph starts automatical avoidance of widows and orphans in grid mode (initials2022, [https://github.com/gucci-on-fleek/lua-widow-control latest version])* [http://ctan.org/pkg/markdown t-markdown] render markdown documents(LaTeX: 2024, ConTeXt example is MkII)* [http://modules.contextgarden.net/mathsets t-mathsets] mathematical sets, probabilities etc.(2011, probably outdated)* [http://modules.contextgarden.net/metaducks metaducks] partial port of TikZducks to MetaPost (2023)* [http://modules.contextgarden.net/pararef t-pararef] {{cmd|startParagraph|link=no}}, for paragraphs as ‘thought blocks’ that may contain more than one 'TeX paragraph'. These paragraphs are numbered and can be referenced. See [[Paragraph Referencing]].(2012, probably obsolete)* [http://modules.contextgarden.net/pauta pauta] practise grids for medieval calligraphy (2024, LMTX)* [http://modules.contextgarden.net/pocketdiary PocketDiary] PocketMod-style (and other) calendars incl. sun & moon data (2023, LMTX)* [http://modules.contextgarden.net/president president] “ConTeXt for pres(id)entations”, a few presentation styles with graphical progress indicator (2023, LMTX)* [http://modules.contextgarden.net/presvoz PresVoz] automatical PDF presentations with recorded voice (2024, LMTX, works only with Acrobat on Windows)* [http://modules.contextgarden.net/ruby tpret-rubyc pret-c] Ruby markup syntax highlighting (pretty printing) for ChineseC (2010, not programming languageoutdated)* [http://modules.contextgarden.net/rst rst] RestructuredText support (2014, MkIV)* [http://modules.contextgarden.net/simplebib simplebib] simple bibliography (2012)* [http://modules.contextgarden.net/simplefonts simplefonts] simple font support (2013, obsolete)* [http://modules.contextgarden.net/simpleslides t-simpleslides] presentations(2023, works with LMTX)* [http://modules.contextgarden.net/squares squares] magic/Latin squares (2024)* [http://modules.contextgarden.net/statistical-charts statistical-charts] pie charts, bar charts etc. (2020)* [http://modules.contextgarden.net/sudoku sudoku] port of Peter Norvig’s sudoku solver (2023)* [http://modules.contextgarden.net/title title] document title pages (2017)* [http://modules.contextgarden.net/transliterator transliterator] scientific transliteration of Russian, Church Slavonic etc. (2021)* [http://modules.contextgarden.net/typearea t-typearea] like LaTeX/KoMa typearea (2008, MkII, obsolete)* [http://modules.contextgarden.net/vim t-vim] syntax highlighting using vim’s syntax files(2022, works with LMTX)* [http://modules.contextgarden.net/visualcounter visualcounter] counters for presentations (2013; [https://github.com/adityam/visualcounter 2019 version])
<!--
=Special Purpose Modules=
The following modules implement special formatting requirement for journals or magazines. These modules are distributed with ConTeXt, so you don’t need not to download anything.
* [[This Way - My Way#MyWay|My Way]], User documentation on ConTeXt
=Module writing guidelines=
'''Please don’t publish font support modules any more!''' They’re usually unnecessary. Instead publish [[Typescript_examplesTypescripts_examples|typescripts]] in the wiki instead.
==Module requirements==
Sort these files into folders according to TDS (TeX directory structure) – just have a look at the distribution to understand what goes where.
* Module code and data files go into tex/context/third/modulename
* Documentation files go into doc/context/third/modulename
* You can also look at properly setup git repositories like that of [https://codeberg.org/fiee/context-simpleslides the simpleslides module].
=== Module release file ===
VERSION and README files are important for publication on [https://ctan.org CTAN]. README is also displayed on git platforms like GitHub or Codeberg and should contain basic documentation. All top level files are ignored by the LMTX module installer.
Instead of zip files, also tar.gz archives are possible, but the installer script can only handle zip – libzip is a necessary part of Lua(Meta)TeX, while other archive formats are not.
=== Module main file ===
All module files should start with a block containing ''meta information'' about that module.
There is a [[Module template]] available to help setting up that header correctly.
=== License ===
Do not forget to specify a ''license'' as the permitted modes of distribution
==XML Interface file==
Each module should have an associated XML specification file
(as in [http://source.contextgarden.net/tex/context/interface/cont-en.xml /tex/context/interface/cont-en.xml]).
as are for instance the [http://pragma-ade.nl/general/qrcs/setup-en.pdf ConTeXt Quick Reference]
and the initial input of the [http://wiki.contextgarden.net/Category:Reference/en Command Reference],
which itself started as a wikification of the now obsolete ''TeXShowTeXshow''.
When documenting your module, you can use
<texcode>
\usemodule[intsetups-loadbasics] %Allow xml parsing
\loadsetups[t-name-of-your-module.xml] % to load the file with definitions
\setup{nameofyourcommand}
<context source="yes">
\setuppapersize[A5]
\usemodule[intsetups-loadbasics]\loadsetups[i-framed]\setup{externalfiguresetupframed}
</context>
==Self-documenting source code==
Source files are supposed to contain explanatory comments that document
implementation details and other peculiarities the reader should be
* Register an account, then you can login to the “member section”.
* If you lost your password, please ask Taco or Mojca (via the mailing list if you don’t know them).
* Please read the help page (it’s mostly the same as here).
* Create a '''new module''' entry with a distinct name (e.g. “simple”; this will become the internal ID) and fill in the metadata:
** Title, e.g. “Simple” (This will get used in filenames!)
** Short and longer description (the short one gets published e.g. in CTAN updates).
** Home URL, if the module has a homepage, e.g. a wiki pageor git repository.
** Keywords (for CTAN search)
** Type: Macro or font (Don’t Please don’t publish font modules any more!)
** Works with Mk... (please check)
** License(there are licenses missing, we need to fix that)** Check “Put in download section” (yes please, allows installation by rsyncscript)
** Check “Put in ConTeXt distribution” (not sure if this works)
** Check “Synch with CTAN” (yes please, makes it visible)
** SVN/GIT URL: repository checkout, structured like the ZIP, as outlined above
