➕ Merge pull request #222 from devmount/220-multilang-openlp-export

Multilang openlp export

Author: devmount

frontend/src/utils.js

@@ -331,7 +331,8 @@ const browserPrefersDark = () => {
 const mailto = (address) => window.location.href = 'mailto:' + address;
 
 // build OpenLyrics XML for given song
-const openLyricsXML = (song, version, locales = [], allTags = null) => {
+// see https://manual.openlp.org/display_tags.html#configuring-formatting-tags
+const openLyricsXML = (song, version, translatedSong = null, locales = [], allTags = null) => {
 	const timestamp = (new Date()).toISOString().slice(0, -5);
 	const title = `<title>${song.title}</title>`;
 	const subtitle = song.subtitle ? `<title>${song.subtitle}</title>` : '';
@@ -345,16 +346,23 @@ const openLyricsXML = (song, version, locales = [], allTags = null) => {
 		: '';
 	const tags = song.tags && locales && allTags
 		? '<themes>' + song.tags.map(
-				tag => locales.map(l =>`<theme lang="${l}">${allTags[tag][l] ?? tag.key}</theme>`).join('')
+				tag => locales.map(l =>`<theme lang='${l}'>${allTags[tag][l] ?? tag.key}</theme>`).join('')
 			).join('') + '</themes>'
 		: '';
-	const lyrics = parsedContent(song.content, song.tuning, false, false).map(p => {
+  const format = translatedSong
+    ? `<format><tags application='OpenLP'><tag name='it'><open><![CDATA[<em>]]></open><close><![CDATA[</em>]]></close><hidden><![CDATA[False]]></hidden></tag><tag name='gr'><open><![CDATA[<span style='-webkit-text-fill-color:grey'>]]></open><close><![CDATA[</span>]]></close><hidden><![CDATA[True]]></hidden></tag><tag name='fd'><open><![CDATA[<small>]]></open><close><![CDATA[</small>]]></close><hidden><![CDATA[True]]></hidden></tag></tags></format>`
+    : '';
+  const tParts = translatedSong ? parsedContent(translatedSong.content, 0, false, false) : [];
+	const lyrics = parsedContent(song.content, 0, false, false).map((p, i) => {
 		const type = p.type ? p.type.toUpperCase() : 'V';
 		const num = p.number > 0 ? p.number : '1';
-		return `<verse name='${type}${num}'><lines>` + p.content.replace(/\n/g, "<br />") + '</lines></verse>'
+    const tContent = (i in tParts)
+      ? `<br/><br/><tag name='it'><tag name='gr'><tag name='fd'>${tParts[i].content.replace(/\n/g, "<br />")}</tag></tag></tag>`
+      : '';
+		return `<verse name='${type}${num}'><lines>${p.content.replace(/\n/g, "<br />")}${tContent}</lines></verse>`;
 	}).join('');
 
-	return `<?xml version='1.0' encoding='UTF-8'?><song xmlns='http://openlyrics.info/namespace/2009/song' version='0.9' createdIn='SongDrive ${version}' modifiedIn='SongDrive ${version}' modifiedDate='${timestamp}'><properties><titles>${title}${subtitle}</titles>${copyright}${year}${ccli}${authors}${tags}</properties><lyrics>${lyrics}</lyrics></song>`;
+	return `<?xml version='1.0' encoding='UTF-8'?><song xmlns='http://openlyrics.info/namespace/2009/song' version='0.9' createdIn='SongDrive ${version}' modifiedIn='SongDrive ${version}' modifiedDate='${timestamp}'><properties><titles>${title}${subtitle}</titles>${copyright}${year}${ccli}${authors}${tags}</properties>${format}<lyrics>${lyrics}</lyrics></song>`;
 };
 
 export {

frontend/src/views/SetlistShow.vue

@@ -545,13 +545,13 @@ const emit = defineEmits(['editSong', 'editSetlist']);
 
 // component properties
 const props = defineProps({
-  languages:     Object,
-  ready:         Object,
-  role:          Number,
-  setlists:      Object,
-  songs:         Object,
-  user:          String,
-  users:         Object,
+  languages: Object,
+  ready:     Object,
+  role:      Number,
+  setlists:  Object,
+  songs:     Object,
+  user:      String,
+  users:     Object,
 });
 
 // reactive data
@@ -981,12 +981,20 @@ const exportOsz = async () => {
 		if (setlist.value.songs.hasOwnProperty(key) && setlist.value.songs[key].id in props.songs) {
 			// get song object
 			const song = props.songs[setlist.value.songs[key].id];
+			// check for translations
+			const lang = !('lang' in localStorage) ? locale.value : localStorage.getItem('lang');
+			let tSong = null;
+			if (lang !== song.language && song.translations.length > 0) {
+				const tKey = song.translations.find((t) => t.endsWith(`-${lang}`));
+				tSong = props.songs[tKey];
+			}
 			// handle song content parts
-			let itemData = [];
-			let parts = parsedContent(song.content, 0, false, false);
-			parts.forEach((part) => {
+			const itemData = [];
+			const parts = parsedContent(song.content, 0, false, false);
+			const tParts = tSong ? parsedContent(tSong.content, 0, false, false) : [];
+			parts.forEach((part, i) => {
 				itemData.push({
-					'raw_slide': part.content,
+					'raw_slide': (i in tParts) ? `${part.content}\n\n{it}{gr}{fd}${tParts[i].content}{/fd}{/it}{/gr}` : part.content,
 					'verseTag': (part.type ? part.type.toUpperCase() : 'V') + (part.number > 0 ? part.number.toString() : '1'),
 				});
 			});
@@ -1014,7 +1022,7 @@ const exportOsz = async () => {
 							'ccli_number': song.ccli,
 							'copyright': song.publisher
 						},
-						'xml_version': openLyricsXML(song, version),
+						'xml_version': openLyricsXML(song, version, tSong),
 						'auto_play_slides_once': false,
 						'auto_play_slides_loop': false,
 						'timed_slide_interval': 0,

frontend/src/views/SongShow.vue

@@ -524,8 +524,15 @@ const exportSng = () => {
 };
 // export song in OpenLyrics XML format
 const exportXml = () => {
+	// check for translations
+	const lang = !('lang' in localStorage) ? locale.value : localStorage.getItem('lang');
+	let tSong = null;
+	if (lang !== song.value.language && song.value.translations.length > 0) {
+		const tKey = song.value.translations.find((t) => t.endsWith(`-${lang}`));
+		tSong = props.songs[tKey];
+	}
 	// start download
-	download(openLyricsXML(song.value, version, availableLocales, props.tags), songId + '.xml');
+	download(openLyricsXML(song.value, version, tSong, availableLocales, props.tags), songId + '.xml');
 	// toast success message
 	notify({
 		title: t('toast.exportedXml'),