Formatting docu files

infra/ApplicationInfrastructure.md

@@ -6,8 +6,8 @@ see the [proofing](../proof/index.html) and [grammarchecker](../proof/gramcheck/
 pages.
 
 
-# Spellers
-## Compile spellers
+## Spellers
+### Compile spellers
 * [Building Spelling Checkers](infraremake/BuildingSpellingCheckers.html)
 * [How to configure and optimise spellers](infraremake/HowToConfigureAndOptimiseSpellers.html)
 * [Building and using a weighted speller](infraremake/BuildingAndUsingAWeightedSpeller.html) (in Norwegian)
@@ -18,15 +18,15 @@ pages.
 * [Hunspell howto](hunspell.html)
 
 
-## CompilingLibreoffice Voikko extension
+### CompilingLibreoffice Voikko extension
 * [Preparations and final steps](BuildingTheVoikkoExtensionForLibreOffice.html)
 * [Building hfst-ospell for inclusion in Voikko](BuildingHfst-ospellForInclusionInVoikko.html)
 * [Building Voikko as a Static Universal Binary](BuildLibvoikkoAsUniversalBinary.html)
 * [Build a release version of Voikko+hfst oxt](BuildEverythingForVoikkoLOForRelease.html)
 * [LO-Voikko libraries](LibreOfficeVoikkoLibraries.html" label)
 
 
-# Grammarcheckers
+## Grammarcheckers
 
 
 Some documentation is found on Divvun's github page.

infra/BuildEverythingForVoikkoLOForRelease.md

@@ -1,3 +1,6 @@
+# Build everything for voikko LO for release
+
+
 This document describes how to build everything you need to create the
 **LibreOffice Voikko oxt** extension with Hfst support
 *for distribution and final delivery*. The document is intended for the
@@ -39,7 +42,7 @@ The basic requirements are:
 * build static libraries that can be linked in with the final oxt
 
 
-# Libarchive
+## Libarchive
 
 
 * download [https://github.com/libarchive/libarchive/archive/master.zip]
@@ -102,7 +105,7 @@ sudo make install
 ```
 
 
-# TinyXML2
+## TinyXML2
 
 
 [Download TinyXML2](https://github.com/leethomason/tinyxml2/archive/master.zip).
@@ -116,7 +119,7 @@ sudo make install
 ```
 
 
-# Hfst-Ospell
+## Hfst-Ospell
 
 
 These are the `configure` and `make` commands needed to build
@@ -157,7 +160,7 @@ sudo make install
 ```
 
 
-# VislCG3
+## VislCG3
 
 
 These are the configure and build instructions for `vislcg3`.
@@ -184,7 +187,7 @@ Comments:
   libraries is unknown (ie we don't know how much of `icu` is needed)
 
 
-# Libvoikko
+## Libvoikko
 
 
 The libvoikko config and build instructions follow the same patterns as above:
@@ -216,7 +219,7 @@ sudo make install
 ```
 
 
-# LibreOffice
+## LibreOffice
 
 
 Finally the last step - building the actual oxt! First, extract only the i386
@@ -316,7 +319,7 @@ With the new oxt available, test it on a couple of machines:
 Now the new oxt is available as a template for language-specific oxt's.
 
 
-## Universal binary OXT
+### Universal binary OXT
 
 
 To build the OXT as a universal binary, you first have to build a 64-bit

infra/BuildLibvoikkoGrammarCheckerForMacosx10.9.md

@@ -1,3 +1,5 @@
+# Build Libvoikko gramamrchecker for Macos 10.9
+
 Vegen frå enkeltkomponentar fram til Voikko-tillegg for MacOSX 10.9.
 
 
@@ -14,13 +16,13 @@ All but the last one should be built as a universal binary. The last one will
 automatically only be built for the i386 architecture.
 
 
-# Dynamically linked - only local computer
+## Dynamically linked - only local computer
 
 
 Use latest available source of everything.
 
 
-## libarchive with only zlib support
+### libarchive with only zlib support
 
 
 ```
@@ -41,7 +43,7 @@ make CXXFLAGS=" -arch i386 -arch x86_64" \
 ```
 
 
-## tinyxml2++
+### tinyxml2++
 
 
 ```
@@ -50,7 +52,7 @@ make
 ```
 
 
-## hfst-ospell
+### hfst-ospell
 
 
 ```
@@ -72,7 +74,7 @@ make CFLAGS="-I/usr/local/include -L/usr/local/lib -arch i386 -arch x86_64" \
 ```
 
 
-## vislcg3
+### vislcg3
 
 
 ```
@@ -84,7 +86,7 @@ make -j3
 (many warnings, no errors)
 
 
-## Libvoikko
+### Libvoikko
 
 
 ```
@@ -110,7 +112,7 @@ make CXXFLAGS=" -arch i386 -arch x86_64" \
 ```
 
 
-## voikko-libreoffice
+### voikko-libreoffice
 
 
 Edit the Makefile as follows, lines 242-243:
@@ -129,18 +131,18 @@ Now you have the oxt. All you need now is the grammar checker source files in
 the correct location:
 
 
-## Grammar checker files
+### Grammar checker files
 
 
 Installation is manual for now. Here are the steps:
 
 
-# `cd $GTHOME/langs/sme`
-# `mkdir -p ~/.voikko/4/se-x-standard/`
-# `cp -f src/analyser-gt-desc.hfst                  ~/.voikko/4/se-x-standard`
-# `cp -f tools/grammarcheckers/errors.xml           ~/.voikko/4/se-x-standard`
-# `cp -f tools/grammarcheckers/gramchk.bin          ~/.voikko/4/se-x-standard`
-# `cp -f tools/spellcheckers/fstbased/hfst/se.zhfst ~/.voikko/4/se-x-standard`
+## `cd $GTHOME/langs/sme`
+## `mkdir -p ~/.voikko/4/se-x-standard/`
+## `cp -f src/analyser-gt-desc.hfst                  ~/.voikko/4/se-x-standard`
+## `cp -f tools/grammarcheckers/errors.xml           ~/.voikko/4/se-x-standard`
+## `cp -f tools/grammarcheckers/gramchk.bin          ~/.voikko/4/se-x-standard`
+## `cp -f tools/spellcheckers/fstbased/hfst/se.zhfst ~/.voikko/4/se-x-standard`
 
 
 Remove ref and example elements from the copied `errors.xml`.
@@ -150,7 +152,7 @@ Install the oxt in LibreOffice, open a new document and type some North Sámi
 text, and see the blue lines across the page!
 
 
-# Statically linked - for distribution
+## Statically linked - for distribution
 
 
 TBW.

infra/BuildingHfst-ospellForInclusionInVoikko.md

@@ -1,16 +1,18 @@
+# Building hfst-ospell for inclusion in Voikko
+
 If you want to build hfst-ospell for inclusion in libvoikko (for further inclusions in the different packages of Voikko, like the LibreOffice-Voikko extension) the MacOSX systems, you should build your binary as a universal binary, and most likely as a *static* universal binary (required at least for the LibreOffice-Voikko extension). The MacOSX Voikko system speller should only need the dynamic libraries.
 
 
 You also need to ensure backwards compatibility, which means that you most likely will have to build on a system with the minimum OS version you want to support. Apple's SDK's are mostly not backwards compatible, but usually forward compatible.
 
 
-# Build hfst-ospell as a universal binary
+## Build hfst-ospell as a universal binary
 
 
 Configure and make `hfst-ospell` using the following options (the text is linewrapped here for readability, all commands should be on one line). Choose the description suitable for your OS version:
 
 
-## Snow Leopard or earlier(?) (≤ 10.6) build
+### Snow Leopard or earlier(?) (≤ 10.6) build
 
 
 OSX 10.6 and earlier require newer versions of `automake` and `autoconf` than provided by the system. Ensure you have MacPorts installed, then do the following:
@@ -32,7 +34,7 @@ To reduce the number of dependencies, we build libarchive with as few dependenci
 
 ```
 ./build/autogen.sh
-# If the previous step fails, try:
+## If the previous step fails, try:
 autoreconf -i -v
 ./configure --without-xml2 --without-nettle --without-bz2lib --without-lzo2 --without-lzma --without-iconv
 make
@@ -74,12 +76,12 @@ with a more complex configuration, to get proper support for x386:
 
 
 ```
-# If you have run make before, run make distclean just to ensure you
-# start from scratch:
+## If you have run make before, run make distclean just to ensure you
+## start from scratch:
 make distclean
 
 
-# HFST-ospell, working univ. binary config:
+## HFST-ospell, working univ. binary config:
 CPATH=/opt/local/include:/usr/local/include:/usr/include \
 	./configure --enable-zhfst --enable-xml=tinyxml2 \
 	CXXFLAGS=" -arch i386 -arch x86_64 -I/opt/local/include" \
@@ -94,14 +96,14 @@ CPATH=/opt/local/include:/usr/local/include:/usr/include \
 	--disable-shared
 
 
-# HFST-ospell, working univ. binary make:
+## HFST-ospell, working univ. binary make:
 make CFLAGS="-I/usr/local/include -L/usr/local/lib -isysroot /Developer/SDKs/MacOSX10.5.sdk \
 	-arch i386 -arch x86_64 -mmacosx-version-min=10.5" \
 	LINK="gcc -framework CoreFoundation -framework Cocoa -arch i386 -arch x86_64" \
 	LDFLAGS="-framework CoreFoundation -framework Cocoa"
 
 
-# Finaly, install the binaries:
+## Finaly, install the binaries:
 sudo make install CFLAGS="-I/usr/local/include -L/usr/local/lib -isysroot \
 	/Developer/SDKs/MacOSX10.5.sdk -arch i386 -arch x86_64 -mmacosx-version-min=10.5" \
 	LINK="gcc -framework CoreFoundation -framework Cocoa -arch i386 -arch x86_64" \
@@ -112,7 +114,7 @@ sudo make install CFLAGS="-I/usr/local/include -L/usr/local/lib -isysroot \
 It is possible that these can be simplified a bit, but at least they work. Please note that `--disable-dependency-tracking` is **required** when configuring for a universal binary!
 
 
-## Lion (= 10.7) build
+### Lion (= 10.7) build
 
 
 The XCode development tool, libraries etc was moved in Lion, thus the SDK path has to be changed for the build to work. In addition, the lowest OS version supported is 10.6. The updated configure command looks like the following:
@@ -136,7 +138,7 @@ CPATH=/opt/local/include:/usr/local/include:/usr/include ./configure --enable-zh
 Similar changes need to be made to the make command.
 
 
-## Mountain Lion (= 10.8) build
+### Mountain Lion (= 10.8) build
 
 
 There are stricter rules for building static libraries under 10.8: minimum system version must be 10.7, and no static linking of core libraries. The updated configure command looks like the following:
@@ -160,7 +162,7 @@ CPATH=/opt/local/include:/usr/local/include:/usr/include ./configure --enable-zh
 Similar changes need to be made to the make command.
 
 
-## Maverick / 10.9 build
+### Maverick / 10.9 build
 
 
 By default, only backwards compatible with 10.8. The following is for dynamic libs only. Configuration:
@@ -183,7 +185,7 @@ Make:
 ```
 
 
-# Build hfst-ospell as a STATIC universal binary
+## Build hfst-ospell as a STATIC universal binary
 
 
 If you want to build `hfst-ospell` as a **static** library (e.g. as part of another component made for external distribution), there are a couple of changes. First, copy the following files to a separate dir (I have used `/Users/USERNAME/alibs/`):

infra/BuildingHfstVoikkoForLibreOfficeOnTiger.md

@@ -1,21 +1,26 @@
-# Tools
+# Building HfstVoikko for LibreOffice on Tiger
 
+Tiger is quite old...
 
-# Install XCode (download [from
-  Apple|https://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wa/getSoftware?bundleID=19907]
+
+## Tools
+
+
+1. Install XCode (download [from
+   Apple|https://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wa/getSoftware?bundleID=19907]
   - free membership required)
-# Install [Macports](http://macports.org/) (select the precompiled Tiger binary/dmg)
-# Install the svn binary package from 
-  [http://svnbinaries.open.collab.net/files/documents/153/2715/file_2715.dat/Subversion%201.6.6%20Universal.dmg] (available on the page [http://svnbinaries.open.collab.net/servlets/ProjectDocumentList?folderID=164&expandFolder=164&folderID=171])
-# Install the git binary package for Tiger from
-  [http://metastatic.org/source/git-osx.html]
+1. Install [Macports](http://macports.org/) (select the precompiled Tiger binary/dmg)
+1. Install the svn binary package from 
+   [http://svnbinaries.open.collab.net/files/documents/153/2715/file_2715.dat/Subversion%201.6.6%20Universal.dmg] (available on the page [http://svnbinaries.open.collab.net/servlets/ProjectDocumentList?folderID=164&expandFolder=164&folderID=171])
+1. Install the git binary package for Tiger from
+   [http://metastatic.org/source/git-osx.html]
 
 
 Remember to update your `$PATH` as stated in the README for the Git and
 Subversion packages.
 
 
-# Prerequisites
+## Prerequisites
 
 
 Then use MacPorts to install the following requirements.
@@ -47,7 +52,7 @@ libz.a
 ```
 
 
-# Hfst-ospell
+## Hfst-ospell
 
 
 Check out the hfst-ospell code and cd into the hfst-ospell dir:
@@ -97,7 +102,7 @@ cp .libs/libhfstospell.a ../alibs/
 
 
 
-# Libvoikko
+## Libvoikko
 
 
 Check out the source code, cd into it, and prepare configuration:
@@ -133,7 +138,7 @@ sudo make install
 ```
 
 
-# LibreOffice Voikko Plugin
+## LibreOffice Voikko Plugin
 
 
 Follow the instructions to set up the [LibreOffice SDK](http://www.libreoffice.org/download).

infra/BuildingMacVoikko.md

@@ -1,3 +1,6 @@
+# Building MacVoikko
+
+
 ```
 $ git clone --recursive https://github.com/divvun/MacVoikko.git
 $ cd MacVoikko