close
Sayahna Sayahna
Search

Difference between revisions of "Ithal.sty"


(Package Loading)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{StartEn}}
+
<!--{{StartEn}}-->
 +
 
 
&#129188; [[Sayahna LaTeX Packages|{{LaTeX}} Packages]]
 
&#129188; [[Sayahna LaTeX Packages|{{LaTeX}} Packages]]
  
==Introduction==
+
 
 +
=Introduction=
  
 
We use {{verb|memoir.cls}} as the main document class for all our books and articles that we typeset. Hence, all the main formatting is done by {{verb|memoir}}. The class is available in all standard {{TeX}} distributions and can be downloaded from Comprehensive {{TeX}} Archive Network ({{sc|CTAN}}) from [https://ctan.org/tex-archive/macros/latex/contrib/memoir this link].  It is well documented and therefore, readers are advised to go through the documentation before making use of this package.
 
We use {{verb|memoir.cls}} as the main document class for all our books and articles that we typeset. Hence, all the main formatting is done by {{verb|memoir}}. The class is available in all standard {{TeX}} distributions and can be downloaded from Comprehensive {{TeX}} Archive Network ({{sc|CTAN}}) from [https://ctan.org/tex-archive/macros/latex/contrib/memoir this link].  It is well documented and therefore, readers are advised to go through the documentation before making use of this package.
  
This {{LaTeX}} package which is called {{verb|ithal.sty}} is a subsidiary package that will work in conjunction with {{verb|memoir.cls}} extending its functionality to suit typesetting requirements of Malayalam books.
+
{{verb|ithal.sty}} is a subsidiary {{LaTeX}} package that will work in conjunction with {{verb|memoir.cls}} extending its functionality to meet the typesetting requirements of Malayalam books released by [http://ml.sayahna.org Sayahna Foundation].
 +
 
  
==Package Loading==
+
=Package Loading=
  
 
The package shall be loaded with the command anywhere before {{verb|\begin{document} }}
 
The package shall be loaded with the command anywhere before {{verb|\begin{document} }}
 +
{{small|
 
<syntaxhighlight lang="latex">
 
<syntaxhighlight lang="latex">
 
   \usepackage[<options>]{ithal}
 
   \usepackage[<options>]{ithal}
</syntaxhighlight>  
+
</syntaxhighlight>
 +
}}
  
 
+
=Options=
==Options==
 
  
 
Various options of the package are given below:
 
Various options of the package are given below:
Line 23: Line 27:
 
* {{verb|print}} &mdash; generate output for printing, default is false.
 
* {{verb|print}} &mdash; generate output for printing, default is false.
 
* {{verb|proof}} &mdash; proof mode, allows to have line numbers, watermark and footer instruction for proofers.
 
* {{verb|proof}} &mdash; proof mode, allows to have line numbers, watermark and footer instruction for proofers.
* {{verb|ml}} &mdash;  
+
* {{verb|sphone}} &mdash; generate {{sc|pdf}} output for standard mobile phone with aspect ratio of 16:9.
 +
* {{verb|mini}} &mdash;  generate {{sc|pdf}} output for phone with 5 inch screen size.
 +
* {{verb|kindle}} &mdash; generate {{sc|pdf}} output for older versions of Kindle device.
 +
 
 +
Default is web version {{sc|pdf}} with dimensions of 145mm &times; 195mm, which is fit to read in
 +
tablet or iPad. The print version has the paper width &times; paper height dimensions of 146mm &times; 210mm; sphone version has the dimensions of 80mm &times; 140mm; mini has 62mm &times; 110mm; and lastly kindle has 90mm &times; 122mm.
 +
 +
Various dimensions like paper width/height, inner/outer margins, head/foot heights, marginpar width/sep and various other page dimension parameters can be changed with key-value options provided as arguments of {{verb|\geometry}} command. {{verb|geometry}} package is loaded by default.
 +
 
 +
=Package Dependencies=
 +
 
 +
This package depends on the following {{LaTeX}} packages:
 +
# {{verb|geometry}} &mdash; controls page geometry and various page dimensions.
 +
# {{verb|footmisc}} &mdash; manage and configure footnotes.
 +
# {{verb|multicol}} &mdash; provides to typeset text in columnar mode.
 +
# {{verb|multirow}} &mdash; needed to span tabular cells across rows.
 +
# {{verb|makecell}} &mdash; helps to typeset large chunks of text in a tabular cells and reconfigure its alignment, etc per cell.
 +
# {{verb|ifthen}} &mdash; needed internally to manage booleans.
 +
# {{verb|enumitem}} &mdash; list management features.
 +
# {{verb|ml-draftcopy}} &mdash; add watermarks and other objects in a separate layer in the {{sc|pdf}}.
 +
# {{verb|etoolbox}} &mdash; needed internally to manage certain programming features.
 +
# {{verb|polyglossia}} &mdash; multi-lingual setup.
 +
# {{verb|fontspec}} &mdash; font management for {{sc|utf-8}} fonts.
 +
# {{verb|xltxtra}} &mdash; provides macros for typesetting XeLaTeX and XeTeX logos, etc.
 +
# {{verb|xcolor}} &mdash; color management features.
 +
# {{verb|hyperref}} &mdash; hyperlinking internal and external objects.
 +
# {{verb|xspace}} &mdash; needed internally for macro managements.
  
{{EndEn}}
+
<!--{{EndEn}}-->

Latest revision as of 02:02, 5 January 2018


🢤 LaTeX Packages


Introduction

We use memoir.cls as the main document class for all our books and articles that we typeset. Hence, all the main formatting is done by memoir. The class is available in all standard TeX distributions and can be downloaded from Comprehensive TeX Archive Network (CTAN) from this link. It is well documented and therefore, readers are advised to go through the documentation before making use of this package.

ithal.sty is a subsidiary LaTeX package that will work in conjunction with memoir.cls extending its functionality to meet the typesetting requirements of Malayalam books released by Sayahna Foundation.


Package Loading

The package shall be loaded with the command anywhere before \begin{document}

  \usepackage[<options>]{ithal}

Options

Various options of the package are given below:

  • ml — typeset Malayalam documents.
  • print — generate output for printing, default is false.
  • proof — proof mode, allows to have line numbers, watermark and footer instruction for proofers.
  • sphone — generate pdf output for standard mobile phone with aspect ratio of 16:9.
  • mini — generate pdf output for phone with 5 inch screen size.
  • kindle — generate pdf output for older versions of Kindle device.

Default is web version pdf with dimensions of 145mm × 195mm, which is fit to read in tablet or iPad. The print version has the paper width × paper height dimensions of 146mm × 210mm; sphone version has the dimensions of 80mm × 140mm; mini has 62mm × 110mm; and lastly kindle has 90mm × 122mm.

Various dimensions like paper width/height, inner/outer margins, head/foot heights, marginpar width/sep and various other page dimension parameters can be changed with key-value options provided as arguments of \geometry command. geometry package is loaded by default.

Package Dependencies

This package depends on the following LaTeX packages:

  1. geometry — controls page geometry and various page dimensions.
  2. footmisc — manage and configure footnotes.
  3. multicol — provides to typeset text in columnar mode.
  4. multirow — needed to span tabular cells across rows.
  5. makecell — helps to typeset large chunks of text in a tabular cells and reconfigure its alignment, etc per cell.
  6. ifthen — needed internally to manage booleans.
  7. enumitem — list management features.
  8. ml-draftcopy — add watermarks and other objects in a separate layer in the pdf.
  9. etoolbox — needed internally to manage certain programming features.
  10. polyglossia — multi-lingual setup.
  11. fontspec — font management for utf-8 fonts.
  12. xltxtra — provides macros for typesetting XeLaTeX and XeTeX logos, etc.
  13. xcolor — color management features.
  14. hyperref — hyperlinking internal and external objects.
  15. xspace — needed internally for macro managements.