#include "Identifier.h"

Include dependency graph for HelpText.h:

This graph shows which files directly or indirectly include this file:

Typedefs
using	URLString = TaggedIdentifier< URLStringTag >
	Distinct type for URLs. More...

Functions
WX_INIT_API wxString	HelpText (const wxString &Key)

WX_INIT_API TranslatableString	TitleText (const wxString &Key)

WX_INIT_API const wxString	VerCheckArgs ()

WX_INIT_API const URLString	VerCheckUrl ()

WX_INIT_API const wxString	VerCheckHtml ()

WX_INIT_API wxString	FormatHtmlText (const wxString &Text)

Typedef Documentation

◆ URLString

using URLString = TaggedIdentifier< URLStringTag >

Distinct type for URLs.

Definition at line 20 of file HelpText.h.

Function Documentation

◆ FormatHtmlText()

WX_INIT_API wxString FormatHtmlText ( const wxString & Text )

Definition at line 349 of file HelpText.cpp.

                                                {
 
   wxString localeStr = wxLocale::GetSystemEncodingName();
 
   return 
      wxT("<html><head><META http-equiv=\"Content-Type\" content=\"text/html; charset=") +
      localeStr +
      wxT("\"></head>") +
      WrapText( LinkExpand( Text ))+
      wxT("</html>");
}

References LinkExpand(), WrapText(), and wxT().

Referenced by AboutDialog::PopulateAudacityPage(), AboutDialog::PopulateInformationPage(), and AboutDialog::PopulateLicensePage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HelpText()

WX_INIT_API wxString HelpText ( const wxString & Key )

Definition at line 329 of file HelpText.cpp.

{
 
   // Possible future enhancement...
   // We could look for the text as a local file and use
   // that if we find it...
   // if( wxFileExists( Path+Key ) )
   // ...
 
   wxString Text;
   Text = HelpTextBuiltIn( Key );
 
   if( !Text.empty())
      return LinkExpand( Text );
 
   // Perhaps useful for debugging - we'll return key that we didn't find.
   return WrapText( Key );
}

References HelpTextBuiltIn(), LinkExpand(), and WrapText().

Referenced by ErrorDialog::OnHelp(), ErrorReportDialog::OnHelp(), LinkingHtmlWindow::OnLinkClicked(), SplashDialog::Populate(), SplashDialog::Show2(), and HelpSystem::ShowHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TitleText()

WX_INIT_API TranslatableString TitleText ( const wxString & Key )

Definition at line 149 of file HelpText.cpp.

{
   if(Key==wxT("welcome"))
   {
      return XO("Welcome!");
   }
 
   if(Key ==wxT("play") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Playing Audio");
   }
   if((Key ==wxT("record") ) || (Key ==wxT("norecord") ))
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Recording Audio");
   }
   if(Key ==wxT("inputdevice") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Recording - Choosing the Recording Device");
   }
   if(Key ==wxT("inputsource") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Recording - Choosing the Recording Source");
   }
   if(Key ==wxT("inputlevel") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Recording - Setting the Recording Level");
   }
   if((Key ==wxT("edit") ) || (Key==wxT("grey")))
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Editing and greyed out Menus");
   }
   if(Key ==wxT("export") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Exporting an Audio File");
   }
   if(Key ==wxT("save") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Saving an Audacity Project");
   }
   if(Key ==wxT("wma-proprietary") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Support for Other Formats");
   }
   if(Key ==wxT("burncd") )
   {
      /* i18n-hint: Title for a topic.*/
      return XO("Burn to CD" );
   }
   if(Key ==  wxT("remotehelp") )
   {
      return XO("No Local Help");
   }
   // Uh oh, no translation...
   return Verbatim( Key );
}

References Verbatim(), wxT(), and XO().

Referenced by ErrorDialog::OnHelp(), ErrorReportDialog::OnHelp(), and LinkingHtmlWindow::OnLinkClicked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VerCheckArgs()

WX_INIT_API const wxString VerCheckArgs ( )

Definition at line 362 of file HelpText.cpp.

                             {
   wxString result = wxString("from_ver=") + AUDACITY_VERSION_STRING;
#ifdef REV_LONG
   result += wxString("&CommitId=")+wxString(REV_LONG).Left(6);
#endif
   result += wxString("&Time=") + wxString( __DATE__ ) + wxString( __TIME__ );
   result.Replace(" ","");
   return result;
}

Referenced by VerCheckUrl().

Here is the caller graph for this function:

◆ VerCheckHtml()

WX_INIT_API const wxString VerCheckHtml ( )

Definition at line 373 of file HelpText.cpp.

{
   wxStringOutputStream o;
   wxTextOutputStream s(o);
   s
      << "<center>[["
      << VerCheckUrl().GET()
      << "|"
      << XO("Check Online")
      << "]]</center>\n";
   return o.GetString();
}

References Identifier::GET(), VerCheckUrl(), and XO().

Referenced by HelpTextBuiltIn(), and AboutDialog::PopulateInformationPage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VerCheckUrl()

WX_INIT_API const URLString VerCheckUrl ( )

Definition at line 387 of file HelpText.cpp.

{
   //The version we intend to use for live Audacity.
#define VER_CHECK_URL "https://www.audacityteam.org/download/?"
//For testing of our scriptlet.
//#define VER_CHECK_URL "http://www.audacityteam.org/slug/?"
//For testing locally
//#define VER_CHECK_URL "http://localhost:63342/WorkingDocs/demos/download.html?"
 
   return wxString( wxT(VER_CHECK_URL)) +VerCheckArgs();
}

References VER_CHECK_URL, VerCheckArgs(), and wxT().

Referenced by VerCheckHtml().

Here is the call graph for this function:

Here is the caller graph for this function:

Typedefs

Functions

Typedef Documentation

◆ URLString

Function Documentation

◆ FormatHtmlText()

◆ HelpText()

◆ TitleText()

◆ VerCheckArgs()

◆ VerCheckHtml()

◆ VerCheckUrl()