forked from newsdev/ai2html
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathai2html.js
3066 lines (2746 loc) · 130 KB
/
ai2html.js
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
// ai2html.js
function main() {
// Enclosing scripts in a named function (and not an anonymous, self-executing
// function) has been recommended as a way to minimise intermittent "MRAP" errors.
// (This advice may be superstitious, need more evidence to decide.)
// See (for example) https://forums.adobe.com/thread/1810764 and
// http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/pdf/illustrator/scripting/Readme.txt
// Increment final digit for bug fixes, middle digit for new functionality.
// Remember to add an entry in CHANGELOG when updating the version number.
var scriptVersion = "0.65.5";
// ai2html is a script for Adobe Illustrator that converts your Illustrator document into html and css.
// Copyright (c) 2011-2015 The New York Times Company
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this library except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// =====================================
// How to install ai2html
// =====================================
// - Move the ai2html.js file into the Illustrator folder where scripts are located.
// - For example, on Mac OS X running Adobe Illustrator CC 2014, the path would be: // Adobe Illustrator CC 2014/Presets/en_US/Scripts/ai2html.jsx
// =====================================
// How to use ai2html
// =====================================
// - Create your Illustrator artwork.
// - Size the artboard to the dimensions that you want the div to appear on the web page.
// - Make sure your Document Color Mode is set to RGB.
// - Make sure your document is saved.
// - Use Arial or Georgia unless you have added your own fonts to the fonts array in the script.
// - Run the script by choosing: File > Scripts > ai2html
// - Go to the folder containing your Illustrator file. Inside will be a folder called ai2html-output.
// - Open the html files in your browser to preview your output.
// ================================================
// ai2html and config settings
// ================================================
// Settings can be generated by making a copy of this Google Spreadsheet:
// https://docs.google.com/spreadsheets/d/13ESQ9ktfkdzFq78FkWLGaZr2s3lNbv2cN25F2pYf5XM/edit?usp=sharing
// Make a copy of the spreadsheet for yourself.
// Modify the settings to taste.
// Copy the contents from column Images and replace the settings statements:
var nytBaseSettings = {
ai2html_environment: {defaultValue: scriptEnvironment, includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
settings_version: {defaultValue: scriptVersion, includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
create_promo_image: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
image_format: {defaultValue: ["auto"], includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "array", possibleValues: "jpg, png, png24", notes: "Images will be generated in mulitple formats if multiple formats are listed, separated by commas. The first format will be used in the html. Sometimes this is useful to compare which format will have a smaller file size."},
write_image_files: {defaultValue: "yes", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: "Set this to \u201Cno\u201D to skip writing the image files. Generally only use this after you have run the script once with this setting set to \u201Cyes.\u201D"},
responsiveness: {defaultValue: "fixed", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "fixed, dynamic", notes: "Dynamic responsiveness means ai graphics will scale to fill the container they are placed in."},
max_width: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "integer", possibleValues: "", notes: "Blank or any positive number in pixels, but do not write \u201Cpx\u201D - blank means artboards will set max size, instead it is written to the config file so that the max width can be applied to the template’s container."},
output: {defaultValue: "one-file", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "one-file, multiple-files", notes: "One html file containing all the artboards or a separate html file for each artboard."},
project_name: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: "Use this to set a custom project name. The project name is being used in output filenames, class names, etc."},
html_output_path: {defaultValue: "../src/", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "folderPath", possibleValues: "", notes: "Allows user to change folder to write html files, path should be written relative to ai file location. This is ignored if the project_type in the yml is ai2html."},
html_output_extension: {defaultValue: ".html", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "fileExtension", possibleValues: "", notes: "This is ignored if the project_type in the yml is ai2html."},
image_output_path: {defaultValue: "../public/_assets/", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "folderPath", possibleValues: "", notes: "_assets/ for preview default. This is where the image files get written to locally and should be written as if the html_output location is the starting point."},
image_source_path: {defaultValue: null, includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "folderPath", possibleValues: "", notes: "Use this setting to specify from where the images are being loaded from the HTML file. Defaults to image_output_path"},
create_config_file: {defaultValue: "true", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: "This is ignored in env=nyt."},
config_file_path: {defaultValue: "../config.yml", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "filePath", possibleValues: "", notes: "This only gets used to write the config file. It’s not used in the nyt mode to read the config.yml. Path should written relative to the ai file location."},
local_preview_template: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "filePath", possibleValues: "", notes: ""},
png_transparent: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
png_number_of_colors: {defaultValue: 128, includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "integer", possibleValues: "2 to 256", notes: ""},
jpg_quality: {defaultValue: 60, includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "integer", possibleValues: "0 to 100", notes: ""},
center_html_output: {defaultValue: "true", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: "Adds \u201Cmargin:0 auto;\u201D to the div containing the ai2html output."},
use_2x_images_if_possible: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
use_lazy_loader: {defaultValue: "yes", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
include_resizer_css_js: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
include_resizer_classes: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
include_resizer_widths: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
include_resizer_script: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
svg_embed_images: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
render_rotated_skewed_text_as: {defaultValue: "html", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "image, html", notes: ""},
show_completion_dialog_box: {defaultValue: "true", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: "Set this to false if you don't want to see the dialog box confirming completion of the script."},
clickable_link: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: "If you put a url in this field, an <a> tag will be added, wrapping around the output and pointing to that url."},
testing_mode: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
last_updated_text: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
headline: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
leadin: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
summary: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: "Summary field for Scoop assets"},
notes: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
sources: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
credit: {defaultValue: "By The New York Times", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
page_template: {defaultValue: "nyt5-article-embed", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
publish_system: {defaultValue: "scoop", includeInSettingsBlock: false, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
environment: {defaultValue: "production", includeInSettingsBlock: false, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
show_in_compatible_apps: {defaultValue: "yes", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "yesNo", possibleValues: "", notes: ""},
display_for_promotion_only: {defaultValue: "false", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: ""},
constrain_width_to_text_column: {defaultValue: "false", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: ""},
scoop_publish_fields: {defaultValue: "true", includeInSettingsBlock: false, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: ""},
scoop_asset_id: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
scoop_username: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
scoop_slug: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
scoop_external_edit_key: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""}
};
var defaultBaseSettings = {
ai2html_environment: {defaultValue: scriptEnvironment, includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
settings_version: {defaultValue: scriptVersion, includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
create_promo_image: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
image_format: {defaultValue: ["auto"], includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "array", possibleValues: "jpg, png, png24", notes: "Images will be generated in mulitple formats if multiple formats are listed, separated by commas. The first format will be used in the html. Sometimes this is useful to compare which format will have a smaller file size."},
write_image_files: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: "Set this to \u201Cno\u201D to skip writing the image files. Generally only use this after you have run the script once with this setting set to \u201Cyes.\u201D"},
responsiveness: {defaultValue: "fixed", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "fixed, dynamic", notes: "Dynamic responsiveness means ai graphics will scale to fill the container they are placed in."},
max_width: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "integer", possibleValues: "", notes: "Blank or any positive number in pixels, but do not write \u201Cpx\u201D - blank means artboards will set max size, the max width is not included in the html stub, instead it is written to the config file so that the max width can be applied to the template’s container."},
output: {defaultValue: "one-file", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "one-file, multiple-files", notes: "One html file containing all the artboards or a separate html file for each artboard."},
project_name: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: "Use this to set a custom project name. The project name is being used in output filenames, class names, etc."},
html_output_path: {defaultValue: "/ai2html-output/", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "folderPath", possibleValues: "", notes: "Allows user to change folder to write html files, path should be written relative to ai file location. This is ignored if the project_type in the yml is ai2html."},
html_output_extension: {defaultValue: ".html", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "fileExtension", possibleValues: "", notes: "This is ignored if the project_type in the yml is ai2html."},
image_output_path: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "folderPath", possibleValues: "", notes: "This is where the image files get written to locally and should be written as if the html_output is the starting point."},
image_source_path: {defaultValue: null, includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "folderPath", possibleValues: "", notes: "Use this setting to specify from where the images are being loaded from the HTML file. Defaults to image_output_path"},
create_config_file: {defaultValue: "false", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: "This is ignored in env=nyt."},
config_file_path: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "filePath", possibleValues: "", notes: "This only gets used to write the config file. It’s not used in the nyt mode to read the config.yml. Path should written relative to the ai file location."},
local_preview_template: {defaultValue: "", includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "filePath", possibleValues: "", notes: ""},
png_transparent: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
png_number_of_colors: {defaultValue: 128, includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "integer", possibleValues: "2 to 256", notes: ""},
jpg_quality: {defaultValue: 60, includeInSettingsBlock: true, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "integer", possibleValues: "0 to 100", notes: ""},
center_html_output: {defaultValue: "true", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: "Adds \u201Cmargin:0 auto;\u201D to the div containing the ai2html output."},
use_2x_images_if_possible: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
use_lazy_loader: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
include_resizer_css_js: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
include_resizer_classes: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
include_resizer_widths: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: "If set to \u201Cyes\u201D, ai2html adds data-min-width and data-max-width attributes to each artboard"},
include_resizer_script: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
svg_embed_images: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
render_rotated_skewed_text_as: {defaultValue: "html", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "image, html", notes: ""},
show_completion_dialog_box: {defaultValue: "yes", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: "Set this to \u201Cno\u201D if you don't want to see the dialog box confirming completion of the script."},
clickable_link: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: "If you put a url in this field, an <a> tag will be added, wrapping around the output and pointing to that url."},
testing_mode: {defaultValue: "no", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "yesNo", possibleValues: "", notes: ""},
last_updated_text: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
headline: {defaultValue: "Ai Graphic Headline", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
leadin: {defaultValue: "Introductory text here.", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
summary: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: "Summary field for Scoop assets"},
notes: {defaultValue: "Notes: Text goes here.", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
sources: {defaultValue: "Source: Name goes here.", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
credit: {defaultValue: "By ai2html", includeInSettingsBlock: true, includeInConfigFile: true, useQuoteMarksInConfigFile: true, inputType: "text", possibleValues: "", notes: ""},
page_template: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
publish_system: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
environment: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
show_in_compatible_apps: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: true, inputType: "yesNo", possibleValues: "", notes: ""},
display_for_promotion_only: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: ""},
constrain_width_to_text_column: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: ""},
scoop_publish_fields: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "trueFalse", possibleValues: "", notes: ""},
scoop_asset_id: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
scoop_username: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
scoop_slug: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""},
scoop_external_edit_key: {defaultValue: "", includeInSettingsBlock: false, includeInConfigFile: false, useQuoteMarksInConfigFile: false, inputType: "text", possibleValues: "", notes: ""}
};
// End of settings blocks copied from Google Spreadsheet.
// ================================================
// Constant data
// ================================================
// html entity substitution
// not used ==> ["\x22","""], ["\x3C","<"], ["\x3E",">"], ["\x26","&"],
var htmlCharacterCodes = [["\xA0"," "], ["\xA1","¡"], ["\xA2","¢"], ["\xA3","£"], ["\xA4","¤"], ["\xA5","¥"], ["\xA6","¦"], ["\xA7","§"], ["\xA8","¨"], ["\xA9","©"], ["\xAA","ª"], ["\xAB","«"], ["\xAC","¬"], ["\xAD","­"], ["\xAE","®"], ["\xAF","¯"], ["\xB0","°"], ["\xB1","±"], ["\xB2","²"], ["\xB3","³"], ["\xB4","´"], ["\xB5","µ"], ["\xB6","¶"], ["\xB7","·"], ["\xB8","¸"], ["\xB9","¹"], ["\xBA","º"], ["\xBB","»"], ["\xBC","¼"], ["\xBD","½"], ["\xBE","¾"], ["\xBF","¿"], ["\xD7","×"], ["\xF7","÷"], ["\u0192","ƒ"], ["\u02C6","ˆ"], ["\u02DC","˜"], ["\u2002"," "], ["\u2003"," "], ["\u2009"," "], ["\u200C","‌"], ["\u200D","‍"], ["\u200E","‎"], ["\u200F","‏"], ["\u2013","–"], ["\u2014","—"], ["\u2018","‘"], ["\u2019","’"], ["\u201A","‚"], ["\u201C","“"], ["\u201D","”"], ["\u201E","„"], ["\u2020","†"], ["\u2021","‡"], ["\u2022","•"], ["\u2026","…"], ["\u2030","‰"], ["\u2032","′"], ["\u2033","″"], ["\u2039","‹"], ["\u203A","›"], ["\u203E","‾"], ["\u2044","⁄"], ["\u20AC","€"], ["\u2111","ℑ"], ["\u2113",""], ["\u2116",""], ["\u2118","℘"], ["\u211C","ℜ"], ["\u2122","™"], ["\u2135","ℵ"], ["\u2190","←"], ["\u2191","↑"], ["\u2192","→"], ["\u2193","↓"], ["\u2194","↔"], ["\u21B5","↵"], ["\u21D0","⇐"], ["\u21D1","⇑"], ["\u21D2","⇒"], ["\u21D3","⇓"], ["\u21D4","⇔"], ["\u2200","∀"], ["\u2202","∂"], ["\u2203","∃"], ["\u2205","∅"], ["\u2207","∇"], ["\u2208","∈"], ["\u2209","∉"], ["\u220B","∋"], ["\u220F","∏"], ["\u2211","∑"], ["\u2212","−"], ["\u2217","∗"], ["\u221A","√"], ["\u221D","∝"], ["\u221E","∞"], ["\u2220","∠"], ["\u2227","∧"], ["\u2228","∨"], ["\u2229","∩"], ["\u222A","∪"], ["\u222B","∫"], ["\u2234","∴"], ["\u223C","∼"], ["\u2245","≅"], ["\u2248","≈"], ["\u2260","≠"], ["\u2261","≡"], ["\u2264","≤"], ["\u2265","≥"], ["\u2282","⊂"], ["\u2283","⊃"], ["\u2284","⊄"], ["\u2286","⊆"], ["\u2287","⊇"], ["\u2295","⊕"], ["\u2297","⊗"], ["\u22A5","⊥"], ["\u22C5","⋅"], ["\u2308","⌈"], ["\u2309","⌉"], ["\u230A","⌊"], ["\u230B","⌋"], ["\u2329","⟨"], ["\u232A","⟩"], ["\u25CA","◊"], ["\u2660","♠"], ["\u2663","♣"], ["\u2665","♥"], ["\u2666","♦"]];
// Add to the fonts array to make the script work with your own custom fonts.
// To make it easier to add to this array, use the "fonts" worksheet of this Google Spreadsheet:
// https://docs.google.com/spreadsheets/d/13ESQ9ktfkdzFq78FkWLGaZr2s3lNbv2cN25F2pYf5XM/edit?usp=sharing
// Make a copy of the spreadsheet for yourself.
// Modify the settings to taste.
var fonts = [
{"aifont":"ArialMT","family":"arial,helvetica,sans-serif","weight":"","style":""},
{"aifont":"Arial-BoldMT","family":"arial,helvetica,sans-serif","weight":"bold","style":""},
{"aifont":"Arial-ItalicMT","family":"arial,helvetica,sans-serif","weight":"","style":"italic"},
{"aifont":"Arial-BoldItalicMT","family":"arial,helvetica,sans-serif","weight":"bold","style":"italic"},
{"aifont":"Georgia","family":"georgia,'times new roman',times,serif","weight":"","style":""},
{"aifont":"Georgia-Bold","family":"georgia,'times new roman',times,serif","weight":"bold","style":""},
{"aifont":"Georgia-Italic","family":"georgia,'times new roman',times,serif","weight":"","style":"italic"},
{"aifont":"Georgia-BoldItalic","family":"georgia,'times new roman',times,serif","weight":"bold","style":"italic"},
{"aifont":"NYTFranklin-Light","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"300","style":""},
{"aifont":"NYTFranklin-Medium","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"500","style":""},
{"aifont":"NYTFranklin-SemiBold","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"600","style":""},
{"aifont":"NYTFranklin-Semibold","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"600","style":""},
{"aifont":"NYTFranklinSemiBold-Regular","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"600","style":""},
{"aifont":"NYTFranklin-SemiboldItalic","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"600","style":"italic"},
{"aifont":"NYTFranklin-Bold","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"700","style":""},
{"aifont":"NYTFranklin-LightItalic","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"300","style":"italic"},
{"aifont":"NYTFranklin-MediumItalic","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"500","style":"italic"},
{"aifont":"NYTFranklin-BoldItalic","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"700","style":"italic"},
{"aifont":"NYTFranklin-ExtraBold","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"800","style":""},
{"aifont":"NYTFranklin-ExtraBoldItalic","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"800","style":"italic"},
{"aifont":"NYTFranklin-Headline","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"bold","style":""},
{"aifont":"NYTFranklin-HeadlineItalic","family":"nyt-franklin,arial,helvetica,sans-serif","weight":"bold","style":"italic"},
{"aifont":"NYTCheltenham-ExtraLight","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"200","style":""},
{"aifont":"NYTCheltenhamExtLt-Regular","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"200","style":""},
{"aifont":"NYTCheltenham-Light","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"300","style":""},
{"aifont":"NYTCheltenhamLt-Regular","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"300","style":""},
{"aifont":"NYTCheltenham-LightSC","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"300","style":""},
{"aifont":"NYTCheltenham-Book","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"400","style":""},
{"aifont":"NYTCheltenhamBook-Regular","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"400","style":""},
{"aifont":"NYTCheltenham-Wide","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"","style":""},
{"aifont":"NYTCheltenhamMedium-Regular","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"500","style":""},
{"aifont":"NYTCheltenham-Medium","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"500","style":""},
{"aifont":"NYTCheltenham-Bold","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"700","style":""},
{"aifont":"NYTCheltenham-BoldCond","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"bold","style":""},
{"aifont":"NYTCheltenhamCond-BoldXC","family":"nyt-cheltenham-extra-cn-bd,georgia,'times new roman',times,serif","weight":"bold","style":""},
{"aifont":"NYTCheltenham-BoldExtraCond","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"bold","style":""},
{"aifont":"NYTCheltenham-ExtraBold","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"bold","style":""},
{"aifont":"NYTCheltenham-ExtraLightIt","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"","style":"italic"},
{"aifont":"NYTCheltenham-ExtraLightItal","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"","style":"italic"},
{"aifont":"NYTCheltenham-LightItalic","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"","style":"italic"},
{"aifont":"NYTCheltenham-BookItalic","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"","style":"italic"},
{"aifont":"NYTCheltenham-WideItalic","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"","style":"italic"},
{"aifont":"NYTCheltenham-MediumItalic","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"","style":"italic"},
{"aifont":"NYTCheltenham-BoldItalic","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"700","style":"italic"},
{"aifont":"NYTCheltenham-ExtraBoldItal","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"bold","style":"italic"},
{"aifont":"NYTCheltenham-ExtraBoldItalic","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"bold","style":"italic"},
{"aifont":"NYTCheltenhamSH-Regular","family":"nyt-cheltenham-sh,nyt-cheltenham,georgia,'times new roman',times,serif","weight":"400","style":""},
{"aifont":"NYTCheltenhamSH-Italic","family":"nyt-cheltenham-sh,nyt-cheltenham,georgia,'times new roman',times,serif","weight":"400","style":"italic"},
{"aifont":"NYTCheltenhamSH-Bold","family":"nyt-cheltenham-sh,nyt-cheltenham,georgia,'times new roman',times,serif","weight":"700","style":""},
{"aifont":"NYTCheltenhamSH-BoldItalic","family":"nyt-cheltenham-sh,nyt-cheltenham,georgia,'times new roman',times,serif","weight":"700","style":"italic"},
{"aifont":"NYTCheltenhamWide-Regular","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"500","style":""},
{"aifont":"NYTCheltenhamWide-Italic","family":"nyt-cheltenham,georgia,'times new roman',times,serif","weight":"500","style":"italic"},
{"aifont":"NYTKarnakText-Regular","family":"nyt-karnak-display-130124,georgia,'times new roman',times,serif","weight":"400","style":""},
{"aifont":"NYTKarnakDisplay-Regular","family":"nyt-karnak-display-130124,georgia,'times new roman',times,serif","weight":"400","style":""},
{"aifont":"NYTStymieLight-Regular","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"300","style":""},
{"aifont":"NYTStymieMedium-Regular","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"500","style":""},
{"aifont":"StymieNYT-Light","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"300","style":""},
{"aifont":"StymieNYT-LightPhoenetic","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"300","style":""},
{"aifont":"StymieNYT-Lightitalic","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"300","style":"italic"},
{"aifont":"StymieNYT-Medium","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"500","style":""},
{"aifont":"StymieNYT-MediumItalic","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"500","style":"italic"},
{"aifont":"StymieNYT-Bold","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"700","style":""},
{"aifont":"StymieNYT-BoldItalic","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"700","style":"italic"},
{"aifont":"StymieNYT-ExtraBold","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"700","style":""},
{"aifont":"StymieNYT-ExtraBoldText","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"700","style":""},
{"aifont":"StymieNYT-ExtraBoldTextItal","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"700","style":"italic"},
{"aifont":"StymieNYTBlack-Regular","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"700","style":""},
{"aifont":"StymieBT-ExtraBold","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"700","style":""},
{"aifont":"Stymie-Thin","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"300","style":""},
{"aifont":"Stymie-UltraLight","family":"nyt-stymie,arial,helvetica,sans-serif","weight":"300","style":""},
{"aifont":"NYTMagSans-Regular","family":"'nyt-mag-sans',arial,helvetica,sans-serif","weight":"500","style":""},
{"aifont":"NYTMagSans-Bold","family":"'nyt-mag-sans',arial,helvetica,sans-serif","weight":"700","style":""}
];
// CSS text-transform equivalents
var caps = [
{"ai":"FontCapsOption.NORMALCAPS","html":"none"},
{"ai":"FontCapsOption.ALLCAPS","html":"uppercase"},
{"ai":"FontCapsOption.SMALLCAPS","html":"uppercase"}
];
// CSS text-align equivalents
var align = [
{"ai":"Justification.LEFT","html":"left"},
{"ai":"Justification.RIGHT","html":"right"},
{"ai":"Justification.CENTER","html":"center"},
{"ai":"Justification.FULLJUSTIFY","html":"justify"},
{"ai":"Justification.FULLJUSTIFYLASTLINELEFT","html":"justify"},
{"ai":"Justification.FULLJUSTIFYLASTLINECENTER","html":"justify"},
{"ai":"Justification.FULLJUSTIFYLASTLINERIGHT","html":"justify"}
];
var blendModes = [
{ai: "BlendModes.MULTIPLY", html: "multiply"}
];
// list of CSS properties used for translating AI text styles
var cssTextStyleProperties = [
'font-family',
'font-size',
'font-weight',
'font-style',
'color',
'line-height',
'letter-spacing',
'opacity',
'padding-top',
'padding-bottom',
'text-align',
'text-transform',
'mix-blend-mode'
];
var nyt5Breakpoints = [
{ name:"xsmall" , lowerLimit: 0, upperLimit: 180 },
{ name:"small" , lowerLimit: 180, upperLimit: 300 },
{ name:"smallplus" , lowerLimit: 300, upperLimit: 460 },
{ name:"submedium" , lowerLimit: 460, upperLimit: 600 },
{ name:"medium" , lowerLimit: 600, upperLimit: 720 },
{ name:"large" , lowerLimit: 720, upperLimit: 945 },
{ name:"xlarge" , lowerLimit: 945, upperLimit:1050 },
{ name:"xxlarge" , lowerLimit:1050, upperLimit:1600 }
];
// TODO: add these to settings spreadsheet
var nameSpace = "g-";
var cssPrecision = 4;
// If all three RBG channels (0-255) are below this value, convert text fill to pure black.
var rgbBlackThreshold = 36;
var showDebugMessages = true; // add text logged with message() function to completion alert
// ================================
// Variable declarations
// ================================
// vars to hold warnings and informational messages at the end
var feedback = [];
var warnings = [];
var errors = [];
var oneTimeWarnings = [];
var textFramesToUnhide = [];
var objectsToRelock = [];
// Global variables set by main()
var docSettings = {};
var ai2htmlBaseSettings;
var previewProjectType, scriptEnvironment;
var doc, docPath, docName, docIsSaved;
var pBar, T;
// ===========================================================
// If running in Node.js: export functions for testing and exit
// ===========================================================
if (runningInNode()) {
[ testBoundsIntersection,
trim,
stringToLines,
contains,
arraySubtract,
firstBy,
zeroPad,
roundTo,
folderExists,
formatCss,
getCssColor,
readGitConfigFile,
readYamlConfigFile,
applyTemplate,
cleanText,
findHtmlTag,
cleanHtmlTags,
convertSettingsToYaml,
parseDataAttributes,
parseArtboardName,
initDocumentSettings
].forEach(function(f) {
module.exports[f.name] = f;
});
return;
}
if (!isTestedIllustratorVersion(app.version)) {
warnings.push("Ai2html has not been tested on this version of Illustrator.");
}
if (!app.documents.length) {
errors.push("No documents are open");
} else if (!String(app.activeDocument.path)) {
errors.push("You need to save your Illustrator file before running this script");
} else if (app.activeDocument.documentColorSpace != DocumentColorSpace.RGB) {
errors.push("You should change the document color mode to \"RGB\" before running ai2html (File>Document Color Mode>RGB Color).");
} else if (app.activeDocument.activeLayer.name == "Isolation Mode") {
errors.push("Ai2html is unable to run because the document is in Isolation Mode.");
} else if (app.activeDocument.activeLayer.name == "<Opacity Mask>" && app.activeDocument.layers.length == 1) {
// TODO: find a better way to detect this condition (mask can be renamed)
errors.push("Ai2html is unable to run because you are editing an Opacity Mask.");
} else {
// initialize global variables
doc = app.activeDocument;
docPath = doc.path + "/";
docIsSaved = doc.saved;
scriptEnvironment = detectScriptEnvironment();
initDocumentSettings(scriptEnvironment);
}
if (errors.length === 0) {
validateArtboardNames();
initUtilityFunctions(); // init T and JSON
T.start();
try {
render();
} catch(e) {
errors.push(formatError(e));
}
restoreDocumentState();
}
// ==========================================
// Save the AI document (if needed)
// ==========================================
if (docIsSaved) {
// If document was originally in a saved state, reset the document's
// saved flag (the document goes to unsaved state during the script,
// because of unlocking / relocking of objects
doc.saved = true;
} else if (errors.length === 0) {
// Auto-save the document if no errors occurred
var saveOptions = new IllustratorSaveOptions();
saveOptions.pdfCompatible = false;
doc.saveAs(new File(docPath + doc.name), saveOptions);
feedback.push("Your Illustrator file was saved.");
}
if (pBar) pBar.close();
if (T) message("Script ran in", (T.stop() / 1000).toFixed(1), "seconds");
// =========================================================
// Show alert box, optionally prompt to generate promo image
// =========================================================
if (isTrue(docSettings.show_completion_dialog_box ) || errors.length > 0) {
var promptForPromo = errors.length === 0 && isTrue(docSettings.write_image_files) &&
(previewProjectType == "ai2html" || isTrue(docSettings.create_promo_image));
var showPromo = showCompletionAlert(promptForPromo);
if (showPromo) createPromoImage(docSettings);
}
// =================================
// ai2html render function
// =================================
function render() {
// Fix for issue #50
// If a text range is selected when the script runs, it interferes
// with script-driven selection. The fix is to clear this kind of selection.
if (doc.selection && doc.selection.typename) {
clearSelection();
}
// ================================================
// grab custom settings, html, css, js and text blocks
// ================================================
var documentHasSettingsBlock = false;
var customBlocks = {};
var customRxp = /^ai2html-(css|js|html|settings|text)\s*$/;
forEach(doc.textFrames, function(thisFrame) {
// var contents = thisFrame.contents; // caused MRAP error in AI 2017
var type = null;
var match, entries;
if (thisFrame.lines.length > 1) {
match = customRxp.exec(thisFrame.lines[0].contents);
type = match ? match[1] : null;
}
if (!type) return; // not a settings block
entries = stringToLines(thisFrame.contents);
entries.shift(); // remove header
if (type == 'settings') {
documentHasSettingsBlock = true;
parseSettingsEntries(entries, docSettings);
} else if (type == 'text') {
parseSettingsEntries(entries, docSettings);
} else { // custom js, css and html
if (!customBlocks[type]) {
customBlocks[type] = [];
}
customBlocks[type].push("\t\t" + cleanText(entries.join("\r\t\t")) + "\r");
}
if (objectOverlapsAnArtboard(thisFrame)) {
hideTextFrame(thisFrame);
}
});
if (customBlocks.css) {feedback.push("Custom CSS blocks: " + customBlocks.css.length);}
if (customBlocks.html) {feedback.push("Custom HTML blocks: " + customBlocks.html.length);}
if (customBlocks.js) {feedback.push("Custom JS blocks: " + customBlocks.js.length);}
// ================================================
// add settings text block if one does not exist
// ================================================
if (!documentHasSettingsBlock) {
createSettingsBlock();
if (scriptEnvironment=="nyt") {
feedback.push("A settings text block was created to the left of all your artboards. Fill out the settings to link your project to the Scoop asset.");
return; // Exit the script
} else {
feedback.push("A settings text block was created to the left of all your artboards. You can use it to customize your output.");
}
}
// ================================================
// assign artboards to their corresponding breakpoints
// ================================================
// (can have more than one artboard per breakpoint.)
var breakpoints = assignBreakpointsToArtboards(nyt5Breakpoints);
// ================================================
// initialization for NYT environment
// ================================================
if (scriptEnvironment == "nyt") {
// Read yml file to determine what type of project this is
// (yml file should be confirmed to exist when nyt environment is set)
var yaml = readYamlConfigFile(docPath + "../config.yml") || {};
previewProjectType = yaml.project_type == 'ai2html' ? 'ai2html' : '';
if ((previewProjectType=="ai2html" && !folderExists(docPath + "../public/")) ||
(previewProjectType!="ai2html" && !folderExists(docPath + "../src/"))) {
errors.push("Make sure your Illustrator file is inside the \u201Cai\u201D folder of a Preview project.");
errors.push("If the Illustrator file is in the correct folder, your Preview project may be missing a \u201Cpublic\u201D or a \u201Csrc\u201D folder.");
errors.push("If this is an ai2html project, it is probably easier to just create a new ai2html Preview project and move this Illustrator file into the \u201Cai\u201D folder inside the project.");
return;
}
if (yaml.scoop_slug) {
docSettings.scoop_slug_from_config_yml = yaml.scoop_slug;
}
// Read .git/config file to get preview slug
var gitConfig = readGitConfigFile(docPath + "../.git/config") || {};
if (gitConfig.url) {
docSettings.preview_slug = gitConfig.url.replace( /^[^:]+:/ , "" ).replace( /\.git$/ , "");
}
docSettings.image_source_path = "_assets/";
if (previewProjectType == "ai2html") {
docSettings.html_output_path = "/../public/";
docSettings.html_output_extension = ".html";
docSettings.image_output_path = "_assets/";
}
if (docSettings.max_width && !contains(breakpoints, function(bp) {
return +docSettings.max_width == bp.upperLimit;
})) {
warnings.push('The max_width setting of "' + docSettings.max_width +
'" is not a valid breakpoint and will create an error when you "preview publish."');
}
}
// ================================================
// initialization for all environments
// ================================================
docName = docSettings.project_name || doc.name.replace(/(.+)\.[aieps]+$/,"$1").replace(/ +/g,"-");
docName = makeKeyword(docName);
if (docSettings.image_source_path === null) {
docSettings.image_source_path = docSettings.image_output_path;
}
if (docSettings.image_format.length === 0) {
warnings.push("No images were created because no image formats were specified.");
} else if (contains(docSettings.image_format, "auto")) {
docSettings.image_format = [documentContainsVisibleRasterImages() ? 'jpg' : 'png'];
} else if (documentContainsVisibleRasterImages() && !contains(docSettings.image_format, "jpg")) {
warnings.push("An artboard contains a raster image -- consider exporting to jpg instead of " +
docSettings.image_format[0] + ".");
}
// ================================================
// Generate HTML, CSS and images for each artboard
// ================================================
pBar = new ProgressBar({name: "Ai2html progress", steps: calcProgressBarSteps()});
unlockObjects(); // Unlock containers and clipping masks
var masks = findMasks(); // identify all clipping masks and their contents
var artboardContent = {html: "", css: "", js: ""};
forEachUsableArtboard(function(activeArtboard, abNumber) {
var abSettings = getArtboardSettings(activeArtboard);
var docArtboardName = getArtboardFullName(activeArtboard);
var textFrames, textData;
doc.artboards.setActiveArtboardIndex(abNumber);
// ========================
// Convert text objects
// ========================
if (abSettings.image_only) {
textFrames = [];
textData = {html: "", styles: []};
} else {
pBar.setTitle(docArtboardName + ': Generating text...');
textFrames = getTextFramesByArtboard(activeArtboard, masks);
textData = convertTextFrames(textFrames, activeArtboard);
}
pBar.step();
// ==========================
// generate artboard image(s)
// ==========================
if (isTrue(docSettings.write_image_files)) {
pBar.setTitle(docArtboardName + ': Capturing image...');
captureArtboardImage(activeArtboard, textFrames, masks, docSettings);
}
pBar.step();
//=====================================
// finish generating artboard HTML and CSS
//=====================================
artboardContent.html += "\r\t<!-- Artboard: " + getArtboardName(activeArtboard) + " -->\r" +
generateArtboardDiv(activeArtboard, breakpoints, docSettings) +
generateImageHtml(activeArtboard, docSettings) +
textData.html +
"\t</div>\r";
artboardContent.css += generateArtboardCss(activeArtboard, textData.styles, docSettings);
/*
artboardContent +=
"\r\t<!-- Artboard: " + getArtboardName(activeArtboard) + " -->\r" +
generateArtboardDiv(activeArtboard, breakpoints, docSettings) +
generateArtboardCss(activeArtboard, textData.styles, docSettings) +
generateImageHtml(activeArtboard, docSettings) +
textData.html +
"\t</div>\r";
*/
//=====================================
// output html file here if doing a file for every artboard
//=====================================
if (docSettings.output=="multiple-files") {
addCustomContent(artboardContent, customBlocks);
generateOutputHtml(artboardContent, docArtboardName, docSettings);
artboardContent = {html: "", css: "", js: ""};
}
}); // end artboard loop
//=====================================
// output html file here if doing one file for all artboards
//=====================================
if (docSettings.output=="one-file") {
addCustomContent(artboardContent, customBlocks);
generateOutputHtml(artboardContent, docName, docSettings);
}
//=====================================
// write configuration file with graphic metadata
//=====================================
if ((scriptEnvironment=="nyt" && previewProjectType=="ai2html") ||
(scriptEnvironment!="nyt" && isTrue(docSettings.create_config_file))) {
// TODO: switch to this? (scriptEnvironment!="nyt" && docSettings.config_file_path)) {
var yamlPath = docPath + docSettings.config_file_path,
yamlStr = generateYamlFileContent(breakpoints, docSettings);
checkForOutputFolder(yamlPath.replace(/[^\/]+$/, ""), "configFileFolder");
saveTextFile(yamlPath, yamlStr);
}
} // end render()
// =================================
// JS utility functions
// =================================
function forEach(arr, cb) {
for (var i=0, n=arr.length; i<n; i++) {
cb(arr[i], i);
}
}
function map(arr, cb) {
var arr2 = [];
for (var i=0, n=arr.length; i<n; i++) {
arr2.push(cb(arr[i], i));
}
return arr2;
}
function filter(arr, test) {
var filtered = [];
for (var i=0, n=arr.length; i<n; i++) {
if (test(arr[i], i)) {
filtered.push(arr[i]);
}
}
return filtered;
}
// obj: value or test function
function indexOf(arr, obj) {
var test = typeof obj == 'function' ? obj : null;
for (var i=0, n=arr.length; i<n; i++) {
if (test ? test(arr[i]) : arr[i] === obj) {
return i;
}
}
return -1;
}
function find(arr, obj) {
var i = indexOf(arr, obj);
return i == -1 ? null : arr[i];
}
function contains(arr, obj) {
return indexOf(arr, obj) >= 0;
}
function extend(o) {
for (var i=1; i<arguments.length; i++) {
forEachProperty(arguments[i], add);
}
function add(v, k) {
o[k] = v;
}
return o;
}
function forEachProperty(o, cb) {
for (var k in o) {
if (o.hasOwnProperty(k)) {
cb(o[k], k);
}
}
}
// Return new object containing properties that are in a but not b
// Return null if output object would be empty
// a, b: JS objects
function objectSubtract(a, b) {
var diff = null;
for (var k in a) {
if (a[k] != b[k] && a.hasOwnProperty(k)) {
diff = diff || {};
diff[k] = a[k];
}
}
return diff;
}
// return elements in array "a" but not in array "b"
function arraySubtract(a, b) {
var diff = [],
alen = a.length,
blen = b.length,
i, j;
for (i=0; i<alen; i++) {
diff.push(a[i]);
for (j=0; j<blen; j++) {
if (a[i] === b[j]) {
diff.pop();
break;
}
}
}
return diff;
}
// Copy elements of an array-like object to an array
function toArray(obj) {
var arr = [];
for (var i=0, n=obj.length; i<n; i++) {
arr[i] = obj[i];
}
return arr;
}
// multiple key sorting function based on https://github.com/Teun/thenBy.js
// first by length of name, then by population, then by ID
// data.sort(
// firstBy(function (v1, v2) { return v1.name.length - v2.name.length; })
// .thenBy(function (v1, v2) { return v1.population - v2.population; })
// .thenBy(function (v1, v2) { return v1.id - v2.id; });
// );
function firstBy(f1, f2) {
var compare = f2 ? function(a, b) {return f1(a, b) || f2(a, b);} : f1;
compare.thenBy = function(f) {return firstBy(compare, f);};
return compare;
}
function keys(obj) {
var keys = [];
for (var k in obj) {
keys.push(k);
}
return keys;
}
// Remove whitespace from beginning and end of a string
function trim(s) {
return s.replace(/^[\s\uFEFF\xA0\x03]+|[\s\uFEFF\xA0\x03]+$/g, '');
}
// splits a string into non-empty lines
function stringToLines(str) {
var empty = /^\s*$/;
return filter(str.split(/[\r\n\x03]+/), function(line) {
return !empty.test(line);
});
}
function zeroPad(val, digits) {
var str = String(val);
while (str.length < digits) str = '0' + str;
return str;
}
function truncateString(str, maxlen) {
// TODO: add ellipsis, truncate at word boundary
if (str.length > maxlen) {
str = str.substr(0, maxlen);
}
return str;
}
function makeKeyword(text) {
return text.replace( /[^A-Za-z0-9_\-]+/g , "_" );
}
function cleanText(text) {
for (var i=0; i < htmlCharacterCodes.length; i++) {
var charCode = htmlCharacterCodes[i];
if (text.indexOf(charCode[0]) > -1) {
text = text.replace(new RegExp(charCode[0],'g'), charCode[1]);
}
}
return text;
}
function straightenCurlyQuotesInsideAngleBrackets(text) {
// This function's purpose is to fix quoted properties in HTML tags that were
// typed into text blocks (Illustrator tends to automatically change single
// and double quotes to curly quotes).
// thanks to jashkenas
var tagFinder = /<[^\n]+?>/g;
var quoteFinder = /[\u201C‘’\u201D]([^\n]*?)[\u201C‘’\u201D]/g;
return text.replace(tagFinder, function(tag){
return tag.replace( /[\u201C\u201D]/g , '"' ).replace( /[‘’]/g , "'" );
});
}
// Not very robust -- good enough for printing a warning
function findHtmlTag(str) {
var match;
if (str.indexOf('<') > -1) { // bypass regex check
match = /<(\w+)[^>]*>/.exec(str);
}
return match ? match[1] : null;
}
// precision: number of decimals in rounded number
function roundTo(number, precision) {
var d = Math.pow(10, precision || 0);
return Math.round(number * d) / d;
}
function getDateTimeStamp() {
var d = new Date();
var year = d.getFullYear();
var date = zeroPad(d.getDate(),2);
var month = zeroPad(d.getMonth() + 1,2);
var hour = zeroPad(d.getHours(),2);
var min = zeroPad(d.getMinutes(),2);
return year + "-" + month + "-" + date + " " + hour + ":" + min;
}
// obj: JS object containing css properties and values
// indentStr: string to use as block CSS indentation
function formatCss(obj, indentStr) {
var css = '';
var isBlock = !!indentStr;
for (var key in obj) {
if (isBlock) {
css += '\r' + indentStr;
}
css += key + ':' + obj[key]+ ';';
}
if (css && isBlock) {
css += '\r';
}
return css;
}
function getCssColor(r, g, b, opacity) {
var col, o;
if (opacity > 0 && opacity < 100) {
o = roundTo(opacity / 100, 2);
col = 'rgba(' + r + ',' + g + ',' + b + ',' + o + ')';
} else {
col = 'rgb(' + r + ',' + g + ',' + b + ')';
}
return col;
}
// Test if two rectangles are the same, to within a given tolerance
// a, b: two arrays containing AI rectangle coordinates
// maxOffs: maximum pixel deviation on any side
function testSimilarBounds(a, b, maxOffs) {
if (maxOffs >= 0 === false) maxOffs = 1;
for (var i=0; i<4; i++) {
if (Math.abs(a[i] - b[i]) > maxOffs) return false;
}
return true;
}
// Apply very basic string substitution to a template
function applyTemplate(template, replacements) {
var keyExp = '([_a-zA-Z][\\w-]*)';
var mustachePattern = new RegExp("\\{\\{\\{? *" + keyExp + " *\\}\\}\\}?","g");
var ejsPattern = new RegExp("<%=? *" + keyExp + " *%>","g");
var replace = function(match, name) {
var lcname = name.toLowerCase();
if (name in replacements) return replacements[name];
if (lcname in replacements) return replacements[lcname];
return match;
};
return template.replace(mustachePattern, replace).replace(ejsPattern, replace);
}
// ======================================
// Illustrator specific utility functions
// ======================================
// a, b: coordinate arrays, as from <PathItem>.geometricBounds
function testBoundsIntersection(a, b) {
return a[2] >= b[0] && b[2] >= a[0] && a[3] <= b[1] && b[3] <= a[1];
}
function shiftBounds(bnds, dx, dy) {
return [bnds[0] + dx, bnds[1] + dy, bnds[2] + dx, bnds[3] + dy];
}
function clearMatrixShift(m) {
return app.concatenateTranslationMatrix(m, -m.mValueTX, -m.mValueTY);
}
function folderExists(path) {
return new Folder(path).exists;
}
function fileExists(path) {
return new File(path).exists;
}
function readYamlConfigFile(path) {
return fileExists(path) ? parseYaml(readTextFile(path)) : null;
}
function parseKeyValueString(str, o) {
var dqRxp = /^"(?:[^"\\]|\\.)*"$/;
var parts = str.split(':');
var k, v;
if (parts.length > 1) {
k = trim(parts.shift());
v = trim(parts.join(':'));
if (dqRxp.test(v)) {
v = JSON.parse(v); // use JSON library to parse quoted strings
}
o[k] = v;
}
}
// Very simple Yaml parsing. Does not implement nested properties and other features
function parseYaml(str) {
// TODO: strip comments // var comment = /\s*/
var o = {};
var lines = stringToLines(str);
for (var i = 0; i < lines.length; i++) {
parseKeyValueString(lines[i], o);
}
return o;
}
// TODO: improve
// (currently ignores bracketed sections of the config file)
function readGitConfigFile(path) {
var file = new File(path);
var o = null;
var parts;
if (file.exists) {
o = {};
file.open("r");
while(!file.eof) {
parts = file.readln().split("=");
if (parts.length > 1) {
o[trim(parts[0])] = trim(parts[1]);
}
}
file.close();
}
return o;
}
function readTextFile(path) {
var outputText = "";
var file = new File(path);
if (file.exists) {
file.open("r");