mirror of
https://github.com/FoggedLens/iD.git
synced 2026-05-09 03:25:37 +02:00
Quincy Morgan
448 lines
14 KiB
JavaScript
448 lines
14 KiB
JavaScript
|
|
import marked from 'marked';
|
|
import { svgIcon } from '../../svg/icon';
|
|
import { uiCmd } from '../cmd';
|
|
import { uiIntro } from '../intro/intro';
|
|
import { uiShortcuts } from '../shortcuts';
|
|
import { uiPane } from '../pane';
|
|
|
|
import { t, localizer } from '../../core/localizer';
|
|
import { uiTooltip } from '../tooltip';
|
|
import { icon } from '../intro/helper';
|
|
|
|
export function uiPaneHelp(context) {
|
|
|
|
var docKeys = [
|
|
['help', [
|
|
'welcome',
|
|
'open_data_h',
|
|
'open_data',
|
|
'before_start_h',
|
|
'before_start',
|
|
'open_source_h',
|
|
'open_source',
|
|
'open_source_help'
|
|
]],
|
|
['overview', [
|
|
'navigation_h',
|
|
'navigation_drag',
|
|
'navigation_zoom',
|
|
'features_h',
|
|
'features',
|
|
'nodes_ways'
|
|
]],
|
|
['editing', [
|
|
'select_h',
|
|
'select_left_click',
|
|
'select_right_click',
|
|
'multiselect_h',
|
|
'multiselect_shift_click',
|
|
'multiselect_lasso',
|
|
'undo_redo_h',
|
|
'undo_redo',
|
|
'save_h',
|
|
'save',
|
|
'save_validation',
|
|
'upload_h',
|
|
'upload',
|
|
'backups_h',
|
|
'backups',
|
|
'keyboard_h',
|
|
'keyboard'
|
|
]],
|
|
['feature_editor', [
|
|
'intro',
|
|
'definitions',
|
|
'type_h',
|
|
'type',
|
|
'type_picker',
|
|
'fields_h',
|
|
'fields_all_fields',
|
|
'fields_example',
|
|
'fields_add_field',
|
|
'tags_h',
|
|
'tags_all_tags',
|
|
'tags_resources'
|
|
]],
|
|
['points', [
|
|
'intro',
|
|
'add_point_h',
|
|
'add_point',
|
|
'add_point_finish',
|
|
'move_point_h',
|
|
'move_point',
|
|
'delete_point_h',
|
|
'delete_point',
|
|
'delete_point_command'
|
|
]],
|
|
['lines', [
|
|
'intro',
|
|
'add_line_h',
|
|
'add_line',
|
|
'add_line_draw',
|
|
'add_line_finish',
|
|
'modify_line_h',
|
|
'modify_line_dragnode',
|
|
'modify_line_addnode',
|
|
'connect_line_h',
|
|
'connect_line',
|
|
'connect_line_display',
|
|
'connect_line_drag',
|
|
'connect_line_tag',
|
|
'disconnect_line_h',
|
|
'disconnect_line_command',
|
|
'move_line_h',
|
|
'move_line_command',
|
|
'move_line_connected',
|
|
'delete_line_h',
|
|
'delete_line',
|
|
'delete_line_command'
|
|
]],
|
|
['areas', [
|
|
'intro',
|
|
'point_or_area_h',
|
|
'point_or_area',
|
|
'add_area_h',
|
|
'add_area_command',
|
|
'add_area_draw',
|
|
'add_area_finish',
|
|
'square_area_h',
|
|
'square_area_command',
|
|
'modify_area_h',
|
|
'modify_area_dragnode',
|
|
'modify_area_addnode',
|
|
'delete_area_h',
|
|
'delete_area',
|
|
'delete_area_command'
|
|
]],
|
|
['relations', [
|
|
'intro',
|
|
'edit_relation_h',
|
|
'edit_relation',
|
|
'edit_relation_add',
|
|
'edit_relation_delete',
|
|
'maintain_relation_h',
|
|
'maintain_relation',
|
|
'relation_types_h',
|
|
'multipolygon_h',
|
|
'multipolygon',
|
|
'multipolygon_create',
|
|
'multipolygon_merge',
|
|
'turn_restriction_h',
|
|
'turn_restriction',
|
|
'turn_restriction_field',
|
|
'turn_restriction_editing',
|
|
'route_h',
|
|
'route',
|
|
'route_add',
|
|
'boundary_h',
|
|
'boundary',
|
|
'boundary_add'
|
|
]],
|
|
['notes', [
|
|
'intro',
|
|
'add_note_h',
|
|
'add_note',
|
|
'move_note',
|
|
'update_note_h',
|
|
'update_note',
|
|
'save_note_h',
|
|
'save_note'
|
|
]],
|
|
|
|
['imagery', [
|
|
'intro',
|
|
'sources_h',
|
|
'choosing',
|
|
'sources',
|
|
'offsets_h',
|
|
'offset',
|
|
'offset_change'
|
|
]],
|
|
['streetlevel', [
|
|
'intro',
|
|
'using_h',
|
|
'using',
|
|
'photos',
|
|
'viewer'
|
|
]],
|
|
['gps', [
|
|
'intro',
|
|
'survey',
|
|
'using_h',
|
|
'using',
|
|
'tracing',
|
|
'upload'
|
|
]],
|
|
['qa', [
|
|
'intro',
|
|
'tools_h',
|
|
'tools',
|
|
'issues_h',
|
|
'issues'
|
|
]]
|
|
];
|
|
|
|
var headings = {
|
|
'help.help.open_data_h': 3,
|
|
'help.help.before_start_h': 3,
|
|
'help.help.open_source_h': 3,
|
|
'help.overview.navigation_h': 3,
|
|
'help.overview.features_h': 3,
|
|
'help.editing.select_h': 3,
|
|
'help.editing.multiselect_h': 3,
|
|
'help.editing.undo_redo_h': 3,
|
|
'help.editing.save_h': 3,
|
|
'help.editing.upload_h': 3,
|
|
'help.editing.backups_h': 3,
|
|
'help.editing.keyboard_h': 3,
|
|
'help.feature_editor.type_h': 3,
|
|
'help.feature_editor.fields_h': 3,
|
|
'help.feature_editor.tags_h': 3,
|
|
'help.points.add_point_h': 3,
|
|
'help.points.move_point_h': 3,
|
|
'help.points.delete_point_h': 3,
|
|
'help.lines.add_line_h': 3,
|
|
'help.lines.modify_line_h': 3,
|
|
'help.lines.connect_line_h': 3,
|
|
'help.lines.disconnect_line_h': 3,
|
|
'help.lines.move_line_h': 3,
|
|
'help.lines.delete_line_h': 3,
|
|
'help.areas.point_or_area_h': 3,
|
|
'help.areas.add_area_h': 3,
|
|
'help.areas.square_area_h': 3,
|
|
'help.areas.modify_area_h': 3,
|
|
'help.areas.delete_area_h': 3,
|
|
'help.relations.edit_relation_h': 3,
|
|
'help.relations.maintain_relation_h': 3,
|
|
'help.relations.relation_types_h': 2,
|
|
'help.relations.multipolygon_h': 3,
|
|
'help.relations.turn_restriction_h': 3,
|
|
'help.relations.route_h': 3,
|
|
'help.relations.boundary_h': 3,
|
|
'help.notes.add_note_h': 3,
|
|
'help.notes.update_note_h': 3,
|
|
'help.notes.save_note_h': 3,
|
|
'help.imagery.sources_h': 3,
|
|
'help.imagery.offsets_h': 3,
|
|
'help.streetlevel.using_h': 3,
|
|
'help.gps.using_h': 3,
|
|
'help.qa.tools_h': 3,
|
|
'help.qa.issues_h': 3
|
|
};
|
|
|
|
var replacements = {
|
|
// insert icons corresponding to various UI elements
|
|
point_icon: icon('#iD-icon-point', 'pre-text'),
|
|
line_icon: icon('#iD-icon-line', 'pre-text'),
|
|
area_icon: icon('#iD-icon-area', 'pre-text'),
|
|
note_icon: icon('#iD-icon-note', 'pre-text add-note'),
|
|
plus: icon('#iD-icon-plus', 'pre-text'),
|
|
minus: icon('#iD-icon-minus', 'pre-text'),
|
|
move_icon: icon('#iD-operation-move', 'pre-text operation'),
|
|
merge_icon: icon('#iD-operation-merge', 'pre-text operation'),
|
|
delete_icon: icon('#iD-operation-delete', 'pre-text operation'),
|
|
orthogonalize_icon: icon('#iD-operation-orthogonalize', 'pre-text operation'),
|
|
disconnect_icon: icon('#iD-operation-disconnect', 'pre-text operation'),
|
|
layers_icon: icon('#iD-icon-layers', 'pre-text'),
|
|
data_icon: icon('#iD-icon-data', 'pre-text'),
|
|
inspect: icon('#iD-icon-inspect', 'pre-text'),
|
|
close: icon('#iD-icon-close', 'pre-text'),
|
|
undo_icon: icon(localizer.textDirection() === 'rtl' ? '#iD-icon-redo' : '#iD-icon-undo', 'pre-text'),
|
|
redo_icon: icon(localizer.textDirection() === 'rtl' ? '#iD-icon-undo' : '#iD-icon-redo', 'pre-text'),
|
|
save_icon: icon('#iD-icon-save', 'pre-text'),
|
|
leftclick: icon('#iD-walkthrough-mouse', 'pre-text mouseclick', 'left'),
|
|
rightclick: icon('#iD-walkthrough-mouse', 'pre-text mouseclick', 'right'),
|
|
|
|
// insert localized, platform-dependent keys
|
|
shift: uiCmd.display('⇧'),
|
|
alt: uiCmd.display('⌥'),
|
|
return: uiCmd.display('↵'),
|
|
space: t('shortcuts.key.space'),
|
|
add_note_key: t('modes.add_note.key'),
|
|
shortcuts_key: t('shortcuts.toggle.key'),
|
|
|
|
// reference localized UI labels directly so that they'll always match
|
|
save: t('save.title'),
|
|
undo: t('undo.title'),
|
|
redo: t('redo.title'),
|
|
upload: t('commit.save'),
|
|
point: t('modes.add_point.title'),
|
|
line: t('modes.add_line.title'),
|
|
area: t('modes.add_area.title'),
|
|
note: t('modes.add_note.title'),
|
|
delete: t('operations.delete.title'),
|
|
move: t('operations.move.title'),
|
|
orthogonalize: t('operations.orthogonalize.title'),
|
|
merge: t('operations.merge.title'),
|
|
disconnect: t('operations.disconnect.title'),
|
|
map_data: t('map_data.title'),
|
|
fields: t('inspector.fields'),
|
|
tags: t('inspector.tags'),
|
|
relations: t('inspector.relations'),
|
|
new_relation: t('inspector.new_relation'),
|
|
turn_restrictions: t('presets.fields.restrictions.label'),
|
|
background_settings: t('background.description'),
|
|
imagery_offset: t('background.fix_misalignment'),
|
|
start_the_walkthrough: t('splash.walkthrough'),
|
|
|
|
// insert iD's version number
|
|
version: context.version
|
|
};
|
|
|
|
// For each section, squash all the texts into a single markdown document
|
|
var docs = docKeys.map(function(key) {
|
|
var helpkey = 'help.' + key[0];
|
|
var text = key[1].reduce(function(all, part) {
|
|
var subkey = helpkey + '.' + part;
|
|
var depth = headings[subkey]; // is this subkey a heading?
|
|
var hhh = depth ? Array(depth + 1).join('#') + ' ' : ''; // if so, prepend with some ##'s
|
|
return all + hhh + t(subkey, replacements) + '\n\n';
|
|
}, '');
|
|
|
|
return {
|
|
title: t(helpkey + '.title'),
|
|
html: marked(text.trim())
|
|
// use keyboard key styling for shortcuts
|
|
.replace(/<code>/g, '<kbd>')
|
|
.replace(/<\/code>/g, '<\/kbd>')
|
|
};
|
|
});
|
|
|
|
var helpPane = uiPane('help', context)
|
|
.key(t('help.key'))
|
|
.title(t('help.title'))
|
|
.description(t('help.title'))
|
|
.iconName('iD-icon-help');
|
|
|
|
helpPane.renderContent = function(content) {
|
|
|
|
function clickHelp(d, i) {
|
|
var rtl = (localizer.textDirection() === 'rtl');
|
|
content.property('scrollTop', 0);
|
|
helpPane.selection().select('.pane-heading h2').html(d.title);
|
|
|
|
body.html(d.html);
|
|
body.selectAll('a')
|
|
.attr('target', '_blank');
|
|
menuItems.classed('selected', function(m) {
|
|
return m.title === d.title;
|
|
});
|
|
|
|
nav.html('');
|
|
if (rtl) {
|
|
nav.call(drawNext).call(drawPrevious);
|
|
} else {
|
|
nav.call(drawPrevious).call(drawNext);
|
|
}
|
|
|
|
|
|
function drawNext(selection) {
|
|
if (i < docs.length - 1) {
|
|
var nextLink = selection
|
|
.append('a')
|
|
.attr('class', 'next')
|
|
.on('click', function() {
|
|
clickHelp(docs[i + 1], i + 1);
|
|
});
|
|
|
|
nextLink
|
|
.append('span')
|
|
.text(docs[i + 1].title)
|
|
.call(svgIcon((rtl ? '#iD-icon-backward' : '#iD-icon-forward'), 'inline'));
|
|
}
|
|
}
|
|
|
|
|
|
function drawPrevious(selection) {
|
|
if (i > 0) {
|
|
var prevLink = selection
|
|
.append('a')
|
|
.attr('class', 'previous')
|
|
.on('click', function() {
|
|
clickHelp(docs[i - 1], i - 1);
|
|
});
|
|
|
|
prevLink
|
|
.call(svgIcon((rtl ? '#iD-icon-forward' : '#iD-icon-backward'), 'inline'))
|
|
.append('span')
|
|
.text(docs[i - 1].title);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
function clickWalkthrough() {
|
|
if (context.inIntro()) return;
|
|
context.container().call(uiIntro(context));
|
|
context.ui().togglePanes();
|
|
}
|
|
|
|
|
|
function clickShortcuts() {
|
|
context.container().call(uiShortcuts(context), true);
|
|
}
|
|
|
|
var toc = content
|
|
.append('ul')
|
|
.attr('class', 'toc');
|
|
|
|
var menuItems = toc.selectAll('li')
|
|
.data(docs)
|
|
.enter()
|
|
.append('li')
|
|
.append('a')
|
|
.html(function(d) { return d.title; })
|
|
.on('click', clickHelp);
|
|
|
|
var shortcuts = toc
|
|
.append('li')
|
|
.attr('class', 'shortcuts')
|
|
.call(uiTooltip()
|
|
.title(t('shortcuts.tooltip'))
|
|
.keys(['?'])
|
|
.placement('top')
|
|
)
|
|
.append('a')
|
|
.on('click', clickShortcuts);
|
|
|
|
shortcuts
|
|
.append('div')
|
|
.text(t('shortcuts.title'));
|
|
|
|
var walkthrough = toc
|
|
.append('li')
|
|
.attr('class', 'walkthrough')
|
|
.append('a')
|
|
.on('click', clickWalkthrough);
|
|
|
|
walkthrough
|
|
.append('svg')
|
|
.attr('class', 'logo logo-walkthrough')
|
|
.append('use')
|
|
.attr('xlink:href', '#iD-logo-walkthrough');
|
|
|
|
walkthrough
|
|
.append('div')
|
|
.text(t('splash.walkthrough'));
|
|
|
|
|
|
var helpContent = content
|
|
.append('div')
|
|
.attr('class', 'left-content');
|
|
|
|
var body = helpContent
|
|
.append('div')
|
|
.attr('class', 'body');
|
|
|
|
var nav = helpContent
|
|
.append('div')
|
|
.attr('class', 'nav');
|
|
|
|
clickHelp(docs[0], 0);
|
|
|
|
};
|
|
|
|
return helpPane;
|
|
}
|