This repository has been archived by the owner on Jan 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 202
/
jekyll-multiple-languages-plugin.rb
512 lines (378 loc) · 16.7 KB
/
jekyll-multiple-languages-plugin.rb
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
=begin
Jekyll Multiple Languages is an internationalization plugin for Jekyll. It
compiles your Jekyll site for one or more languages with a similar approach as
Rails does. The different sites will be stored in sub folders with the same name
as the language it contains.
Please visit https://github.com/screeninteraction/jekyll-multiple-languages-plugin
for more details.
=end
require_relative "plugin/version"
module Jekyll
#*****************************************************************************
# :site, :post_render hook
#*****************************************************************************
Jekyll::Hooks.register :site, :pre_render do |site, payload|
lang = site.config['lang']
puts "Loading translation from file #{site.source}/_i18n/#{lang}.yml"
site.parsed_translations[lang] = YAML.load_file("#{site.source}/_i18n/#{lang}.yml")
end
Jekyll::Hooks.register :site, :post_render do |site, payload|
# Removes all static files that should not be copied to translated sites.
#===========================================================================
default_lang = payload["site"]["default_lang"]
current_lang = payload["site"][ "lang"]
static_files = payload["site"]["static_files"]
exclude_paths = payload["site"]["exclude_from_localizations"]
if default_lang != current_lang
static_files.delete_if do |static_file|
# Remove "/" from beginning of static file relative path
if static_file.instance_variable_get(:@relative_path) != nil
static_file_r_path = static_file.instance_variable_get(:@relative_path).dup
if static_file_r_path
static_file_r_path[0] = ''
exclude_paths.any? do |exclude_path|
Pathname.new(static_file_r_path).descend do |static_file_path|
break(true) if (Pathname.new(exclude_path) <=> static_file_path) == 0
end
end
end
end
end
end
#===========================================================================
end
##############################################################################
# class Site
##############################################################################
class Site
attr_accessor :parsed_translations # Hash that stores parsed translations read from YAML files.
alias :process_org :process
#======================================
# process
#
# Reads Jekyll and plugin configuration parameters set on _config.yml, sets
# main parameters and processes the website for each language.
#======================================
def process
# Check if plugin settings are set, if not, set a default or quit.
#-------------------------------------------------------------------------
self.parsed_translations ||= {}
self.config['exclude_from_localizations'] ||= []
if ( !self.config['languages'] or
self.config['languages'].empty? or
!self.config['languages'].all?
)
puts 'You must provide at least one language using the "languages" setting on your _config.yml.'
exit
end
# Variables
#-------------------------------------------------------------------------
# Original Jekyll configurations
baseurl_org = self.config[ 'baseurl' ].to_s # Baseurl set on _config.yml
dest_org = self.dest # Destination folder where the website is generated
# Site building only variables
languages = self.config['languages'] # List of languages set on _config.yml
# Site wide plugin configurations
self.config['default_lang'] = languages.first # Default language (first language of array set on _config.yml)
self.config[ 'lang'] = languages.first # Current language being processed
self.config['baseurl_root'] = baseurl_org # Baseurl of website root (without the appended language code)
self.config['translations'] = self.parsed_translations # Hash that stores parsed translations read from YAML files. Exposes this hash to Liquid.
# Build the website for default language
#-------------------------------------------------------------------------
puts "Building site for default language: \"#{self.config['lang']}\" to: #{self.dest}"
process_org
# Build the website for the other languages
#-------------------------------------------------------------------------
# Remove .htaccess file from included files, so it wont show up on translations folders.
self.include -= [".htaccess"]
languages.drop(1).each do |lang|
# Language specific config/variables
@dest = dest_org + "/" + lang
self.config['baseurl'] = baseurl_org + "/" + lang
self.config['lang'] = lang
puts "Building site for language: \"#{self.config['lang']}\" to: #{self.dest}"
process_org
end
# Revert to initial Jekyll configurations (necessary for regeneration)
self.config[ 'baseurl' ] = baseurl_org # Baseurl set on _config.yml
@dest = dest_org # Destination folder where the website is generated
puts 'Build complete'
end
if Gem::Version.new(Jekyll::VERSION) < Gem::Version.new("3.0.0")
alias :read_posts_org :read_posts
#======================================
# read_posts
#======================================
def read_posts(dir)
translate_posts = !self.config['exclude_from_localizations'].include?("_posts")
if dir == '' && translate_posts
read_posts("_i18n/#{self.config['lang']}/")
else
read_posts_org(dir)
end
end
end
end
##############################################################################
# class PostReader
##############################################################################
class PostReader
if Gem::Version.new(Jekyll::VERSION) >= Gem::Version.new("3.0.0")
alias :read_posts_org :read_posts
#======================================
# read_posts
#======================================
def read_posts(dir)
translate_posts = !site.config['exclude_from_localizations'].include?("_posts")
if dir == '' && translate_posts
read_posts("_i18n/#{site.config['lang']}/")
else
read_posts_org(dir)
end
end
end
end
#-----------------------------------------------------------------------------
#
# Include (with priority—prepend)the translated
# permanent link for Page and document
#
#-----------------------------------------------------------------------------
module Permalink
#======================================
# permalink
#======================================
def permalink
return nil if data.nil? || data['permalink'].nil?
if site.config['relative_permalinks']
File.join(@dir, data['permalink'])
else
# Look if there's a permalink overwrite specified for this lang
data['permalink_'+site.config['lang']] || data['permalink']
end
end
end
Page.prepend(Permalink)
Document.prepend(Permalink)
##############################################################################
# class Post
##############################################################################
class Post
if Gem::Version.new(Jekyll::VERSION) < Gem::Version.new("3.0.0")
alias :populate_categories_org :populate_categories
#======================================
# populate_categories
#
# Monkey patched this method to remove unwanted strings
# ("_i18n" and language code) that are prepended to posts categories
# because of how the multilingual posts are arranged in subfolders.
#======================================
def populate_categories
categories_from_data = Utils.pluralized_array_from_hash(data, 'category', 'categories')
self.categories = (
Array(categories) + categories_from_data
).map {|c| c.to_s.downcase}.flatten.uniq
self.categories.delete("_i18n")
self.categories.delete(site.config['lang'])
return self.categories
end
end
end
##############################################################################
# class Document
##############################################################################
class Document
if Gem::Version.new(Jekyll::VERSION) >= Gem::Version.new("3.0.0")
alias :populate_categories_org :populate_categories
#======================================
# populate_categories
#
# Monkey patched this method to remove unwanted strings
# ("_i18n" and language code) that are prepended to posts categories
# because of how the multilingual posts are arranged in subfolders.
#======================================
def populate_categories
data['categories'].delete("_i18n")
data['categories'].delete(site.config['lang'])
merge_data!({
'categories' => (
Array(data['categories']) + Utils.pluralized_array_from_hash(data, 'category', 'categories')
).map(&:to_s).flatten.uniq
})
end
end
end
#-----------------------------------------------------------------------------
#
# The next classes implements the plugin Liquid Tags and/or Filters
#
#-----------------------------------------------------------------------------
##############################################################################
# class LocalizeTag
#
# Localization by getting localized text from YAML files.
# User must use the "t" or "translate" liquid tags.
##############################################################################
class LocalizeTag < Liquid::Tag
#======================================
# initialize
#======================================
def initialize(tag_name, key, tokens)
super
@key = key.strip
end
#======================================
# render
#======================================
def render(context)
if "#{context[@key]}" != "" # Check for page variable
key = "#{context[@key]}"
else
key = @key
end
key = Liquid::Template.parse(key).render(context) # Parses and renders some Liquid syntax on arguments (allows expansions)
site = context.registers[:site] # Jekyll site object
lang = site.config['lang']
translation = site.parsed_translations[lang].access(key) if key.is_a?(String)
if translation.nil? or translation.empty?
translation = site.parsed_translations[site.config['default_lang']].access(key)
puts "Missing i18n key: #{lang}:#{key}"
puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
end
translation
end
end
##############################################################################
# class LocalizeInclude
#
# Localization by including whole files that contain the localization text.
# User must use the "tf" or "translate_file" liquid tags.
##############################################################################
module Tags
class LocalizeInclude < IncludeTag
#======================================
# render
#======================================
def render(context)
if "#{context[@file]}" != "" # Check for page variable
file = "#{context[@file]}"
else
file = @file
end
file = Liquid::Template.parse(file).render(context) # Parses and renders some Liquid syntax on arguments (allows expansions)
site = context.registers[:site] # Jekyll site object
default_lang = site.config['default_lang']
validate_file_name(file)
includes_dir = File.join(site.source, '_i18n/' + site.config['lang'])
# If directory doesn't exist, go to default lang
if !Dir.exist?(includes_dir)
includes_dir = File.join(site.source, '_i18n/' + default_lang)
elsif
# If file doesn't exist, go to default lang
Dir.chdir(includes_dir) do
choices = Dir['**/*'].reject { |x| File.symlink?(x) }
if !choices.include?( file)
includes_dir = File.join(site.source, '_i18n/' + default_lang)
end
end
end
Dir.chdir(includes_dir) do
choices = Dir['**/*'].reject { |x| File.symlink?(x) }
if choices.include?( file)
source = File.read(file)
partial = Liquid::Template.parse(source)
context.stack do
context['include'] = parse_params( context) if @params
contents = partial.render(context)
ext = File.extname(file)
converter = site.converters.find { |c| c.matches(ext) }
contents = converter.convert(contents) unless converter.nil?
contents
end
else
raise IOError.new "Included file '#{file}' not found in #{includes_dir} directory"
end
end
end
end
end
##############################################################################
# class LocalizeLink
#
# Creates links or permalinks for translated pages.
# User must use the "tl" or "translate_link" liquid tags.
##############################################################################
class LocalizeLink < Liquid::Tag
#======================================
# initialize
#======================================
def initialize(tag_name, key, tokens)
super
@key = key
end
#======================================
# render
#======================================
def render(context)
if "#{context[@key]}" != "" # Check for page variable
key = "#{context[@key]}"
else
key = @key
end
key = Liquid::Template.parse(key).render(context) # Parses and renders some Liquid syntax on arguments (allows expansions)
site = context.registers[:site] # Jekyll site object
key = key.split
namespace = key[0]
lang = key[1] || site.config[ 'lang']
default_lang = site.config['default_lang']
baseurl = site.baseurl
pages = site.pages
url = "";
if default_lang != lang
baseurl = baseurl + "/" + lang
end
collections = site.collections.values.collect{|x| x.docs}.flatten
pages = site.pages + collections
for p in pages
unless p['namespace'].nil?
page_namespace = p['namespace']
if namespace == page_namespace
permalink = p['permalink_'+lang] || p['permalink']
url = baseurl + permalink
end
end
end
url
end
end
end # End module Jekyll
################################################################################
# class Hash
################################################################################
unless Hash.method_defined? :access
class Hash
#======================================
# access
#======================================
def access(path)
ret = self
path.split('.').each do |p|
if p.to_i.to_s == p
ret = ret[p.to_i]
else
ret = ret[p.to_s] || ret[p.to_sym]
end
break unless ret
end
ret
end
end
end
################################################################################
# Liquid tags definitions
Liquid::Template.register_tag('t', Jekyll::LocalizeTag )
Liquid::Template.register_tag('translate', Jekyll::LocalizeTag )
Liquid::Template.register_tag('tf', Jekyll::Tags::LocalizeInclude)
Liquid::Template.register_tag('translate_file', Jekyll::Tags::LocalizeInclude)
Liquid::Template.register_tag('tl', Jekyll::LocalizeLink )
Liquid::Template.register_tag('translate_link', Jekyll::LocalizeLink )