IndexEntrySee()
(mPDF ≥ 2.2)
IndexEntrySee – Insert a cross-reference entry for the document Index
Description
void IndexEntrySee ( string $content , string $see_content )
Insert a cross-reference entry for the document Index i.e. “Dromedary - see Camel”.
Note: The Index must be generated explicity at the end of the document using CreateIndex() at some point before Output() is called.
Parameters
- $content
-
This parameter sets the text as it will appear in the Index entry. Text should be UTF-8 encoded. Text entries passed in the form
Subject:Subcategorywill appear in the Index as “Subject, Subcategory”.REQUIRED
- $see_content
-
This parameter sets the text used as the cross-reference. Text should be UTF-8 encoded. Text entries passed in the form
Subject:Subcategorywill appear in the Index as “Subject, Subcategory”REQUIRED
Examples
<?php
$mpdf->IndexEntry("Dromedary", "Camel:types");
This will produce an entry in the Index under ‘Dromedary’ appearing as:
Dromedary - see Camel, types
See Also
- IndexEntry() - Mark an Index entry in the document
- <indexentry> - Mark an Index entry in the document
- CreateIndex() - Generate a document Index
