update docs

Author: alstat

docs/src/assets/custom.css

@@ -60,7 +60,7 @@ div.highlight pre,
 .nohighlight,
 .ansi {
     font-family: 'Kawkab Mono', 'Consolas', 'Monaco', 'Courier New', monospace !important;
-    line-height: 1.8 !important;
+    line-height: 2.0 !important;
     font-size: 12px !important;
 }
 

docs/src/man/rhythmic_analysis.md

@@ -11,60 +11,60 @@ using Yunir
 @transliterator :default
 
 poem = """
-    ألا كُلُّ مَاشِيَةِ الخَيْزَلَى ;
-    فِدَى كلِّ ماشِيَةِ الهَيْذَبَى;
-    وَكُلِّ نَجَاةٍ بُجَاوِيَّةٍ;
-    خَنُوفٍ وَمَا بيَ حُسنُ المِشَى;
-    وَلَكِنّهُنّ حِبَالُ الحَيَاةِ;
-    وَكَيدُ العُداةِ وَمَيْطُ الأذَى;
-    ضرَبْتُ بهَا التّيهَ ضَرْبَ القِمَا;
-    رِ إمّا لهَذا وَإمّا لِذا;
-    إذا فَزِعَتْ قَدّمَتْهَا الجِيَادُ;
-    وَبِيضُ السّيُوفِ وَسُمْرُ القَنَا;
-    فَمَرّتْ بِنَخْلٍ وَفي رَكْبِهَا;
-    عَنِ العَالَمِينَ وَعَنْهُ غِنَى;
-    وَأمْسَتْ تُخَيّرُنَا بِالنّقا;
-    بِ وَادي المِيَاهِ وَوَادي القُرَى;
-    وَقُلْنَا لهَا أينَ أرْضُ العِراقِ;
-    فَقَالَتْ وَنحنُ بِتُرْبَانَ هَا;
-    وَهَبّتْ بِحِسْمَى هُبُوبَ الدَّبُو;
-    رِ مُستَقْبِلاتٍ مَهَبَّ الصَّبَا;
-    رَوَامي الكِفَافِ وَكِبْدِ الوِهَادِ;
-    وَجَارِ البُوَيْرَةِ وَادي الغَضَى;
-    وَجَابَتْ بُسَيْطَةَ جَوْبَ الرِّدَا;
-    ءِ بَينَ النّعَامِ وَبَينَ المَهَا;
-    إلى عُقْدَةِ الجَوْفِ حتى شَفَتْ;
-    بمَاءِ الجُرَاوِيّ بَعضَ الصّدَى;
-    وَلاحَ لهَا صَوَرٌ وَالصّبَاحَ،;
-    وَلاحَ الشَّغُورُ لهَا وَالضّحَى;
-    وَمَسّى الجُمَيْعيَّ دِئْدَاؤهَا;
-    وَغَادَى الأضَارِعَ ثمّ الدَّنَا;
-    فَيَا لَكَ لَيْلاً على أعْكُشٍ;
-    أحَمَّ البِلادِ خَفِيَّ الصُّوَى;
-    وَرَدْنَا الرُّهَيْمَةَ في جَوْزِهِ;
-    وَبَاقيهِ أكْثَرُ مِمّا مَضَى;
-    فَلَمّا أنَخْنَا رَكَزْنَا الرّمَاحَ ;
-    بَين مَكارِمِنَا وَالعُلَى;
-    وَبِتْنَا نُقَبّلُ أسْيَافَنَا;
-    وَنَمْسَحُهَا من دِماءِ العِدَى;
-    لِتَعْلَمَ مِصْرُ وَمَنْ بالعِراقِ;
-    ومَنْ بالعَوَاصِمِ أنّي الفَتى;
-    وَأنّي وَفَيْتُ وَأنّي أبَيْتُ;
-    وَأنّي عَتَوْتُ على مَنْ عَتَا;
-    وَمَا كُلّ مَنْ قَالَ قَوْلاً وَفَى;
-    وَلا كُلُّ مَنْ سِيمَ خَسْفاً أبَى;
-    وَلا بُدَّ للقَلْبِ مِنْ آلَةٍ;
-    وَرَأيٍ يُصَدِّعُ صُمَّ الصّفَا;
-    وَمَنْ يَكُ قَلْبٌ كَقَلْبي لَهُ;
-    يَشُقُّ إلى العِزِّ قَلْبَ التَّوَى;
-    وَكُلُّ طَرِيقٍ أتَاهُ الفَتَى;
-    على قَدَرِ الرِّجْلِ فيه الخُطَى;
-    وَنَام الخُوَيْدِمُ عَنْ لَيْلِنَا;
-    وَقَدْ نامَ قَبْلُ عَمًى لا كَرَى;
-    وَكانَ عَلى قُرْبِنَا بَيْنَنَا;
-    مَهَامِهُ مِنْ جَهْلِهِ وَالعَمَى;
-    وَمَنْ جَهِلَتْ نَفْسُهُ قَدْرَهُ;
-    رَأى غَيرُهُ مِنْهُ مَا لا يَرَى
+    أَلَا كُلُّ مَاشِيَةِ الخَيْزَلَى؛
+    فِدًى كُلِّ مَاشِيَةِ الهَيْذَبَى؛
+    وَكُلِّ نَجَاةٍ بُجَاوِيَّةٍ،
+    خَنُوفٍ وَمَا بِي حُسْنُ المِشَى؛
+    وَلَكِنَّهُنَّ حِبَالُ الحَيَاةِ،
+    وَكَيْدُ العُدَاةِ وَمَيْطُ الأَذَى؛
+    ضَرَبْتُ بِهَا التِّيهَ ضَرْبَ القِمَا
+    رِ إِمَّا لِهَذَا وَإِمَّا لِذَا؛
+    إِذَا فَزِعَتْ قَدَّمَتْهَا الجِيَادُ،
+    وَبِيضُ السُّيُوفِ وَسُمْرُ القَنَا؛
+    فَمَرَّتْ بِنَخْلٍ وَفِي رَكْبِهَا،
+    عَنِ العَالَمِينَ وَعَنْهُ غِنَى؛
+    وَأَمْسَتْ تُخَيِّرُنَا بِالنَّقَا،
+    بِوَادِي المِيَاهِ وَوَادِي القُرَى؛
+    وَقُلْنَا لَهَا أَيْنَ أَرْضُ العِرَاقِ؟
+    فَقَالَتْ وَنَحْنُ بِتُرْبَانَهَا؛
+    وَهَبَّتْ بِحِسْمَى هُبُوبَ الدَّبُو
+    رِ مُسْتَقْبِلَاتٍ مَهَبَّ الصَّبَا؛
+    رَوَامِي الكِفَافِ وَكِبْدِ الوِهَادِ،
+    وَجَارِ البُوَيْرَةِ وَادِي الغَضَى؛
+    وَجَابَتْ بُسَيْطَةَ جَوْبَ الرِّدَا،
+    بَيْنَ النَّعَامِ وَبَيْنَ المَهَا؛
+    إِلَى عُقْدَةِ الجَوْفِ حَتَّى شَفَتْ،
+    بِمَاءِ الجُرَاوِيِّ بَعْضَ الصَّدَى؛
+    وَلَاحَ لَهَا صَوَرٌ وَالصَّبَاحُ،
+    وَلَاحَ الشَّغُورُ لَهَا وَالضُّحَى؛
+    وَمَسَّى الجُمَيْعِيَّ دِئْدَاؤُهَا،
+    وَغَادَى الأَضَارِعَ ثُمَّ الدَّنَا؛
+    فَيَا لَكَ لَيْلًا عَلَى أَعْكُشٍ،
+    أَحَمَّ البِلَادِ خَفِيَّ الصُّوَى؛
+    وَرَدْنَا الرُّهَيْمَةَ فِي جَوْزِهِ،
+    وَبَاقِيهِ أَكْثَرُ مِمَّا مَضَى؛
+    فَلَمَّا أَنَخْنَا رَكَزْنَا الرِّمَاحَ،
+    بَيْنَ مَكَارِمِنَا وَالعُلَى؛
+    وَبِتْنَا نُقَبِّلُ أَسْيَافَنَا،
+    وَنَمْسَحُهَا مِنْ دِمَاءِ العِدَى؛
+    لِتَعْلَمَ مِصْرُ وَمَنْ بِالعِرَاقِ،
+    وَمَنْ بِالعَوَاصِمِ أَنِّي الفَتَى؛
+    وَأَنِّي وَفَيْتُ وَأَنِّي أَبَيْتُ،
+    وَأَنِّي عَتَوْتُ عَلَى مَنْ عَتَا؛
+    وَمَا كُلُّ مَنْ قَالَ قَوْلًا وَفَى،
+    وَلَا كُلُّ مَنْ سِيمَ خَسْفًا أَبَى؛
+    وَلَا بُدَّ لِلْقَلْبِ مِنْ آلَةٍ،
+    وَرَأْيٍ يُصَدِّعُ صُمَّ الصَّفَا؛
+    وَمَنْ يَكُ قَلْبٌ كَقَلْبِي لَهُ،
+    يَشُقُّ إِلَى العِزِّ قَلْبَ التَّوَى؛
+    وَكُلُّ طَرِيقٍ أَتَاهُ الفَتَى،
+    عَلَى قَدَرِ الرِّجْلِ فِيهِ الخُطَى؛
+    وَنَامَ الخُوَيْدِمُ عَنْ لَيْلِنَا،
+    وَقَدْ نَامَ قَبْلُ عَمًى لَا كَرَى؛
+    وَكَانَ عَلَى قُرْبِنَا بَيْنَنَا،
+    مَهَامِهُ مِنْ جَهْلِهِ وَالعَمَى؛
+    وَمَنْ جَهِلَتْ نَفْسُهُ قَدْرَهُ،
+    رَأَى غَيْرُهُ مِنْهُ مَا لَا يَرَى.
 """
 ```
 ## Extracting Syllables
@@ -84,6 +84,8 @@ Then,
 ```@repl abc
 r(string(split(texts[1], " ")[1]), isarabic=true, first_word=true, silent_last_vowel=false)
 ```
+!!! warning "Caution"
+    It is important to note that syllabification works only on a fully diacritize text as in the input poem here, and that is because each syllable contain a vowel. If not fully diacritize, then the syllabification will consider a syllable with only consonant and no vowel.
 
 ## References
 ```@bibliography