upstream/mercurial-mirror Files · mercurial/templates/monoblue/helptopics.tmpl

registrar: add funcregistrar class to register function for specific purpose...

registrar: add funcregistrar class to register function for specific purpose This class centralizes the common logic to register function for specific purpose like below: - template keyword, filter and function - revset predicate - fileset predicate - webcommand 'funcregistrar' also formats help document of the function with the 'decl'(aration) specified at the construction. This can avoid (1) redundancy between 'decl' and help document, and (2) accidental typo of help document. For example, 'foo' should appear twice like below, if without such formatting: @keyword('foo') def foo(....): """:foo: Explanation of keyword foo ...""" Almost all cases needs very simple document formatting like below: - "``DECL``\n EXPLANATION" - ":DECL: EXPLANATION" But webcommand needs a little complicated formatting like: /PATH/SPEC ---------- EXPLANATION .... To make minirst recognize the section header, hyphen line should be as long as "/PATH/SPEC". It should be arranged by program. Implementing 'formatdoc()' in derived class can support complicated formatting in the latter case. But it seems redundant for simple one in the former case. Therefore, 'funcregistrar' does: - invoke 'self.formatdoc', if it is callable (for the latter case) - use it as the format string, otherwise (for the former case)

Gregory Szorc - - Load All Authors

File last commit:

r27580:34c3ea65 default


                r27583:37d50250

default

Download file

             helptopics.tmpl
        
                    52 lines
            
             | 2.1 KiB
            
                | application/x-cheetah
            
             |
                CheetahLexer
            
             / mercurial / templates / monoblue / helptopics.tmpl
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      {header}

        av6
    
hgweb: fix help pages title in gitweb and monoblue...

              r25686
            
          <title>Help: {title}</title>

        Thomas Arendsen Hein
    
hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...

              r18526
            
          <link rel="alternate" type="application/atom+xml" href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>

          <link rel="alternate" type="application/rss+xml" href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      </head>

      <body>

      <div id="container">

          <div class="page-header">

        Angel Ezquerra <angel.ezquerra at gmail.com>
    
hgweb: add a "URL breadcrumb" to the index and repository pages...

              r18258
            
              <h1 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb} / help</h1>

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
        Thomas Arendsen Hein
    
hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...

              r18526
            
              <form action="{url|urlescape}log">

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
                  {sessionvars%hiddenformentry}

                  <dl class="search">

                      <dt><label>Search: </label></dt>

                      <dd><input type="text" name="rev" /></dd>

                  </dl>

              </form>

              <ul class="page-nav">

        Thomas Arendsen Hein
    
hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...

              r18526
            
                  <li><a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a></li>

                  <li><a href="{url|urlescape}shortlog{sessionvars%urlparameter}">shortlog</a></li>

                  <li><a href="{url|urlescape}changelog{sessionvars%urlparameter}">changelog</a></li>

        av6
    
hgweb: don't point graph links at tip hash where it doesn't make sense...

              r25525
            
                  <li><a href="{url|urlescape}graph{sessionvars%urlparameter}">graph</a></li>

        Thomas Arendsen Hein
    
hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...

              r18526
            
                  <li><a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a></li>

                  <li><a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>

        av6
    
monoblue: fix branches link on help topics page

              r25872
            
                  <li><a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a></li>

        av6
    
hgweb: don't point file links at tip hash where it doesn't make sense...

              r25526
            
                  <li><a href="{url|urlescape}file{sessionvars%urlparameter}">files</a></li>

        Gregory Szorc
    
templates: support linking to main help page...

              r27580
            
                  {if(subindex,

                    '<li><a href="{url|urlescape}help{sessionvars%urlparameter}">help</a></li>',

                    '<li class="current">help</li>'

                  )}

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
              </ul>

          </div>

        av6
    
monoblue: fix page subtitle on help pages

              r26151
            
          <h2 class="no-link no-border">help</h2>

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
          <table cellspacing="0">

          <tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>

          {topics % helpentry}

        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
          {if(earlycommands, '

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
          <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>

          {earlycommands % helpentry}

        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
          ')}

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
          {if(othercommands, '

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
          <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>

          {othercommands % helpentry}

        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
          ')}

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
          </table>

      {footer}

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Augie Fackler web: add a help view for getting hg help output	r12666	{header}
av6 hgweb: fix help pages title in gitweb and monoblue...	r25686	<title>Help: {title}</title>
Thomas Arendsen Hein hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...	r18526	<link rel="alternate" type="application/atom+xml" href="{url\|urlescape}atom-log" title="Atom feed for {repo\|escape}"/>
		<link rel="alternate" type="application/rss+xml" href="{url\|urlescape}rss-log" title="RSS feed for {repo\|escape}"/>
Augie Fackler web: add a help view for getting hg help output	r12666	</head>

		<body>
		<div id="container">
		<div class="page-header">
Angel Ezquerra <angel.ezquerra at gmail.com> hgweb: add a "URL breadcrumb" to the index and repository pages...	r18258	<h1 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb} / help</h1>
Augie Fackler web: add a help view for getting hg help output	r12666
Thomas Arendsen Hein hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...	r18526	<form action="{url\|urlescape}log">
Augie Fackler web: add a help view for getting hg help output	r12666	{sessionvars%hiddenformentry}
		<dl class="search">
		<dt><label>Search: </label></dt>
		<dd><input type="text" name="rev" /></dd>
		</dl>
		</form>

		<ul class="page-nav">
Thomas Arendsen Hein hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...	r18526	<li><a href="{url\|urlescape}summary{sessionvars%urlparameter}">summary</a></li>
		<li><a href="{url\|urlescape}shortlog{sessionvars%urlparameter}">shortlog</a></li>
		<li><a href="{url\|urlescape}changelog{sessionvars%urlparameter}">changelog</a></li>
av6 hgweb: don't point graph links at tip hash where it doesn't make sense...	r25525	<li><a href="{url\|urlescape}graph{sessionvars%urlparameter}">graph</a></li>
Thomas Arendsen Hein hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...	r18526	<li><a href="{url\|urlescape}tags{sessionvars%urlparameter}">tags</a></li>
		<li><a href="{url\|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>
av6 monoblue: fix branches link on help topics page	r25872	<li><a href="{url\|urlescape}branches{sessionvars%urlparameter}">branches</a></li>
av6 hgweb: don't point file links at tip hash where it doesn't make sense...	r25526	<li><a href="{url\|urlescape}file{sessionvars%urlparameter}">files</a></li>
Gregory Szorc templates: support linking to main help page...	r27580	{if(subindex,
		'<li><a href="{url\|urlescape}help{sessionvars%urlparameter}">help</a></li>',
		'<li class="current">help</li>'
		)}
Augie Fackler web: add a help view for getting hg help output	r12666	</ul>
		</div>

av6 monoblue: fix page subtitle on help pages	r26151	<h2 class="no-link no-border">help</h2>
Augie Fackler web: add a help view for getting hg help output	r12666	<table cellspacing="0">
		<tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>
		{topics % helpentry}

Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	{if(earlycommands, '
Augie Fackler web: add a help view for getting hg help output	r12666	<tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
		{earlycommands % helpentry}
Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	')}
Augie Fackler web: add a help view for getting hg help output	r12666
Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	{if(othercommands, '
Augie Fackler web: add a help view for getting hg help output	r12666	<tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
		{othercommands % helpentry}
Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	')}
Augie Fackler web: add a help view for getting hg help output	r12666	</table>

		{footer}