zulip/web/templates/settings/linkifier_settings_admin.hbs

79 lines
3.9 KiB
Handlebars
Raw Normal View History

<div id="linkifier-settings" class="settings-section" data-name="linkifier-settings">
<div class="admin-table-wrapper">
<p>
{{t "Configure regular expression patterns that will be used to
automatically transform any matching text in Zulip messages
and topics into links." }}
</p>
<p>
{{t "Linkifiers make it easy to refer to issues or tickets in
third party issue trackers, like GitHub, Salesforce, Zendesk,
and others. For instance, you can add a linkifier that
automatically turns #2468 into a link to the GitHub issue
in the Zulip repository with:" }}
</p>
<ul>
<li>
{{t "Pattern" }}: <span class="rendered_markdown"><code>#(?P&lt;id&gt;[0-9]+)</code></span>
</li>
<li>
linkifier: Support URL templates for linkifiers. This swaps out url_format_string from all of our APIs and replaces it with url_template. Note that the documentation changes in the following commits will be squashed with this commit. We change the "url_format" key to "url_template" for the realm_linkifiers events in event_schema, along with updating LinkifierDict. "url_template" is the name chosen to normalize mixed usages of "url_format_string" and "url_format" throughout the backend. The markdown processor is updated to stop handling the format string interpolation and delegate the task template expansion to the uri_template library instead. This change affects many test cases. We mostly just replace "%(name)s" with "{name}", "url_format_string" with "url_template" to make sure that they still pass. There are some test cases dedicated for testing "%" escaping, which aren't relevant anymore and are subject to removal. But for now we keep most of them as-is, and make sure that "%" is always escaped since we do not use it for variable substitution any more. Since url_format_string is not populated anymore, a migration is created to remove this field entirely, and make url_template non-nullable since we will always populate it. Note that it is possible to have url_template being null after migration 0422 and before 0424, but in practice, url_template will not be None after backfilling and the backend now is always setting url_template. With the removal of url_format_string, RealmFilter model will now be cleaned with URL template checks, and the old checks for escapes are removed. We also modified RealmFilter.clean to skip the validation when the url_template is invalid. This avoids raising mulitple ValidationError's when calling full_clean on a linkifier. But we might eventually want to have a more centric approach to data validation instead of having the same validation in both the clean method and the validator. Fixes #23124. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-10-05 20:55:31 +02:00
{{t "URL template" }}: <span class="rendered_markdown"><code>https://github.com/zulip/zulip/issues/{id}</code></span>
</li>
</ul>
<p>
{{#tr}}
For more examples, see the <z-link>help center documentation</z-link>
on adding linkifiers.
{{#*inline "z-link"}}<a href="/help/add-a-custom-linkifier" target="_blank" rel="noopener noreferrer">{{> @partial-block}}</a>{{/inline}}
{{/tr}}
</p>
{{#if is_admin}}
<form class="admin-linkifier-form">
<div class="add-new-linkifier-box grey-box">
<div class="new-linkifier-form wrapper">
<div class="settings-section-title new-linkifier-section-title">
{{t "Add a new linkifier" }}
{{> ../help_link_widget link="/help/add-a-custom-linkifier" }}
</div>
<div class="alert" id="admin-linkifier-status"></div>
<div class="input-group">
<label for="linkifier_pattern">{{t "Pattern" }}</label>
<input type="text" id="linkifier_pattern" class="settings_text_input" name="pattern" placeholder="#(?P<id>[0-9]+)" />
<div class="alert" id="admin-linkifier-pattern-status"></div>
</div>
<div class="input-group">
<label for="linkifier_template">{{t "URL template" }}</label>
<input type="text" id="linkifier_template" class="settings_text_input" name="url_template" placeholder="https://github.com/zulip/zulip/issues/{id}" />
<div class="alert" id="admin-linkifier-template-status"></div>
</div>
<button type="submit" class="button rounded sea-green">
{{t 'Add linkifier' }}
</button>
</div>
</div>
</form>
{{/if}}
<div class="settings_panel_list_header">
<h3>{{t "Linkifiers"}}</h3>
<div class="alert-notification edit-linkifier-status" id="linkifier-field-status"></div>
<input type="text" class="search filter_text_input" placeholder="{{t 'Filter linkifiers' }}" aria-label="{{t 'Filter linkifiers' }}"/>
</div>
<div class="progressive-table-wrapper" data-simplebar>
<table class="table table-striped wrapped-table admin_linkifiers_table">
<thead class="table-sticky-headers">
<th>{{t "Pattern" }}</th>
<th>{{t "URL template" }}</th>
{{#if is_admin}}
<th class="actions">{{t "Actions" }}</th>
{{/if}}
</thead>
<tbody id="admin_linkifiers_table" data-empty="{{t 'No linkifiers configured.' }}" data-search-results-empty="{{t 'No linkifiers match your current filter.' }}"></tbody>
</table>
</div>
</div>
</div>