Instrukcja generowania podręcznika dla aplikacji offline dla Windows

Transkrypt

1 Instrukcja generwania pdręcznika dla aplikacji ffline dla Windws Platfrmy Technlgicznej epdreczniki.pl w wersji 3.0 Pznań, 30 listpada 2015 r. 1

2 Spis treści Paczka... 3 struktura paczki:... 3 Twrzenie paczki... 3 Krk 1. Pbieranie plików mdułów i WOMI... 3 Krk 2. Mdyfikacja WOMI... 4 Krk 3. Pbieranie skryptów js i generwanie główneg pliku klekcji... 5 Krk 4. Okładki (Cver.png)... 5 Krk 5. Strna z szczegółami pdręcznika... 5 Krk 6. Plik data.xml... 5 Szabln pliku data.xml... 6 Przykładwy plik data.xml

3 Paczka P wyknaniu niżej wynieninych krków instrukcji należy płączyć wszystkie zasby w paczkę zip. nazwa paczki t cllectin-ee.zip struktura paczki: id-pdrecznika.html static glbal cntent cllectin {cllectin_id} {cllectin_ver} student-cann {mdule_id} mdule.html... wmi {wmi_id} [pliki zwiazane z wmi]... id-pdrecznika data.xml Cver.png details.html css fnt Twrzenie paczki Krk 1. Pbieranie plików mdułów i WOMI Na serwerze Prtalu należy uruchmić pwłkę Djang (./manage.py shell) i wyknać następujący kd (przykład dla klekcji id= w wersji 1): frm preview.parsers imprt PreviewCntentParser frm rep.bjects imprt drivers c = PreviewCntentParser.imprted_cllectin_variant('121213', '1', 'student-cann') with pen('/tmp/urls_static_ge_reader', 'w') as ut: 3

4 fr m in c.get_all_mdule_ccurrences(): ut.write(m.html_url + '\n') fr w in c.referred_wmis_verall: rw = drivers.bind('wmi', w.identifier, w.versin) fr f in rw.files: ut.write(f.preview_url + '\n') W ścieżce /tmp/urls_static_ge_reader pwstał plik, z listą adresów URL d pbrania plików mdułów raz plików WOMI wchdzących w skład tej klekcji. Należy pbrać wszystkie te pliki, zachwując ich strukturę katalgwą wyrażną w adresach URL. Krk 2. Mdyfikacja WOMI 1. Dla każdeg WOMI ddać pusty plik nazwie {id_cll}.cllectin, który będzie pmcny przy usuwaniu klekcji z urządzenia. 2. Jeżeli w katalgu z id wmi pierwszy katalg t "1", czyli numer wersji wmi, t należy g usunać a wszystkie zasby wmi przenieść katalg wyżej. 1. przykładw dla pliku manifest.jsn dla wmi id=123: 1. błędna ścieżka: /wmi/123/1/metadata.jsn 2. pprawna ścieżka: /wmi/123/metadata.jsn 3. Dla wmi typu dźwięk - węzeł "engine" wartści "audi" (plik manifest): 1. jeżeli główny plik audi nie zstał pbrany t należy g pbrać z repav/{wmiid} i zapisać pd nazwą "audi.mp4", 2. wygenerwanie pliku meta.jsn i umieszczenie w głównym katalgu wmi zawartści: {Prfiles:[audi_med_aac],Subtitles:[],AltAudi:0,MaterialId:var_WmiId,AllwDistributin:tr ue,duratin:var_duratin,ready:true} gdzie: var_wmiid t id wmi 2. var_duratin wartść należy pbrać z repav/meta/{wmiid} 4. dla wmi typu vide - węzeł "engine" wartści "vide" (plik manifest): 1. jeżeli główny plik vide nie zstał pbrany t należy g pbrać z repav/{wmiid} i zapisać pd nazwą "vide.mp4", 2. wygenerwanie pliku meta.jsn i umieszczenie w głównym katalgu wmi zawartści: {Prfiles:[mp4_hi_hl],Subtitles:[var_subtitles],AltAudi:0,MaterialId:var_WmiId,AllwDistrib utin:true,duratin:var_duratin,ready:true} gdzie: 1. var_wmiid t id wmivar_subtitles 1. jeżeli dla filmu istnieją napisy [repav/{wmiid}_subtitles] 1. d tablicy "Subtitles" wpisujemy wartść "subtitles" 2. pbieramy plik z napisami i zapisujemy jak "subtitles.txt" 2. dla captins sytuacja analgiczna jak wyżej (link d rep repav/{wmiid}_captins] (zmiana "subtitles" na "captins"). 4

