2874f74c81
the rationale behind switching away from SGML/Docbook is the following:
* SGML is hard to edit for humans
* the output is not much prettier
* the toolchain is not well supported and missing from the build
* the build is not hooked into anywhere, no automation
the reason why RST was chosen:
* it allows for a strong structure like Docbook
* the theme from Read The Docs is pretty
* it also supports mobile devices
* sphinx can easily output to PDF and ePUB formats
* RST is plaintext that can be easily edited and diff'd
* RST can be automatically built by ReadTheDocs and the toolchain is
readily available
* the output is also parsed by Github so documentation can be read
straight from GH
the reason why Markdown was not chosen:
* the current strong structure would be hard to replicate
* markdown is not standardized and output varies according to the
implementation
the docs were converted with Pandoc, using the following commands:
mkdir oper-guide
for source in sgml/oper-guide/*.sgml; do
pandoc --toc -s -f docbook -t rst $source -o oper-guide/$(basename $source .sgml).rst
done
cd oper-guide
sphinx-quickstart
git add *.rst make.bat conf.py
git add -f Makefile
git rm -r ../sgml
|
||
|---|---|---|
| .. | ||
| old | ||
| oper-guide | ||
| technical | ||
| account-notify.txt | ||
| away-notify.txt | ||
| challenge.txt | ||
| CIDR.txt | ||
| collision_fnc.txt | ||
| extban.txt | ||
| extended-join.txt | ||
| hooks.txt | ||
| Hybrid-team | ||
| index.txt | ||
| ircd.8 | ||
| ircd.conf.example | ||
| ircd.motd | ||
| logfiles.txt | ||
| Makefile.in | ||
| modeg.txt | ||
| modes.txt | ||
| monitor.txt | ||
| operguide.txt | ||
| opermyth.txt | ||
| Ratbox-team | ||
| README.cidr_bans | ||
| reference.conf | ||
| sasl.txt | ||
| server-version-info | ||
| services.txt | ||
| Tao-of-IRC.940110 | ||
| tgchange.txt | ||
$Id: README.cidr_bans 6 2005-09-10 01:02:21Z nenolod $ Basically what this patch does is allow for users to use cidr masks when setting bans, exceptions, and invite invex(modes beI respectively). This works for both IPv4 and IPv6 addresses. I won't go into details of how cidr works here, but to use them, you could do something like: /mode #foo +b *!*@10.0.0.0/8 /mode #foo +e *!*@10.0.10.0/24 Aaron Sethman <androsyn@ratbox.org> August 06, 2002