This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5066

help: splitting the topics by category
ClosedPublic

Authored by rdamazio on Oct 13 2018, 6:19 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG9c6473d2038b: help: splitting the topics by category
Summary

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

rdamazio created this revision.Oct 13 2018, 6:19 AM
rdamazio updated this revision to Diff 12040.Oct 13 2018, 6:44 AM
rdamazio updated this revision to Diff 12061.Oct 13 2018, 8:44 AM
rdamazio updated this revision to Diff 12121.Oct 14 2018, 6:31 AM
Closed by commit rHG9c6473d2038b: help: splitting the topics by category (authored by rdamazio). · Explain WhyOct 14 2018, 11:16 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/help.py (57 lines)
Mmercurial/hgweb/webcommands.py (3 lines)

Diff 12121

mercurial/help.py

] ]
# Human-readable category names. These are translated. # Human-readable category names. These are translated.
# Extensions with custom categories should add their names here. # Extensions with custom categories should add their names here.
CATEGORY_NAMES = { CATEGORY_NAMES = {
registrar.command.CATEGORY_NONE: 'Uncategorized commands', registrar.command.CATEGORY_NONE: 'Uncategorized commands',
} }
# Topic categories.
TOPIC_CATEGORY_NONE = 'none'
# The order in which topic categories will be displayed.
# Extensions with custom categories should insert them into this list
# after/before the appropriate item, rather than replacing the list or
# assuming absolute positions.
TOPIC_CATEGORY_ORDER = [
TOPIC_CATEGORY_NONE,
]
# Human-readable topic category names. These are translated.
TOPIC_CATEGORY_NAMES = {
TOPIC_CATEGORY_NONE: 'Uncategorized topics',
}
def listexts(header, exts, indent=1, showdeprecated=False): def listexts(header, exts, indent=1, showdeprecated=False):
'''return a text listing of the given extensions''' '''return a text listing of the given extensions'''
rst = [] rst = []
if exts: if exts:
for name, desc in sorted(exts.iteritems()): for name, desc in sorted(exts.iteritems()):
if not showdeprecated and any(w in desc for w in _exclkeywords): if not showdeprecated and any(w in desc for w in _exclkeywords):
continue continue
rst.append('%s:%s: %s\n' % (' ' * indent, name, desc)) rst.append('%s:%s: %s\n' % (' ' * indent, name, desc))
kw = encoding.lower(kw) kw = encoding.lower(kw)
def lowercontains(container): def lowercontains(container):
return kw in encoding.lower(container) # translated in helptable return kw in encoding.lower(container) # translated in helptable
results = {'topics': [], results = {'topics': [],
'commands': [], 'commands': [],
'extensions': [], 'extensions': [],
'extensioncommands': [], 'extensioncommands': [],
} }
for names, header, doc in helptable: for topic in helptable:
names, header, doc = topic[0:3]
# Old extensions may use a str as doc. # Old extensions may use a str as doc.
if (sum(map(lowercontains, names)) if (sum(map(lowercontains, names))
or lowercontains(header) or lowercontains(header)
or (callable(doc) and lowercontains(doc(ui)))): or (callable(doc) and lowercontains(doc(ui)))):
results['topics'].append((names[0], header)) results['topics'].append((names[0], header))
for cmd, entry in commands.table.iteritems(): for cmd, entry in commands.table.iteritems():
if len(entry) == 3: if len(entry) == 3:
summary = entry[2] summary = entry[2]
ex = opts.get ex = opts.get
anyopts = (ex(r'keyword') or not (ex(r'command') or ex(r'extension'))) anyopts = (ex(r'keyword') or not (ex(r'command') or ex(r'extension')))
if not name and anyopts: if not name and anyopts:
exts = listexts(_('enabled extensions:'), extensions.enabled()) exts = listexts(_('enabled extensions:'), extensions.enabled())
if exts: if exts:
rst.append('\n') rst.append('\n')
rst.extend(exts) rst.extend(exts)
rst.append(_("\nadditional help topics:\n\n")) rst.append(_("\nadditional help topics:\n"))
topics = [] # Group commands by category.
for names, header, doc in helptable: topiccats = {}
topics.append((names[0], header)) for topic in helptable:
names, header, doc = topic[0:3]
if len(topic) > 3 and topic[3]:
category = topic[3]
else:
category = TOPIC_CATEGORY_NONE
topiccats.setdefault(category, []).append((names[0], header))
# Check that all categories have an order.
missing_order = set(topiccats.keys()) - set(TOPIC_CATEGORY_ORDER)
if missing_order:
ui.develwarn(
'Help categories missing from TOPIC_CATEGORY_ORDER: %s' %
missing_order)
# Output topics per category.
for cat in TOPIC_CATEGORY_ORDER:
topics = topiccats.get(cat, [])
if topics:
if len(topiccats) > 1:
catname = gettext(TOPIC_CATEGORY_NAMES[cat])
rst.append("\n%s:\n" % catname)
rst.append("\n")
for t, desc in topics: for t, desc in topics:
rst.append(" :%s: %s\n" % (t, desc)) rst.append(" :%s: %s\n" % (t, desc))
if ui.quiet: if ui.quiet:
pass pass
elif ui.verbose: elif ui.verbose:
rst.append('\n%s\n' % optrst(_("global options"), rst.append('\n%s\n' % optrst(_("global options"),
commands.globalopts, ui.verbose)) commands.globalopts, ui.verbose))
if name == 'shortlist': if name == 'shortlist':
rst.append(_("\n(use 'hg help' for the full list " rst.append(_("\n(use 'hg help' for the full list "
# Look for sub-topic entry first. # Look for sub-topic entry first.
header, doc = None, None header, doc = None, None
if subtopic and name in subtopics: if subtopic and name in subtopics:
for names, header, doc in subtopics[name]: for names, header, doc in subtopics[name]:
if subtopic in names: if subtopic in names:
break break
if not header: if not header:
for names, header, doc in helptable: for topic in helptable:
names, header, doc = topic[0:3]
if name in names: if name in names:
break break
else: else:
raise error.UnknownCommand(name) raise error.UnknownCommand(name)
rst = [minirst.section(header)] rst = [minirst.section(header)]
# description # description

mercurial/hgweb/webcommands.py

The ``help`` template will be rendered when requesting help for a topic. The ``help`` template will be rendered when requesting help for a topic.
``helptopics`` will be rendered for the index of help topics. ``helptopics`` will be rendered for the index of help topics.
""" """
from .. import commands, help as helpmod # avoid cycle from .. import commands, help as helpmod # avoid cycle
topicname = web.req.qsparams.get('node') topicname = web.req.qsparams.get('node')
if not topicname: if not topicname:
def topics(context): def topics(context):
for entries, summary, _doc in helpmod.helptable: for h in helpmod.helptable:
entries, summary, _doc = h[0:3]
yield {'topic': entries[0], 'summary': summary} yield {'topic': entries[0], 'summary': summary}
early, other = [], [] early, other = [], []
primary = lambda s: s.partition('|')[0] primary = lambda s: s.partition('|')[0]
for c, e in commands.table.iteritems(): for c, e in commands.table.iteritems():
doc = _getdoc(e) doc = _getdoc(e)
if 'DEPRECATED' in doc or c.startswith('debug'): if 'DEPRECATED' in doc or c.startswith('debug'):
continue continue