README for ض (dad) package, 2014/09/08, v1.0

TABLE OF CONTENTS
=================

1 Introduction
2 Download
3 Installation
4 Additional Packages
5 Package Compatibility
6 Authors/Maintainer
7 Bug Reports
8 Known Problems


1 INTRODUCTION
==============

This LaTeX package allows simple typesetting in Arabic script, intended for mixed Latin-Arabic script usage, in situations where heavy-duty solutions are discouraged.
The ض system operates with both Unicode and transliterated input, allowing the user to choose the most appropriate approach for every situation.

A paper describing the package has been submitted to TUGboat.

This material is subject to the LaTeX Project Public License
(LPPL). See http://www.latex-project.org/lppl.txt for the
details of that license.

2 DOWNLOAD
==========

ض should become available on CTAN soon:
  CTAN:/language/arabic/dad/

The distribution contains the following files:

2.1 FONT FILES AND RELATED FILES
================================
dadbold.ofm
dad.ofm
dadmono.ofm
dadmono.ovf
dadbold.ovf
dad.ovf
Dad-mono.pfb
Dad-bold.pfb
Dad.pfb
Dad.afm
Dad-mono.afm
Dad-bold.afm
dadrealbold.tfm
dadreal.tfm
dadrealmono.tfm
dad.map
dad.sty
OT1dad.fd
T1dad.fd

2.2 DOCUMENTATION
=================
dad-user-guide.pdf
dad-user-guide.tex
dad-user-guide.bib

2.4 PERL SCRIPTS FOR UTF-8 <-> TRANSLITERATION CONVERSION
=========================================================
dad-to-utf8.pl
utf8-to-dad.pl

2.3 FILES USED FOR GENERATING THE FONT METRIC FILES
===================================================
make-dad-font.pl
dadbold.adjust
dad.adjust
dadmono.adjust

3 INSTALLATION
==============

Place the files in directories where TeX can find them.

4 ADDITIONAL PACKAGES
=====================

ض itself does not load other packages.

5 PACKAGE COMPATIBILITY
=======================

To typeset with this package you need lualatex.
To generate the OVF and OFM files from OVP you need wovp2ovf version 
higher or equal than 1.13 (build 34787).

6 AUTHOR/MAINTAINER
=====================

* Author and maintainer of the package:
   Yannis Haralambous

7 BUG REPORTS
==============

A bug report should contain:
* Comprehensive problem description. This includes error or
  warning messages.
* \errorcontextlines=\maxdimen can be added in the
  TeX code to get more information in TeX error messages.
* Minimal test file that shows the problem, but does not
  contain any unnecessary packages and code.
* Used drivers/programs.
* Version information about used packages and programs.
* If you are using LaTeX, then add "\listfiles". Then
  a list of version information is printed at the end
  of the LaTeX run.
* Please no other files than the minimal test file.
  The other files .log, .dvi, .ps, .pdf are seldom
  necessary, so send them only on request.
* Please .zip or .tar.gz your file(s) before sending them!

Bug address
-----------
Bug reports can be sent to the maintainer:
  Yannis Haralambous
  <yannis [dot] haralambous [at] telecom-bretagne [dot] eu>


8 KNOWN PROBLEMS
=================

LuaTeX has a bug which will result in bad typesetting and crashes.
The bug has been reported in July 2014 under the following number:
http://tracker.luatex.org/view.php?id=912&history=1#history
We are still waiting for the LuaTeX team to do something about it...