Function to show help text when initial timeline has no posts in it

webapp_timeline.py

@@ -8,12 +8,15 @@ __status__ = "Production"
 
 import os
 import time
+from shutil import copyfile
+from utils import removeHtml
 from utils import getConfigParam
 from utils import getFullDomain
 from utils import isEditor
 from utils import removeIdEnding
 from follow import followerApprovalActive
 from person import isPersonSnoozed
+from webapp_utils import markdownToHtml
 from webapp_utils import htmlKeyboardNavigation
 from webapp_utils import htmlHideFromScreenReader
 from webapp_utils import htmlPostSeparator
@@ -42,6 +45,36 @@ def _logTimelineTiming(enableTimingLog: bool, timelineStartTime,
               boxName + ' ' + debugId + ' = ' + str(timeDiff))
 
 
+def _getHelpForTimeline(baseDir: str, boxName: str) -> str:
+    """Shows help text for the given timeline
+    """
+    # get the filename for help for this timeline
+    helpFilename = baseDir + '/accounts/help_' + boxName + '.md'
+    if not os.path.isfile(helpFilename):
+        language = \
+            getConfigParam(baseDir, 'language')
+        defaultFilename = \
+            baseDir + '/defaultwelcome/' + \
+            'help_' + boxName + '_' + language + '.md'
+        if not os.path.isfile(defaultFilename):
+            defaultFilename = \
+                baseDir + '/defaultwelcome/help_' + boxName + '_en.md'
+        if os.path.isfile(defaultFilename):
+            copyfile(defaultFilename, helpFilename)
+
+    # show help text
+    if os.path.isfile(helpFilename):
+        instanceTitle = \
+            getConfigParam(baseDir, 'instanceTitle')
+        if not instanceTitle:
+            instanceTitle = 'Epicyon'
+        with open(helpFilename, 'r') as helpFile:
+            helpText = helpFile.read()
+            helpText = helpText.replace('INSTANCE', instanceTitle)
+            return markdownToHtml(removeHtml(helpText))
+    return ''
+
+
 def htmlTimeline(cssCache: {}, defaultTimeline: str,
                  recentPostsCache: {}, maxRecentPosts: int,
                  translate: {}, pageNumber: int,
@@ -698,6 +731,8 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str,
             translate['Page down'] + '"></a>\n' + \
             '      </center>\n'
         tlStr += textModeSeparator
+    elif itemCtr == 0:
+        tlStr += _getHelpForTimeline(baseDir, boxName)
 
     # end of timeline-posts
     tlStr += '  </div>\n'