NoteTemplate.php 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. <?php
  2. namespace App\Services\Markup\Templates;
  3. use App\Services\Markup\Dialect;
  4. use App\Services\Markup\Format;
  5. use App\Services\Markup\Ir\Call;
  6. use App\Services\Markup\Ir\Document;
  7. use App\Services\Markup\Ir\Params;
  8. use App\Services\Markup\Render\HtmlRenderer;
  9. use App\Services\Markup\Render\RenderContext;
  10. /**
  11. * 脚注:`{{note|正文}}`、`{{n|正文}}`、```note 围栏;旧方言还有 `` `正文` `` 与单独一行的 ``` 围栏。
  12. *
  13. * 正文是 markdown(可换行、可分段、可嵌模板)。角标总在行内:写在哪里就在哪里。
  14. *
  15. * 参数:text(正文)、trigger(角标文字)、cite(来源说明)、citelink(book-para-start-end 跳转坐标)。
  16. * E2 方言只认第一个位置参数是正文,其余参数必须写名字;不是已声明参数名的片段连同 `|` 拼回正文,
  17. * 所以正文里出现 `|`、`a=b` 都不会被拆开。
  18. */
  19. final class NoteTemplate extends Template
  20. {
  21. protected string $component = 'note';
  22. public function params(): array
  23. {
  24. return [
  25. 'text' => ParamSpec::markdown(1),
  26. 'trigger' => ParamSpec::at(2),
  27. 'cite' => ParamSpec::at(3),
  28. 'citelink' => ParamSpec::at(4),
  29. ];
  30. }
  31. public function parseParams(array $segments, Dialect $dialect): Params
  32. {
  33. if ($dialect === Dialect::Markdown) {
  34. return parent::parseParams($segments, $dialect);
  35. }
  36. $named = [];
  37. $body = [];
  38. foreach ($segments as $segment) {
  39. if (preg_match('/^(text|trigger|cite|citelink)=(.*)$/s', $segment, $m) === 1) {
  40. $named[$m[1]] = $m[2];
  41. } else {
  42. $body[] = $segment;
  43. }
  44. }
  45. $positional = $body === [] ? [] : [1 => implode('|', $body)];
  46. return new Params($named, $positional);
  47. }
  48. /**
  49. * @return array<string, mixed>
  50. */
  51. public function props(Call $call, RenderContext $ctx): array
  52. {
  53. return array_filter([
  54. 'trigger' => (string) $call->param('trigger'),
  55. 'cite' => (string) $call->param('cite'),
  56. 'citelink' => (string) $call->param('citelink'),
  57. ], fn (string $value) => $value !== '');
  58. }
  59. public function children(Call $call, RenderContext $ctx): ?Document
  60. {
  61. return $call->slot('text');
  62. }
  63. public function text(Call $call, RenderContext $ctx): string
  64. {
  65. return (string) $call->param('trigger');
  66. }
  67. /**
  68. * 纯文本里只留角标文字;simple 与 prompt 连角标也不要(v2 口径)。
  69. */
  70. public function plain(Call $call, RenderContext $ctx, Format $format): string
  71. {
  72. return $format === Format::Text ? $this->text($call, $ctx) : '';
  73. }
  74. /**
  75. * 边注(sidenote)结构,与 library 阅读器的 CSS 配套;同时记进文末脚注列表。
  76. */
  77. public function html(Call $call, RenderContext $ctx): string
  78. {
  79. $sn = $ctx->nextNoteNumber();
  80. $trigger = (string) $call->param('trigger');
  81. // 角标嵌在句子中间:正文只能是行内元素,否则浏览器会切断 sidenote 的结构
  82. $slot = $call->slot('text');
  83. $content = $slot !== null && $ctx->renderer instanceof HtmlRenderer
  84. ? $ctx->renderer->inlineSafe($slot, $ctx)
  85. : $this->content($call, $ctx);
  86. $ctx->footnotes[] = ['sn' => $sn, 'trigger' => $trigger, 'content' => $content];
  87. $target = '';
  88. $parts = explode('-', (string) $call->param('citelink'));
  89. if (count($parts) === 4) {
  90. $target = ' data-book="'.e($parts[0]).'" data-para="'.e($parts[1]).'" data-start="'.e($parts[2]).'" data-end="'.e($parts[3]).'"';
  91. }
  92. $cite = (string) $call->param('cite');
  93. $citeHtml = $cite === '' ? '' : '<cite class="anno-jump"'.$target.'>'.e($cite).'</cite>';
  94. $id = $ctx->htmlId('sn', $sn);
  95. return '<label for="'.$id.'" class="margin-toggle sidenote-number"'.$target.'>'.e($trigger).'</label>'
  96. .'<input type="checkbox" id="'.$id.'" class="margin-toggle"/>'
  97. .'<span class="sidenote">'.$content.$citeHtml.'</span>';
  98. }
  99. public function markdown(Call $call, RenderContext $ctx): string
  100. {
  101. $sn = $ctx->nextNoteNumber();
  102. $ctx->footnotes[] = [
  103. 'sn' => $sn,
  104. 'trigger' => (string) $call->param('trigger'),
  105. 'content' => $this->content($call, $ctx),
  106. ];
  107. return "[^{$sn}]";
  108. }
  109. private function content(Call $call, RenderContext $ctx): string
  110. {
  111. $slot = $call->slot('text');
  112. return $slot === null ? '' : $ctx->renderString($slot);
  113. }
  114. }