#Tag
Le réseau Médici (Métiers de l'édition scientifique publique) publie sur son site un entretien avec @arthurperret
Il y parle d'édition savante à l'ère du numérique, de l'articulation entre documentation et édition et de ses projets de recherche.
Merci à lui !
#SHS #edition #documentation #numerique
“We’ll document this later.”
That’s how knowledge gets lost.
Our latest article explains why internal documentation matters and how to make it work.
We’re also hosting a live webinar on using XWiki as a documentation tool:
🗓 Feb 25, 16:00 CET
🔗 Registration link: https://xwiki.com/en/webinars/XWiki-as-a-documentation-tool
👉 Read the article here: https://xwiki.com/en/Blog/internal-documentation-best-practices/
“We’ll document this later.”
That’s how knowledge gets lost.
Our latest article explains why internal documentation matters and how to make it work.
We’re also hosting a live webinar on using XWiki as a documentation tool:
🗓 Feb 25, 16:00 CET
🔗 Registration link: https://xwiki.com/en/webinars/XWiki-as-a-documentation-tool
👉 Read the article here: https://xwiki.com/en/Blog/internal-documentation-best-practices/
tuning(7) begins:
"The swap partition should typically be approximately 2x the size of main memory for systems with less than 4GB of RAM, or approximately equal to the size of main memory if you have more. "
I can't believe that 64 GB swap should be a norm for a system with 64 GB RAM.
<https://man.freebsd.org/cgi/man.cgi?query=tuning&sektion=7&manpath=freebsd-current>
New #Documentation: Importing ballistic chronograph data from #FXRadar into #InfluxDB
I use a pocket chronograph to monitor power output when #shooting - I decided that I wanted to be able to monitor it over time, so created a utility to take an export from the app and write it into InfluxDB
https://www.bentasker.co.uk/posts/documentation/shooting/importing-fx-radar-shots-into-influxdb.html
@emaste thanks for <https://github.com/freebsd/freebsd-src/commit/97beb0c9116f312c1820adb94455dc3b9a157135> – <https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md> is certainly easier to digest.
A handful of minor questions/issues …
<https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md#style> mentions the one-sentence-per-line rule for manual pages, however:
a) there's no such rule in mdoc(7) <https://man.freebsd.org/cgi/man.cgi?query=mdoc&sektion=7&manpath=freebsd-current> or style.mdoc(5) <https://man.freebsd.org/cgi/man.cgi?query=style.mdoc&sektion=5&manpath=freebsd-current>; and
b) I frequently see multiple lines for a single sentence – is this simply because authors and reviewers happily ignore a rule?
A random pick, from a very recently changed page:
– the longest line is 78 characters.
FreeBSD style aside, Debian man-pages(7) suggests a source code line length of no more than about 75 characters wherever possible: <https://manpages.debian.org/trixie/manpages/man-pages.7.en.html#Conventions_for_source_file_layout>.
I ran across this 2020 article that is part rant on the state of Unix documentation, part proposal of a way forward based on troff and a new documentation viewer. It has a good summary of the history of Unix documentation systems.
Gábor Melis introduces MGL-PAX, an "untangled" literate programming system for Common Lisp. An untangled system takes advantage from the flexibility of code order of a language to rely less on tangling tools.
Hackathon this week 7-8 febuary
Hi everyone,
Thank you so much for the good vibe 😁
Here is the current list of tasks, i will update if there is new tasks, chat created. I will do my best to relay informations. So don’t be afraid to add news ideas 😁
Got a idea ? Write it up in comment 😍👍
As you know, we purposed you an hackathon for the fediverse. Two days is short, you may not have free time. Its goal is not speed up development and create lousy code and documentation. No.
The main idea is to form some team and contribute together on some project at the beginning of each month : wiki, translation, documentation, coding…
I hope that it will turn out as a recurring event later. 😁
Why ? I believe it will attract new users, contributors to the fediverse, and i hope news people will join us…and make free software shine. I believe in free software, i believe its 4 freedoms can improve our democracy and protect users rights.
Let’s go back to the hackathon. Some may prefer a slow spaced development, they are right, it is a rock solid development. Its goal is not to replace its current development. we want to invite new people being part of the fediverse, guide them, explain them how they can contribute and slowly being part of the free software movement.
There is plenty way to contribute and i hope it will invite news contributors if we organize a recurring event. 😁
The fediverse is organic and follow your need. So don’t be afraid to voice your need, report bug, create poster…
so, maybe you will join us ? Is there something you want to do ? :)
Source: https://www.arthurperret.fr/veille/2026-02-04-pandoc-dans-le-navigateur.html (Pandoc dans le navigateur)
- https://github.com/jgm/pandoc/releases/tag/3.9 (2026-02-04, Starting with this release, pandoc can be compiled to WASM, making it
possible to use pandoc in the browser. A full-featured GUI interface is provided at https://pandoc.org/app)
Pandoc est désormais utilisable via une application web officielle.
Attention, cliquer sur le lien ci-dessus implique de charger 50 Mo de données : normal, puisque la page contient tout Pandoc !
On parle ici d’un fantastique convertisseur de fichiers, que j’utilise personnellement pour rédiger confortablement tout mon travail dans un format texte adapté à mes besoins d’écriture scientifique et ensuite exporter mes fichiers dans différents formats (HTML, PDF via LaTeX, ODT, docx, EPUB…).
Pandoc s’utilise normalement en ligne de commande, un environnement qui fait parfois peur aux néophytes (ce qui m’avait motivé à écrire un tutoriel sur la découverte du terminal).
Ici, on a une interface web, réalisée grâce au format WebAssembly, donc zéro installation requise, mais aussi des exemples pré-chargés, et la garantie que rien ne s’échappe vers un serveur puisque la conversion se passe en local.
Voilà qui pourrait faciliter la découverte de Pandoc, pourquoi pas conjointement avec un guide comme celui de Christophe Masutti (https://libruniv-c29483.frama.io/)
-->--
#documentation #pandoc #webassembly #html #pdf #latex #odt #wasm
Source: https://www.arthurperret.fr/veille/2026-02-04-pandoc-dans-le-navigateur.html (Pandoc dans le navigateur)
- https://github.com/jgm/pandoc/releases/tag/3.9 (2026-02-04, Starting with this release, pandoc can be compiled to WASM, making it
possible to use pandoc in the browser. A full-featured GUI interface is provided at https://pandoc.org/app)
Pandoc est désormais utilisable via une application web officielle.
Attention, cliquer sur le lien ci-dessus implique de charger 50 Mo de données : normal, puisque la page contient tout Pandoc !
On parle ici d’un fantastique convertisseur de fichiers, que j’utilise personnellement pour rédiger confortablement tout mon travail dans un format texte adapté à mes besoins d’écriture scientifique et ensuite exporter mes fichiers dans différents formats (HTML, PDF via LaTeX, ODT, docx, EPUB…).
Pandoc s’utilise normalement en ligne de commande, un environnement qui fait parfois peur aux néophytes (ce qui m’avait motivé à écrire un tutoriel sur la découverte du terminal).
Ici, on a une interface web, réalisée grâce au format WebAssembly, donc zéro installation requise, mais aussi des exemples pré-chargés, et la garantie que rien ne s’échappe vers un serveur puisque la conversion se passe en local.
Voilà qui pourrait faciliter la découverte de Pandoc, pourquoi pas conjointement avec un guide comme celui de Christophe Masutti (https://libruniv-c29483.frama.io/)
-->--
#documentation #pandoc #webassembly #html #pdf #latex #odt #wasm
Le réseau Médici (Métiers de l'édition scientifique publique) publie sur son site un entretien avec @arthurperret
Il y parle d'édition savante à l'ère du numérique, de l'articulation entre documentation et édition et de ses projets de recherche.
Merci à lui !
#SHS #edition #documentation #numerique
https://fosdem.org/2026/schedule/track/tool-the-docs/
--<--
The Tool The Docs devroom focuses on showcasing and advancing free and open-source tools that support the writing, management, testing, rendering, and publishing of documentation.
Documentation is essential for the success of any FOSS project.
This year (2026), we aim to continue supporting the community by connecting contributors with tools that help create clearer, more effective documentation.
In addition to talks about documentation tooling itself, we also welcome sessions that explore adjacent areas, including:
How documentation needs to evolve to take full advantage of Generative AI (GenAI) developments;
The principles behind creating technical content, such as understanding key documentation types and their problem-solving roles;
Information architecture principles for open-source projects.
# Why Present
FOSDEM is one of the world’s largest gatherings of free and open-source contributors, held annually in Brussels, Belgium, at the ULB Campus Solbosch.
Presenting in the Tool The Docs devroom is a unique opportunity to share new ideas, tools, and best practices with a highly technical audience from a wide range of FOSS communities.
We’re looking for talks that cover:
Tools for writing and the principles of effective communication for technical audiences;
Tools for managing documentation;
Tools and methods for testing documentation quality and accuracy;
Tools for automating documentation workflows;
Tools for rendering and publishing documentation;
Open AI tools (as defined by opensource.org/ai) that enhance any of the above areas;
How documentation and discoverability are changing due to large language models (LLMs) and how they reshape how people find and use documentation on the web.
We welcome proposals from those who create, maintain, or work with documentation tools. First-time speakers are welcome!
Please note that product pitches are not allowed at FOSDEM.
Talks should reflect the open-source ethos and contribute to the shared learning of the community.
-->--
https://fosdem.org/2026/schedule/track/tool-the-docs/
--<--
The Tool The Docs devroom focuses on showcasing and advancing free and open-source tools that support the writing, management, testing, rendering, and publishing of documentation.
Documentation is essential for the success of any FOSS project.
This year (2026), we aim to continue supporting the community by connecting contributors with tools that help create clearer, more effective documentation.
In addition to talks about documentation tooling itself, we also welcome sessions that explore adjacent areas, including:
How documentation needs to evolve to take full advantage of Generative AI (GenAI) developments;
The principles behind creating technical content, such as understanding key documentation types and their problem-solving roles;
Information architecture principles for open-source projects.
# Why Present
FOSDEM is one of the world’s largest gatherings of free and open-source contributors, held annually in Brussels, Belgium, at the ULB Campus Solbosch.
Presenting in the Tool The Docs devroom is a unique opportunity to share new ideas, tools, and best practices with a highly technical audience from a wide range of FOSS communities.
We’re looking for talks that cover:
Tools for writing and the principles of effective communication for technical audiences;
Tools for managing documentation;
Tools and methods for testing documentation quality and accuracy;
Tools for automating documentation workflows;
Tools for rendering and publishing documentation;
Open AI tools (as defined by opensource.org/ai) that enhance any of the above areas;
How documentation and discoverability are changing due to large language models (LLMs) and how they reshape how people find and use documentation on the web.
We welcome proposals from those who create, maintain, or work with documentation tools. First-time speakers are welcome!
Please note that product pitches are not allowed at FOSDEM.
Talks should reflect the open-source ethos and contribute to the shared learning of the community.
-->--
On Tuesday night, I successfully defended my #PhD thesis on #dataset #documentation as a leverage point for better speech technologies at #ANU #Cybernetics! 🎉
I have some minor corrections and then I will officially be a #PhD. It's been a long six years!
On Tuesday night, I successfully defended my #PhD thesis on #dataset #documentation as a leverage point for better speech technologies at #ANU #Cybernetics! 🎉
I have some minor corrections and then I will officially be a #PhD. It's been a long six years!
When you read documentation inside emacs, what is your prefered format?
For me it is in this order:
info, man, epub (nov.el), devdocs.
Are there any texinfo pages you don't read in info format because you need images? I think info pages don't contain images even when the source texinfo file has them (happy to be proved wrong).
Right now I am also trying to solve searching through my epub files for information. Best I've found so far was bookmarks+ and maybe citar.
Yet another #documentation format but this one comes from a world of magnets and miracles #rakulang #litterateProgramming. https://coderlegion.com/9768/rakudoc-more-than-just-a-documentation-markup
@SReyCoyrehourcq @raphaellek
@khinsen
![XWIKI
[}
Learn th dina an
Ices of building
practices tion
internal documen
LL . mments
Check link in the co
Written by ¥ Oana Nasliy | Content Writer Specialjs;
How many timeg have You hearq SOmeone say, "Wey document this later Hopefully not
Practice, "later" Usually means never. And that Makes jt one of the most eXpensiye Senten.
doesn't show upon a balance sheet, byt you fee] jt every day: time Wasted Se€arching for al
Coming back, ang the same Mistakes repeated again ang again.
That's Where interna] documentation, Comes jn.
When byijt right, interna] documentation, turns SCattered knowledge into q share
truth. It helps teams move faster ang WOrk smarter instead of relying on tribal k
Messages that disappear into the void,
In this article, we’j| explore whims: .
~~ -](https://social.xwiki.com/system/media_attachments/files/116/125/929/175/167/730/original/6a3ba76c9f624545.png)
