Gtm Body - warwickfoster/qurantools GitHub Wiki

File: app/formulae/sura_formulae_analyse.php

Purpose

This PHP script generates a table that displays information about formulae in the Quran, based on the provided input. The script takes various parameters, including the sura number, formula criteria, and an indicator for whether to show formulae in common between two suras.

Key Features

• Displays a table with suras and their corresponding formulae.
• Identifies internal and external cross-references between formulae.
• Provides a breakdown of formula usage, including the number of formulae, internal and external cross-references, and distribution between Meccan and Medinan suras.
• Displays a message if no formulae match the criteria.

Input Parameters

• SURA: The number of the sura to search.
• FORMULA: Criteria for selecting formulae.
• INCOMMON: Indicator for showing formulae in common between two suras.

Output

• A table with the following columns:
  • Sura Number
  • Formula
  • Internal Cross-References
  • External Cross-References
  • Meccan Cross-References
  • Medinan Cross-References
• Additional messages if no formulae match the criteria.

Usage

The script can be used by accessing the following URL:

/charts/chart_formulae.php?SURA=[sura_number]&FORMULA=[formula_criteria]&INCOMMON=[indicator]

Example

/charts/chart_formulae.php?SURA=9&FORMULA=tawheed&INCOMMON=no

Additional Notes

• The script uses external JavaScript libraries for tooltip functionality.
• The plural() function is assumed to be defined elsewhere in the code.
• The script includes a footer and header.

Purpose

The purpose of this script is to provide a comprehensive overview of formulae in the Quran, including their distribution, cross-references, and usage within different suras.