5 3. var_duratin: 1. wartść należy pbrać z repav/meta/{wmiid}. 5. Adres zmiennej repav t w śrdwisku prdukcyjnym - należy ustawić dpwiedni. Krk 3. Pbieranie skryptów js i generwanie główneg pliku klekcji Żeby uzyskać statyczne pliki ptrzebne d uruchmienia aplikacji należy: uruchmić instancję prtalu wyknać plecenie w virtual env dla prtalu: pythn manage.py build_ge_reader <identifier> <versin> <variant> -- settings=prtal.settings.instances.static_reader --path= /sciezka/d/katalgu zstanie zbudwany index.html dla klekcji identifier, versin i variant (np. "studentcann"), wszystk zstanie zapisane pd ścieżką z --path w katalgu utwrzą się również pliki statyczne (skrypty js, css itp) plik index.html należy zmienić na <numer klekcji>.html usunąć zawartść pliku \glbal\libraries\ep\frame_script.js. Ustawienia dtyczące generwania paczki są w wyżej imprtwanym pliku prtal.settings.instances.static_reader. Krk 4. Okładki (Cver.png) Okładki pwinny być pbierane per tm (pra rku) z pliku z metadanymi klekcji cllectin.xml/cl:cllectin/cl:metadata/ep:e-textbk/ep:cver. Krk 5. Strna z szczegółami pdręcznika Jest t strna na której znajdują się szczegółwe infrmacje klekcji. W aplikacji ffline ta strnka składa się z pliku "details.html" i katalgów: "css" i "fnt". Katalgi są takie same dla każdej klasy i każdeg tmu (pra rku). Natmiast w pliku "details.html" trzeba zmienić numer klasy w trzech miejscach "var_schl_class". Paczka z strna szczegółwą t epdreczniki-windws/ details_page.zip. Krk 6. Plik data.xml Zmiany w szablnie pliku data.xml (zamieszczny pniżej): var_cll_id - cllectin.xml/cl:cllectin/cl:metadata/md:cntent-id var_cll_ver - cllectin.xml/cl:cllectin/cl:metadata/md:versin var_schl_id - zgdnie z var_schl_class - cllectin.xml/cl:cllectin/cl:metadata/ep:e-textbk/ep:class 5

6 Szabln pliku data.xml <?xml versin="1.0" encding="utf-8"?> <CllectinDataItem> <Id>var_cll_id</Id> <CntentId>var_cll_id</CntentId> <Title>var_cll_title</Title> <Abstract/> <Schl> <Id>var_schl_id</Id> <EducatinLevel>Pdstawwa</EducatinLevel> <Class>var_schl_class</Class> </Schl> <Subject> <Id>9</Id> <Subject>Edukacja wczesnszklna</subject> </Subject> <Published>true</Published> <Versin>var_cll_ver</Versin> <Language>pl</Language> <License> <Created> </Created> <Revised> </Revised> <IsDummy>false</IsDummy> <Authrs/> <Keywrds/> <Cver>Cver.png</Cver> <CverThumb>Cver.png</CverThumb> <Link>// 6

7 </CllectinDataItem> Przykładwy plik data.xml data.xml <?xml versin="1.0" encding="utf-8"?> <CllectinDataItem> <Id>236925</Id> <CntentId>236925</CntentId> <Title>Klasa 1 - Jesień</Title> <Abstract/> <Schl> <Id>1</Id> <EducatinLevel>Pdstawwa</EducatinLevel> <Class>1</Class> </Schl> <Subject> <Id>9</Id> <Subject>Edukacja wczesnszklna</subject> </Subject> <Published>true</Published> <Versin>1</Versin> <Language>pl</Language> <License> <Created> </Created> <Revised> </Revised> <IsDummy>false</IsDummy> <Authrs/> <Keywrds/> <Cver>Cver.png</Cver> <CverThumb>Cver.png</CverThumb> 7

8 <Link>// </CllectinDataItem> 8