-
Notifications
You must be signed in to change notification settings - Fork 0
/
xmindtomd.php
1248 lines (1136 loc) · 44 KB
/
xmindtomd.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// TEST
// php xmindtomd.php -f "../../Documents/Maps/Temps et Empathie - JASFFG41.xmind" -d -l3 -o"/Users/eric/Sites/farm/books/data/pages/fr/medical/in_progress/jasfgg41_2.txt"
/**
* PHP command line script
* XMind file exporter to Dokuwiki and Markdown syntax
*
* Run command line to get help about this script
* php xmindtomd -v
*
* Licence: BSD-3-Clauses
* Author: Eric Maeker, MD, France, 2021-2022.
*/
class XMindToMD {
private $logDebug = false;
private $debugStart = "*** Debug".PHP_EOL;
private $debugEnd = "*** /Debug".PHP_EOL;
private $contentFile = "content.json";
private $options = NULL;
private $version = 1640762564; // echo $(date +%s)
// Output raw
private $lastH1 = "";
private $lastH2 = "";
private $output = "";
private $formatRefs = "long"; // Format for the reference output -> {{format>...}}
private $extraRefs = Array(); // Read refs from a specific page
private $manualRefs = Array(); // Extracted refs from map [(...>...)]
private $currentOptions = Array(); // Contains options of a branch
// Reveal JS var
private $rjs = Array(
"commands" => Array(
"titre",
"titrecourt",
"titrelong",
"auteurs",
"affiliation",
"date",
"citation",
"footer",
"style",
"bandeau",
"extrastyle",
"bg-anim",
"slide-transition",
),
// Computed slides
"output" => "",
"currentSlide" => "",
"currentSlideEmpty" => true,
"currentSlideOpt" => "", // Some options for the currentSlide
"map" => "", // map of presentation
"mapTag" => "%%revealjs_map_tag%%", // Where map will be inserted at the end of the process
// File start and end blocks
"outputStart" => "~~REVEAL~~\n~~NOCACHE~~\n\n",
"outputEnd" => "",
// Slides start and end blocks
"slideStart" => "\n",
"slideEnd" => "\n",
// Footer
"footerFormat" => "<wrap footer>%s</wrap>\n\n",
);
// Style
private $beforeH1 = "";
private $afterH1 = "";
private $beforeH2 = "";
private $afterH2 = "";
private $beforeH3 = "";
private $afterH3 = "";
private $beforeH4 = "";
private $afterH4 = "";
private $beforeH5 = "";
private $afterH5 = "";
private $nheaders = 2; // Number of header levels
private $onlyBranch = -1; // Process only one branch
private $outputExt = ".md";
private $style = "";
private $styleLf = "";
private $preBold = "";
private $postBold = "";
private $preItalic = "";
private $postItalic = "";
/**
* Initialization of the object
* Read command line and set style
*/
public function __construct() {
$this->readCLIOptions();
}
/**
* Read command line options
* Run command line to get help about this script
* php xmindtomd -v
*/
private function readCLIOptions() {
// Script example.php
$shortopts = "";
$shortopts .= "f:"; // input XMind file
$shortopts .= "s:"; // style
$shortopts .= "o::"; // output (optional)
$shortopts .= "l::"; // level (optional)
$shortopts .= "b::"; // one branch only (optional)
$shortopts .= "hvdm"; // help, version, dokuwiki, markdown
$longopts = array(
// "file:",
// "output::",
// "help",
// "version",
// "dokuwiki",
// "markdown",
);
$this->options = getopt($shortopts, $longopts);
if (array_key_exists("h", $this->options)) {
global $argv;
echo PHP_EOL;
echo "This command line script exports XMind files to Dokuwiki or Markdown.".PHP_EOL;
echo "Example: php ".$argv[0]." -f xmindfile.xmind -d -o dokuwikified.txt".PHP_EOL;
echo "Options ".PHP_EOL;
echo " -h get this help".PHP_EOL;
echo " -v get script version".PHP_EOL;
echo " -d Export to Dokuwiki syntax".PHP_EOL;
echo " -m Export to Markdown syntax".PHP_EOL;
echo " -l Level of headers".PHP_EOL;
echo " -b Only branch number x".PHP_EOL;
echo PHP_EOL;
echo "Written by Eric Maeker, MD, France.".PHP_EOL;
echo "See: https://github.com/EricMaeker".PHP_EOL;
echo PHP_EOL;
exit(0);
}
if (array_key_exists("v", $this->options)) {
global $argv;
echo PHP_EOL;
echo "PHP Script: ".$argv[0]." - Version: ".$this->version.PHP_EOL;
exit(0);
}
// Set style
// Default style is Markdown
$this->setStyle("md");
if (array_key_exists("d", $this->options)) {
$this->setStyle("doku");
} else if (array_key_exists("m", $this->options)) {
$this->setStyle("md");
}
// Check header levels
if (array_key_exists("l", $this->options) &&
!empty($this->options["l"])) {
$this->nheaders = $this->options["l"];
}
if (array_key_exists("b", $this->options) &&
!empty($this->options["b"])) {
$this->onlyBranch = $this->options["b"];
}
}
/**
* Start exportation of the XMind file
*/
public function runExport(){
$fn = $this->options["f"];
echo "* Reading file: ".$fn.PHP_EOL;
// Test file
// Exists?
if (!file_exists($fn)) {
echo "Error: ".$fn." does not exists.".PHP_EOL;
exit(1);
}
// XMind extension?
if (substr($fn, -6) !== ".xmind") {
echo "Error: ".$fn." wrong extension.".PHP_EOL;
exit(2);
}
// Unzip file
$contents = file_get_contents("zip://".$fn."#".$this->contentFile);
if (empty($contents)) {
echo "Error: ".$fn." extracted content NULL.".PHP_EOL;
exit(3);
}
// Read JSON
echo "* Decoding XMind JSON content".PHP_EOL;
$json = json_decode($contents, false);
// Log debug
if ($this->logDebug) {
echo $this->debugStart;
echo "File to export: ".$file.PHP_EOL;
echo print_r($json);
echo $this->debugEnd;
}
// Get root topic
echo "* Exporting style: ".$this->style.PHP_EOL;
echo "* Number of header level: ".$this->nheaders.PHP_EOL;
$node = $json[0]->rootTopic;
$this->readNode($node);
}
/**
* Read one JSON node of the XMind file. Read the node and all its children.
* Outputs rendered text in var $this->output
*
* $node is the current to read
* $level is the current level of indentation
*
* \note Recursive function
*/
private function readNode($node, $level = 0) {
if (!$this->_isNodeToRead($node))
return true;
// Don't read extrapage, only reference nodes
if ($this->_isExtraPage($node) ||
$this->_isOnlyReference($node)) {
return true;
}
if ($this->_isRevealNode($node)) {
$this->_readRevealNode($node, $level);
return true;
}
if ($this->_isTableNode($node)) {
$this->_readTableNode($node, $level);
return true;
}
if ($this->_isExtraDokuwikiNode($node)) {
// TODO: add this to revealJS reader
$this->_readExtraDokuwikiNode($node, $level);
return true;
}
if ($this->_isOptionsNode($node)) {
return true;
}
// Manage option "only-tagged" == only process tagged nodes
if (in_array("only-tagged", $this->currentOptions)) {
if (property_exists($node, "markers") && count($node->markers)) {
// Process node
// echo PHP_EOL.PHP_EOL."tagg ok ".print_r($node->title).PHP_EOL.PHP_EOL;
} else {
// Do not process node
// echo PHP_EOL.PHP_EOL."read children ok ".print_r($node->title).PHP_EOL.PHP_EOL;
// Read children
if (property_exists($node, "children")) {
foreach($node->children->attached as $child) {
$this->readNode($child, $level+1);
}
}
return true;
}
}
// Get some work on node text
$title = $node->title;
$nheaders_bkup = $this->nheaders;
// Title contains a mention to nb of levels? {{l\d}}
if (preg_match("/.*\{\{l(\d)\}\}/", $title, $matches)) {
$this->nheaders = $matches[1];
$title = preg_replace("/(.*)\s*\{\{l(\d)\}\}/", "$1", $title);
}
// Convert LF to dokuwiki/markdown style
$withoutLf = str_replace("\n", " / ", $title);
$withLf = str_replace("\n", $this->styleLf, $title);
switch ($level) {
case 0:
if ($this->nheaders > 0) {
$this->output .= PHP_EOL.PHP_EOL;
$this->output .= $this->beforeH1;
$this->output .= $withoutLf;
$this->output .= $this->afterH1;
$this->output .= PHP_EOL.PHP_EOL;
$this->lastH1 = $withoutLf;
$this->lastH2 = "";
$this->lastH3 = "";
break;
}
case 1:
if ($this->nheaders > 1) {
$this->output .= PHP_EOL.PHP_EOL;
$this->output .= $this->beforeH2;
$this->output .= $withoutLf;
$this->output .= $this->afterH2;
$this->output .= PHP_EOL.PHP_EOL;
$this->lastH2 = $withoutLf;
$this->lastH3 = "";
break;
}
case 2:
if ($this->nheaders > 2) {
$this->output .= PHP_EOL.PHP_EOL;
$this->output .= $this->beforeH3;
$this->output .= str_replace("\n", " / ", $title);
$this->output .= $this->afterH3;
$this->output .= PHP_EOL.PHP_EOL;
$this->lastH3 = $withoutLf;
break;
}
case 3:
if ($this->nheaders > 3) {
$this->output .= PHP_EOL.PHP_EOL;
$this->output .= $this->beforeH4;
$this->output .= str_replace("\n", " / ", $title);
$this->output .= $this->afterH4;
$this->output .= PHP_EOL.PHP_EOL;
$this->lastH3 = $withoutLf;
break;
}
case 4:
if ($this->nheaders > 4) {
$this->output .= PHP_EOL.PHP_EOL;
$this->output .= $this->beforeH5;
$this->output .= str_replace("\n", " / ", $title);
$this->output .= $this->afterH5;
$this->output .= PHP_EOL.PHP_EOL;
$this->lastH3 = $withoutLf;
break;
}
default:
// Manage indentation / list
if (in_array("no-list", $this->currentOptions)) {
$indent = $this->styleLf.$this->styleLf;
} else {
$indent = $this->_getLineIndent($level, $this->nheaders);
}
// Add to general output
$this->output .= $indent;
// Get style of the node
if (property_exists($node, "style")
&& property_exists($node->style, "properties")) {
$arr = get_object_vars($node->style->properties);
// Bold?
if (array_key_exists("fo:font-weight", $arr) &&
!empty($arr["fo:font-weight"])) {
if ($arr["fo:font-weight"] === "bold") {
$withLf = $this->preBold.$withLf.$this->postBold;
}
} else
// Italic?
if (array_key_exists("fo:font-style", $arr) &&
!empty($arr["fo:font-style"])) {
if ($arr["fo:font-style"] === "italic") {
$withLf = $this->preItalic.$withLf.$this->postItalic;
}
}
}
$this->output .= $withLf.PHP_EOL;
}
// Read children
if (property_exists($node, "children")) {
foreach($node->children->attached as $child) {
$this->readNode($child, $level+1);
}
}
$this->nheaders = $nheaders_bkup;
// echo "Removing opt";
// unset($this->currentOptions);
// $this->currentOptions = array();
}
/**
* Ok
* Return false if node title contains {{-}}
*/
private function _isNodeToRead($node) {
$m = array();
if (preg_match("/.*\{\{\-\}\}/", $node->title, $m)) {
return false;
}
return true;
}
/**
* Ok
* TODO: catch previous node?
*/
private function _isTableNode($node) {
// if (!property_exists($node, "structureClass"))
// return false;
// if (empty($node->structureClass) ||
// $node->structureClass !== "org.xmind.ui.spreadsheet.column")
// return false;
// Use Dokuwiki format to detect table node
// Table should start with headings -> ^
$test = str_replace(" ", "", $node->title);
if (substr($test, 0, 1) === "^" || substr($test, 0, 1) === "|")
return true;
return false;
}
/**
* Add a dokuwiki formatted table in the output document or the revealJS output
*/
private function _readTableNode($node, $level = 0, $isReveal = false) {
if (!$this->_isTableNode($node))
return false;
if ($isReveal) {
$this->rjs["currentSlide"] .= PHP_EOL.PHP_EOL.$node->title.PHP_EOL.PHP_EOL;
} else {
$this->output .= PHP_EOL.PHP_EOL.$node->title.PHP_EOL.PHP_EOL;
}
}
/**
* Check if the node is a dokuwiki extra command like
* <TEXT <WRAP <wrap <HTML <style ...
*/
private function _isExtraDokuwikiNode($node) {
// Check first chars
$test = str_replace(" ", "", $node->title);
$test = substr($test, 0, 5);
$tags = array("<HTML", "<styl", "<wrap", "<WRAP", "<scri", "<TEXT", "<text");
return in_array($test, $tags);
}
/**
* Add a dokuwiki formatted table in the output document or the revealJS output
*/
private function _readExtraDokuwikiNode($node, $level = 0, $isReveal = false) {
if (!$this->_isExtraDokuwikiNode($node))
return false;
if ($isReveal) {
$this->rjs["currentSlide"] .= PHP_EOL.PHP_EOL.$node->title.PHP_EOL.PHP_EOL;
} else {
$this->output .= PHP_EOL.PHP_EOL.$node->title.PHP_EOL.PHP_EOL;
}
}
/**
* Read options from textual output inside the map. Options are
* - only-bold : keep only bold titles
* - only-tagged : keep only tagged titles
* - no-indent / no-list : everything in the branch will not be extracted as an indent list
*/
private function _isOptionsNode($node) {
if (strtolower($node->title) == "opt"
|| strtolower($node->title) == "option"
|| strtolower($node->title) == "options") {
// Read children
if (property_exists($node, "children")) {
foreach($node->children->attached as $child) {
switch ($child->title) {
case "no-list": case "no-indent":
array_push($this->currentOptions, "no-list");
break;
case "only-bold":
array_push($this->currentOptions, "only-bold");
break;
case "only-tagged":
array_push($this->currentOptions, "only-tagged");
break;
}
}
}
return true;
}
return false;
}
/**
* Define the style of export (header style, file extension, line feed, etc.)
* Use:
* doku for dokuwiki
* md for markdown
*/
public function setStyle($style) {
$this->style = $style;
switch (strtolower($style)) {
case "doku":
$this->beforeH1 = "====== ";
$this->afterH1 = " ======";
$this->beforeH2 = "===== ";
$this->afterH2 = " =====";
$this->beforeH3 = "==== ";
$this->afterH3 = " ====";
$this->beforeH4 = "=== ";
$this->afterH4 = " ===";
$this->beforeH5 = "== ";
$this->afterH5 = " ==";
$this->styleLf = " \\\\ ";
$this->outputExt = ".txt";
$this->preBold = "**";
$this->postBold = "**";
$this->preItalic = "//";
$this->postItalic = "//";
break;
case "md":
$this->beforeH1 = "# ";
$this->afterH1 = "";
$this->beforeH2 = "## ";
$this->afterH2 = "";
$this->beforeH3 = "### ";
$this->afterH3 = "";
$this->beforeH4 = "#### ";
$this->afterH4 = "";
$this->beforeH5 = "##### ";
$this->afterH5 = "";
$this->styleLf = "\\\n";
$this->outputExt = ".md";
$this->preBold = "**";
$this->postBold = "**";
$this->preItalic = "*";
$this->postItalic = "*";
break;
}
}
/**
* Return the indentation string to use according to the
* current $level and the requiered $maxHeaders (maximum number of headers)
*/
private function _getLineIndent($level, $maxHeaders) {
$i = $level - $maxHeaders + 1;
if ($i < 0)
$i = 1;
return str_repeat(" ", $i)."* ";
}
/**
* Extra code for pubmed2020 plugin and refnotes
*/
public function createPubmedRefNotes() {
echo "* Preparing REFNOTES".PHP_EOL;
$includeRefs = false; // No references to add if false
// Get RefNotes params
$refs = "<refnotes>".PHP_EOL;
$refs .= " refnote-id : 1".PHP_EOL;
$refs .= " reference-base : text".PHP_EOL;
$refs .= " reference-font-weight : normal".PHP_EOL;
$refs .= " reference-font-style : normal".PHP_EOL;
$refs .= " reference-format : []".PHP_EOL;
$refs .= " reference-group : ,".PHP_EOL;
$refs .= " reference-render : basic".PHP_EOL;
$refs .= " multi-ref-id : note".PHP_EOL;
$refs .= " note-preview : popup".PHP_EOL;
$refs .= " notes-separator : none".PHP_EOL;
$refs .= " note-text-align : left".PHP_EOL;
$refs .= " note-font-size : normal".PHP_EOL;
$refs .= " note-render : basic".PHP_EOL;
$refs .= " note-id-base : text".PHP_EOL;
$refs .= " note-id-font-weight : normal".PHP_EOL;
$refs .= " note-id-font-style : normal".PHP_EOL;
$refs .= " note-id-format : .".PHP_EOL;
$refs .= " back-ref-caret : none".PHP_EOL;
$refs .= " back-ref-base : text".PHP_EOL;
$refs .= " back-ref-font-weight : bold".PHP_EOL;
$refs .= " back-ref-font-style : normal".PHP_EOL;
$refs .= " back-ref-format : none".PHP_EOL;
$refs .= " back-ref-separator : ,".PHP_EOL;
$refs .= " scoping : single".PHP_EOL;
$refs .= "</refnotes>".PHP_EOL.PHP_EOL;
$refs .= "{{pmid>doc_format:".$this->formatRefs."}}".PHP_EOL.PHP_EOL;
// Include reference pages "{{refs>...}}" in xmind file
if (count($this->extraRefs)) {
$includeRefs = true;
echo " * Found ".count($this->extraRefs)." references' page(s)".PHP_EOL;
foreach($this->extraRefs as $page) {
if (strpos($page, "&nofooter&link") === false) {
$page = str_replace("}}", "&nofooter&link}}", $page);
}
$refs .= str_replace("{{refs>", "{{page>", $page).PHP_EOL;
}
$refs .= PHP_EOL.PHP_EOL;
}
// Search for references PMID references (noted [(P12345678)] in xmind file)
$pattern = "/\[\(P(\d+)\)\]/";
if (preg_match_all($pattern, $this->output.$this->rjs["output"], $matches, PREG_PATTERN_ORDER)) {
$includeRefs = true;
// Get all PMIDs references
$pmids = array_unique($matches[1]);
sort($pmids, SORT_NUMERIC);
echo " * Found ".count($pmids)." Unique PubMed PMID reference(s)".PHP_EOL;
// Add to raw output
foreach($pmids as $k => $pmid) {
$refs .= "[(P".trim($pmid).">{{pmid>".trim($pmid)."}})]".PHP_EOL;
}
$refs .= PHP_EOL.PHP_EOL;
}
// } else if (preg_match('~{{pmidlist}}~', $node->title, $m)) {
// return true;
// }
// Add $this->manualRefs
if (count($this->manualRefs)) {
$includeRefs = true;
echo " * Found ".count($this->manualRefs)." Unique manual node reference(s)".PHP_EOL;
foreach($this->manualRefs as $r) {
$refs .= $r.PHP_EOL;
// Search for manual references (noted [(nameOfRef>Value Of the ref. https://link.lk.)])
// $contents = file_get_contents($fn);
// $pattern = "/(\[\([^>]+\>.*\)\])/";
// if (preg_match_all($pattern, $this->output.$this->rjs["output"], $matches, PREG_PATTERN_ORDER)) {
// $includeRefs = true;
// // Include these references
// $r = array_unique($matches[1]);
// sort($r, SORT_STRING);
// echo " * Found ".count($r)." Unique manual reference(s) in text".PHP_EOL;
// // Add to raw output
// foreach($r as $ref) {
// $refs .= $ref.PHP_EOL;
// }
// }
}
}
// Add references to outputs (raw and RevealJS)
if ($includeRefs == true) {
// Add to raw
echo " * Add references to dokuwiki/markdown output".PHP_EOL;
$this->output .= PHP_EOL.PHP_EOL.PHP_EOL."===== Références =====".PHP_EOL.PHP_EOL.PHP_EOL;
$this->output .= $refs.PHP_EOL;
$this->output .= PHP_EOL.PHP_EOL."~~REFNOTES~~".PHP_EOL.PHP_EOL;
// Add to RevealJS
if (!empty($this->rjs["output"])) {
// Count number of reference used in the slides output
$n = 0;
$pattern = "/\[\([^\)^>]*\)\]/";
if (preg_match_all($pattern, $this->rjs["output"], $matches)) {
$n = count($matches[0]);
$a = Array();
foreach($matches[0] as $aref) {
if (in_array($aref, $a))
continue;
array_push($a, $aref);
}
$n = count($a);
}
echo " * Add references to RevealJS output? Number used: ".$n.PHP_EOL;
// If we have refs to add
if ($n > 0) {
// Four refs by references slides
$nSlides = intdiv($n, 4);
if (($n % 4) > 0) $nSlides++;
// Add this part to the map
$this->rjs["map"] .= " * Références bibliographiques".PHP_EOL;
$this->rjs["output"] .= $this->rjs["mapTag"].PHP_EOL.PHP_EOL;
// Create references slides
$this->rjs["output"] .= "---- eric :1px.png bg-none none ---->".PHP_EOL;
$this->rjs["output"] .= PHP_EOL;
$this->rjs["output"] .= $this->beforeH2;
$this->rjs["output"] .= "Références bibliographiques";
$this->rjs["output"] .= $this->afterH2.PHP_EOL.PHP_EOL;
$this->rjs["output"] .= " * Nombre de références : ".$n.PHP_EOL.PHP_EOL;
$this->rjs["output"] .= " * Nombre de slides : ".$nSlides.PHP_EOL.PHP_EOL;
// Add to RevealJS output
$this->rjs["output"] .= PHP_EOL.PHP_EOL.$refs.PHP_EOL;
$this->rjs["output"] .= "<----".PHP_EOL.PHP_EOL;
for($i=0; $i < $nSlides; $i++) {
$this->rjs["output"] .= PHP_EOL.PHP_EOL.PHP_EOL;
$this->rjs["output"] .= "---- eric :1px.png bg-none none ---->".PHP_EOL;
$this->rjs["output"] .= PHP_EOL;
$this->rjs["output"] .= $this->beforeH3;
$this->rjs["output"] .= "Références ".($i+1)." / ".$nSlides;
$this->rjs["output"] .= $this->afterH3.PHP_EOL.PHP_EOL;
$this->rjs["output"] .= "<WRAP references>~~REFNOTES 4~~</WRAP>".PHP_EOL;
$this->rjs["output"] .= "<----".PHP_EOL.PHP_EOL;
}
$this->rjs["output"] .= PHP_EOL.PHP_EOL.PHP_EOL;
}
}
}
}
/**
* Save generated Dokuwiki ou Markdown output
*/
public function saveOutput() {
$outputFn = "";
// Something to save?
if (empty($this->output)) {
echo "* No dokuwiki or markdown output to write".PHP_EOL;
} else {
$outputFn = $this->_getOutputFileName();
file_put_contents($outputFn, $this->output);
echo "* Writing dokuwiki or markdown output to: ".$outputFn.PHP_EOL;
}
if ($this->_hasRevealOutput()) {
$outputFn = $this->_getOutputFileName(true);
file_put_contents($outputFn, $this->_getRevealOutput());
echo "* Writing RevealJS output to: ".$outputFn.PHP_EOL;
} else {
echo "* No RevealJS output to write".PHP_EOL;
}
echo "* Done".PHP_EOL;
return true;
}
/**
* Return the output filename for the constructed content.
* $forReveal : set to true if you want the filename for the RevealJS part
* \note This function uses the command line options to process the filename
*/
private function _getOutputFileName($forReveal = false) {
$outputFn = "";
// Output specified in the command line options?
if (array_key_exists("o", $this->options) &&
!empty($this->options["o"])) {
$outputFn = $this->options["o"];
} else if (array_key_exists("f", $this->options) &&
!empty($this->options["f"])) {
// No output specified in the command line options -> use input filename
$outputFn = $this->options["f"];
$outputFn = $outputFn.$this->outputExt;
}
//if (empty($outputFn))
// Here we go wrong! No output filename, no filename to process
if ($forReveal) {
$pos = strrpos($outputFn , '.');
$outputFn = substr($outputFn, 0, $pos) . '_revealjs' . substr($outputFn, $pos);
}
return $outputFn;
}
/**
* Add a dokuwiki page {{page>....}}
*/
private function _isExtraPage($node) {
if (strtolower(substr($node->title, 0, 7) === "{{page>")) {
// TODO: problem here (inclure à l'intérieur d'un slide si ce sont les réfs)
//echo print_r($node);
$this->output .= $node->title.PHP_EOL;
$this->rjs["output"] .= PHP_EOL.$node->title.PHP_EOL;
return true;
} else if (strtolower(substr($node->title, 0, 7) === "{{refs>")) {
array_push($this->extraRefs, $node->title);
return true;
} else if (preg_match('~{{format>(.+)}}~', $node->title, $m)) {
$this->formatRefs =$m[1];
return true;
// } else if (preg_match('~{{pmidlist}}~', $node->title, $m)) {
// return true;
}
return false;
}
/**
* Add a dokuwiki page {{page>....}}
*/
private function _isOnlyReference($node) {
$pattern = "/^\[\([^>]+\>.*\)\]$/m";
if (preg_match($pattern, $node->title, $matches)) {
array_push($this->manualRefs, $node->title);
return true;
}
return false;
}
/**
* Find all PMID references in the xmind processed output
* Note that the output must be created before calling this function
*/
private function _extractAllPmidReferences() {
}
/*******************************
* RevealJS specific functions *
*******************************/
/**
* Reveal Node starts with RJ / RJS / REVEAL / REVEALJS node title
*/
private function _isRevealNode($node) {
if (strtolower($node->title) === "rj" ||
strtolower($node->title) === "rjs" ||
strtolower($node->title) === "reveal" ||
strtolower($node->title) === "revealjs"
) {
return true;
}
return false;
}
private function _readRevealNode($node, $level = 0) {
// Don't read extrapage, only reference nodes
if ($this->_isExtraPage($node) ||
$this->_isOnlyReference($node)) {
return true;
}
// Table node
if ($this->_isTableNode($node)) {
$this->_readTableNode($node, $level, true);
return true;
}
// If _isRevealNode
if ($this->_isRevealNode($node)) {
// Here $node is pointing to the RJS root node not the content of the slide
// Check Major RJS red mark ± add to $this->rjs["currentSlideOpt"]
if (property_exists($node, "markers")) {
if (count($node->markers)) {
for($i=0; $i<count($node->markers); $i++) {
if (property_exists($node->markers[$i], "markerId") &&
$node->markers[$i]->markerId === "tag-red") {
$this->rjs["currentSlideOpt"] = "tag-red";
}
}
}
}
// Add last H2 (H1 is the title of the map)
$this->rjs["currentSlide"] .= PHP_EOL.PHP_EOL.PHP_EOL;
$this->rjs["currentSlide"] .= $this->_getSlideBefore().PHP_EOL;
$this->rjs["currentSlide"] .= $this->beforeH2;
$this->rjs["currentSlide"] .= $this->lastH2;
// Add last H3 if exists
if (!empty($this->lastH3) && $level > 2)
$this->rjs["currentSlide"] .= " - ".$this->lastH3;
$this->rjs["currentSlide"] .= $this->afterH2;
$this->rjs["currentSlide"] .= PHP_EOL.PHP_EOL.PHP_EOL;
$this->rjs["currentSlideEmpty"] = true;
$this->rjs["currentSlideNotes"] = "";
$level = 0;
} else {
// Check commands : Titre, Auteurs, Affiliation, Années, Footer
if ($this->_isRevealNodeCommand($node)) {
$this->_readRevealNodeCommand($node, $level);
return true;
}
// No text => add a line-break
if (empty($node->title)) {
$this->rjs["currentSlide"] .= PHP_EOL.$this->styleLf.PHP_EOL;
} else {
// Is background mention?
switch (strtolower($node->title)) {
case "background": case "bg":
// Get values (first child)
if (property_exists($node, "children") &&
property_exists($node->children, "attached")) {
$bg = $node->children->attached[0]->title;
$this->rjs["currentSlide"] = str_replace(":1px.png", $bg, $this->rjs["currentSlide"]);
$this->rjs["currentSlideEmpty"] = false;
return true;
}
break;
case "notes" : case "note" :
// Slide Notes
if (property_exists($node, "children") &&
property_exists($node->children, "attached")) {
// Read all children
foreach($node->children->attached as $noteNode) {
if (property_exists($noteNode, "title"))
$this->rjs["currentSlideNotes"] .= " * ".$noteNode->title.PHP_EOL;
}
$this->rjs["currentSlideEmpty"] = false;
return true;
}
break;
case "option": case "opt":
// Read slide options
// no-footer
// no-title
// no-list
// start_map_here
// Get values (first child)
if (property_exists($node, "children") &&
property_exists($node->children, "attached")) {
foreach($node->children->attached as $o) {
$option = $o->title;
switch ($option) {
case "no-ul": case "no-li": case "no-list":
$this->rjs["currentSlideOpt"] = "no-list";
break;
case "no-footer":
// TODO: improve this with regex
$option = " ".$option." ";
$this->rjs["currentSlide"] = str_replace("---- ", "---- ".$option,
$this->rjs["currentSlide"]);
break;
case "no-title":
$pattern = "/^(".$this->beforeH2.")(.*)(".$this->afterH2.")$/m";
// $rep = "\\1 \\3";
$rep = "";
$this->rjs["currentSlide"] = preg_replace($pattern, $rep,
$this->rjs["currentSlide"], 1);
break;
case "start_map_here":
// Remove all map tag already in output
$this->rjs["output"] = str_replace($this->rjs["mapTag"], "", $this->rjs["output"]);
$this->rjs["map"] = "";
break;
}
$this->rjs["currentSlideEmpty"] = false;
}
return true;
}
break;
} // End Switch
// Add content as a list. Note: with reveal we only keep one header level
// Only if text does not start with <TEXT or <WRAP
if (substr($node->title, 0, 5) !== "<TEXT" &&
substr($node->title, 0, 5) !== "<WRAP")
$indent = $this->_getLineIndent($level, 1);
// Convert LF to dokuwiki/markdown style
$withLf = str_replace("\n", $this->styleLf, $node->title);
// <wrap dugp_red></wrap> a part of the text?
$pattern = "/([^|]*)\|\|([^|]*)\|\|(.*)/";
if (preg_match($pattern, $withLf, $matches)) {
$withLf = preg_replace($pattern, "\\1 <wrap dugp_red>**\\2**</wrap> \\3", $withLf);
}
// <wrap dugp_red></wrap> all title?
if (property_exists($node, "markers")) {
if (count($node->markers)) {
for($i=0; $i<count($node->markers); $i++) {
if (property_exists($node->markers[$i], "markerId") &&
$node->markers[$i]->markerId === "tag-red") {
$withLf = "<wrap dugp_red>**".$withLf."**</wrap>";
}
// tag-⚫ flag-⚑ star-★ people-☻ -> red orange dark-blue blue dark-purple green grey
// task- -> start oct 3oct half 5oct 7oct done
// arrow- -> left⇐ right⇒ up⇑ down⇓ left-right⇔ up-down⇕ refresh↻
// c_symbol_quote c_symbol_apostrophe symbol-question
//$arr = get_object_vars($node->style->properties);
}
}
}
// Get style of the node
if (property_exists($node, "style")
&& property_exists($node->style, "properties")) {
$arr = get_object_vars($node->style->properties);
// Bold?
if (array_key_exists("fo:font-weight", $arr) &&
!empty($arr["fo:font-weight"])) {
if ($arr["fo:font-weight"] === "bold") {
$withLf = $this->preBold.$withLf.$this->postBold;
}
} else
// Italic?
if (array_key_exists("fo:font-style", $arr) &&
!empty($arr["fo:font-style"])) {
if ($arr["fo:font-style"] === "italic") {
$withLf = $this->preItalic.$withLf.$this->postItalic;
}
}
}
// TODO: Get markers markers [0] markerId
//if (property_exists($node, "markers")) {
//echo print_r($node->markers);
// tag-⚫ flag-⚑ star-★ people-☻ -> red orange dark-blue blue dark-purple green grey
// task- -> start oct 3oct half 5oct 7oct done
// arrow- -> left⇐ right⇒ up⇑ down⇓ left-right⇔ up-down⇕ refresh↻
// c_symbol_quote c_symbol_apostrophe symbol-question
//$arr = get_object_vars($node->style->properties);
//}
$this->rjs["currentSlide"] .= $indent.$withLf.PHP_EOL;
}
// This slide is not empty
$this->rjs["currentSlideEmpty"] = false;
}
// Read children
if (property_exists($node, "children")) {
foreach($node->children->attached as $child) {