aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2018-02-23 10:05:17 +0100
committerChocobozzz <me@florianbigard.com>2018-02-23 10:05:17 +0100
commit621d99f53f47a11919ec243e05273ecf5907b444 (patch)
treedcd0d0ccc21bad4065bf49e2df3e641ffa18fee1
parent8a8e02a43e346b9b777c8192a7c5cbdccb928b11 (diff)
downloadPeerTube-621d99f53f47a11919ec243e05273ecf5907b444.tar.gz
PeerTube-621d99f53f47a11919ec243e05273ecf5907b444.tar.zst
PeerTube-621d99f53f47a11919ec243e05273ecf5907b444.zip
Better help on markdown fields
-rw-r--r--client/src/app/shared/misc/help.component.html5
-rw-r--r--client/src/app/shared/misc/help.component.scss1
-rw-r--r--client/src/app/shared/misc/help.component.ts55
-rw-r--r--client/src/app/videos/+video-edit/shared/video-edit.component.html6
-rw-r--r--client/src/app/videos/shared/markdown.service.ts42
5 files changed, 72 insertions, 37 deletions
diff --git a/client/src/app/shared/misc/help.component.html b/client/src/app/shared/misc/help.component.html
index 956095996..bacbe9cdb 100644
--- a/client/src/app/shared/misc/help.component.html
+++ b/client/src/app/shared/misc/help.component.html
@@ -12,4 +12,7 @@
12 </ng-template> 12 </ng-template>
13</ng-template> 13</ng-template>
14 14
15<button class="help-tooltip-button" containerClass="help-tooltip" [tooltipHtml]="tooltipTemplate" triggers="focus"></button> 15<button
16 class="help-tooltip-button" containerClass="help-tooltip" title="Click to get help"
17 #tooltipDirective="bs-tooltip" [tooltip]="tooltipTemplate" triggers="click"
18></button>
diff --git a/client/src/app/shared/misc/help.component.scss b/client/src/app/shared/misc/help.component.scss
index 5fe6b7366..b8bf3a7a5 100644
--- a/client/src/app/shared/misc/help.component.scss
+++ b/client/src/app/shared/misc/help.component.scss
@@ -18,6 +18,7 @@
18 .tooltip-inner { 18 .tooltip-inner {
19 text-align: left; 19 text-align: left;
20 padding: 10px; 20 padding: 10px;
21 max-width: 300px;
21 22
22 font-size: 13px; 23 font-size: 13px;
23 font-family: $main-fonts; 24 font-family: $main-fonts;
diff --git a/client/src/app/shared/misc/help.component.ts b/client/src/app/shared/misc/help.component.ts
index b8530e1d4..a4a223cd6 100644
--- a/client/src/app/shared/misc/help.component.ts
+++ b/client/src/app/shared/misc/help.component.ts
@@ -1,4 +1,6 @@
1import { Component, Input, OnInit } from '@angular/core' 1import { Component, ElementRef, HostListener, Input, OnInit, ViewChild } from '@angular/core'
2import { MarkdownService } from '@app/videos/shared'
3import { TooltipDirective } from 'ngx-bootstrap/tooltip'
2 4
3@Component({ 5@Component({
4 selector: 'my-help', 6 selector: 'my-help',
@@ -7,6 +9,7 @@ import { Component, Input, OnInit } from '@angular/core'
7}) 9})
8 10
9export class HelpComponent implements OnInit { 11export class HelpComponent implements OnInit {
12 @ViewChild('tooltipDirective') tooltipDirective: TooltipDirective
10 @Input() preHtml = '' 13 @Input() preHtml = ''
11 @Input() postHtml = '' 14 @Input() postHtml = ''
12 @Input() customHtml = '' 15 @Input() customHtml = ''
@@ -14,6 +17,8 @@ export class HelpComponent implements OnInit {
14 17
15 mainHtml = '' 18 mainHtml = ''
16 19
20 constructor (private elementRef: ElementRef) { }
21
17 ngOnInit () { 22 ngOnInit () {
18 if (this.helpType === 'custom') { 23 if (this.helpType === 'custom') {
19 this.mainHtml = this.customHtml 24 this.mainHtml = this.customHtml
@@ -21,26 +26,44 @@ export class HelpComponent implements OnInit {
21 } 26 }
22 27
23 if (this.helpType === 'markdownText') { 28 if (this.helpType === 'markdownText') {
24 this.mainHtml = 'Markdown compatible.<br /><br />' + 29 this.mainHtml = this.formatMarkdownSupport(MarkdownService.TEXT_RULES)
25 'Supports:' +
26 '<ul>' +
27 '<li>Links</li>' +
28 '<li>Lists</li>' +
29 '<li>Emphasis</li>' +
30 '</ul>'
31 return 30 return
32 } 31 }
33 32
34 if (this.helpType === 'markdownEnhanced') { 33 if (this.helpType === 'markdownEnhanced') {
35 this.mainHtml = 'Markdown compatible.<br /><br />' + 34 this.mainHtml = this.formatMarkdownSupport(MarkdownService.ENHANCED_RULES)
36 'Supports:' +
37 '<ul>' +
38 '<li>Links</li>' +
39 '<li>Lists</li>' +
40 '<li>Emphasis</li>' +
41 '<li>Images</li>' +
42 '</ul>'
43 return 35 return
44 } 36 }
45 } 37 }
38
39 @HostListener('document:click', ['$event.target'])
40 public onClick (targetElement) {
41 const clickedInside = this.elementRef.nativeElement.contains(targetElement)
42
43 if (this.tooltipDirective.isOpen && !clickedInside) {
44 this.tooltipDirective.hide()
45 }
46 }
47
48 private formatMarkdownSupport (rules: string[]) {
49 return '<a href="https://en.wikipedia.org/wiki/Markdown#Example" target="_blank">Markdown</a> compatible that supports:' +
50 this.createMarkdownList(rules)
51 }
52
53 private createMarkdownList (rules: string[]) {
54 const rulesToText = {
55 'emphasis': 'Emphasis',
56 'link': 'Links',
57 'newline': 'New lines',
58 'list': 'Lists',
59 'image': 'Images'
60 }
61
62 const bullets = rules.map(r => rulesToText[r])
63 .filter(text => text)
64 .map(text => '<li>' + text + '</li>')
65 .join('')
66
67 return '<ul>' + bullets + '</ul>'
68 }
46} 69}
diff --git a/client/src/app/videos/+video-edit/shared/video-edit.component.html b/client/src/app/videos/+video-edit/shared/video-edit.component.html
index f88abcbf8..f4ec4f95c 100644
--- a/client/src/app/videos/+video-edit/shared/video-edit.component.html
+++ b/client/src/app/videos/+video-edit/shared/video-edit.component.html
@@ -20,7 +20,8 @@
20 </div> 20 </div>
21 21
22 <div class="form-group"> 22 <div class="form-group">
23 <label for="description">Description</label> <my-help helpType="markdownText"></my-help> 23 <label for="description">Description</label>
24 <my-help helpType="markdownText" preHtml="Video descriptions are truncated by default and require manual action to expand them."></my-help>
24 <my-markdown-textarea truncate="250" formControlName="description"></my-markdown-textarea> 25 <my-markdown-textarea truncate="250" formControlName="description"></my-markdown-textarea>
25 26
26 <div *ngIf="formErrors.description" class="form-error"> 27 <div *ngIf="formErrors.description" class="form-error">
@@ -127,7 +128,8 @@
127 </div> 128 </div>
128 129
129 <div class="form-group"> 130 <div class="form-group">
130 <label for="support">Support</label><my-help helpType="markdownEnhanced"></my-help> 131 <label for="support">Support</label>
132 <my-help helpType="markdownEnhanced" preHtml="Short text to tell to people how they can support you (membership platform...)."></my-help>
131 <my-markdown-textarea 133 <my-markdown-textarea
132 id="support" formControlName="support" textareaWidth="500px" [previewColumn]="true" markdownType="enhanced" 134 id="support" formControlName="support" textareaWidth="500px" [previewColumn]="true" markdownType="enhanced"
133 [classes]="{ 'input-error': formErrors['support'] }" 135 [classes]="{ 'input-error': formErrors['support'] }"
diff --git a/client/src/app/videos/shared/markdown.service.ts b/client/src/app/videos/shared/markdown.service.ts
index fdd0ec8d2..9d73efa46 100644
--- a/client/src/app/videos/shared/markdown.service.ts
+++ b/client/src/app/videos/shared/markdown.service.ts
@@ -4,28 +4,22 @@ import * as MarkdownIt from 'markdown-it'
4 4
5@Injectable() 5@Injectable()
6export class MarkdownService { 6export class MarkdownService {
7 static TEXT_RULES = [
8 'linkify',
9 'autolink',
10 'emphasis',
11 'link',
12 'newline',
13 'list'
14 ]
15 static ENHANCED_RULES = MarkdownService.TEXT_RULES.concat([ 'image' ])
16
7 private textMarkdownIt: MarkdownIt.MarkdownIt 17 private textMarkdownIt: MarkdownIt.MarkdownIt
8 private enhancedMarkdownIt: MarkdownIt.MarkdownIt 18 private enhancedMarkdownIt: MarkdownIt.MarkdownIt
9 19
10 constructor () { 20 constructor () {
11 this.textMarkdownIt = new MarkdownIt('zero', { linkify: true, breaks: true }) 21 this.textMarkdownIt = this.createMarkdownIt(MarkdownService.TEXT_RULES)
12 .enable('linkify') 22 this.enhancedMarkdownIt = this.createMarkdownIt(MarkdownService.ENHANCED_RULES)
13 .enable('autolink')
14 .enable('emphasis')
15 .enable('link')
16 .enable('newline')
17 .enable('list')
18 this.setTargetToLinks(this.textMarkdownIt)
19
20 this.enhancedMarkdownIt = new MarkdownIt('zero', { linkify: true, breaks: true })
21 .enable('linkify')
22 .enable('autolink')
23 .enable('emphasis')
24 .enable('link')
25 .enable('newline')
26 .enable('list')
27 .enable('image')
28 this.setTargetToLinks(this.enhancedMarkdownIt)
29 } 23 }
30 24
31 textMarkdownToHTML (markdown: string) { 25 textMarkdownToHTML (markdown: string) {
@@ -40,6 +34,18 @@ export class MarkdownService {
40 return this.avoidTruncatedLinks(html) 34 return this.avoidTruncatedLinks(html)
41 } 35 }
42 36
37 private createMarkdownIt (rules: string[]) {
38 const markdownIt = new MarkdownIt('zero', { linkify: true, breaks: true })
39
40 for (let rule of rules) {
41 markdownIt.enable(rule)
42 }
43
44 this.setTargetToLinks(markdownIt)
45
46 return markdownIt
47 }
48
43 private setTargetToLinks (markdownIt: MarkdownIt.MarkdownIt) { 49 private setTargetToLinks (markdownIt: MarkdownIt.MarkdownIt) {
44 // Snippet from markdown-it documentation: https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md#renderer 50 // Snippet from markdown-it documentation: https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md#renderer
45 const defaultRender = markdownIt.renderer.rules.link_open || function (tokens, idx, options, env, self) { 51 const defaultRender = markdownIt.renderer.rules.link_open || function (tokens, idx, options, env, self) {