Table Tooltip Text - warwickfoster/qurantools GitHub Wiki

This table contains text for tooltips displayed in the system, providing concise explanations of features or data points. It enhances the user interface by offering quick and context-sensitive help.

Analysis of the tooltip-text Table

Below is the detailed analysis and description of each field in the tooltip-text table, with the table name included as a left-hand column.

Table Name Field Name Description
tooltip-text ID A unique identifier for each tooltip, serving as the primary key for indexing and referencing.
tooltip-text NAME A short, descriptive name for the tooltip, often corresponding to a specific feature or functionality within the Qur’an Gateway application.
tooltip-text TITLE TEXT The title of the tooltip, providing a concise summary of its purpose or the associated feature.
tooltip-text BODY TEXT The detailed text of the tooltip, explaining the feature or functionality in greater detail, often including HTML elements for formatting or linking to additional resources.

Key Insights

  1. Field Relationships:

    • ID uniquely identifies each tooltip, ensuring consistency across different parts of the application.
    • NAME provides a functional or contextual label for the tooltip, linking it to a specific feature.

  2. Text Content:

    • TITLE TEXT serves as the headline or summary of the tooltip, giving users immediate clarity about its purpose.
    • BODY TEXT provides additional information or guidance, often enhanced with HTML for interactivity, such as links to related features or settings.

  3. Applications:

    • Tooltips enhance user experience by offering contextual help, guiding users through complex features without requiring external documentation.
    • The BODY TEXT field supports dynamic updates to include new features or resources.

Example Interpretation of Data:

  • Row 1:

    • ID: 1
    • NAME: BOOKMARK
    • TITLE TEXT: Bookmark
    • BODY TEXT: Save this selection of verses as a bookmark, so you can easily access it again.
    • Represents a tooltip that explains how to use the bookmarking feature within the application.

  • Row 4:

    • ID: 4
    • NAME: FORMULAE
    • TITLE TEXT: Formulaic Analysis Options
    • BODY TEXT: Qur&rsquo;an Gateway can highlight any phrase in the currently selected text that are part of a <i>formula</i>...
    • Guides users on how to analyze formulaic patterns in Quranic text, with links to related features.

Contextual Significance:

  1. User Assistance:
    • The tooltip-text table serves as a dynamic help system embedded directly into the application, reducing the need for external documentation.
  2. Interactivity:
    • HTML elements in the BODY TEXT field allow for enhanced interactivity, such as linking users to specific settings or advanced features.
  3. Ease of Maintenance:
    • By centralizing tooltip content in a database table, updates and additions to tooltips can be managed efficiently without modifying application code.

First 10 Rows Example

ID NAME TITLE TEXT BODY TEXT
1 BOOKMARK Bookmark Save this selection of verses as a bookmark, so you can easily access it again.
2 COPYREF Copy References Copy this selection of verses to the clipboard as a list of references.
3 ANALYSE Analyse Verses You can count (or chart) the different words found, and even the number of each Arabic letter used in this selection of verses.
4 FORMULAE Formulaic Analysis Options Qur’an Gateway can highlight any phrase in the currently selected text that are part of a formula (a portion of text that is repeated multiple times in the Qur’an). You can browse a list of every formula in the Qur’an or chart their frequency across the entire text.
5 CHANGES_PERMANENT Scribal Change Word Underlining You have turned underlining of words effected by scribal changes permanently on. You can change this in Preferences.
6 CHANGES_OFF Scribal Change Word Underlining Click to underline any words affected by scribal changes. (Qur’an Gateway has a database of thousands of manuscript changes which you can browse, or search for to see them within the text itself).
7 CHANGES_ON Scribal Change Word Underlining Click to stop underlining any words affected by scribal changes. (Qur’an Gateway has a database of thousands of manuscript changes which you can browse, or search for to see them within the text itself).
8 READER MODE Switch to Reader Mode View your selection of verses as text in three columns (Arabic, transliteration, and translation). Reader Mode is the easiest and most natural way to read the text.
9 PARSE MODE Switch to Parse Mode Break down each verse in your selection into its constituent words, with full linguistic data shown beside each word.
10 EDIT VERSES Edit Verses Click to return to the home page and edit the list of verses you have just looked up.
⚠️ **GitHub.com Fallback** ⚠️