Skip to content

Commit 352900c

Browse files
committed
Draft text om bygg-script/hemsidan, metod
Ganska kort, men känns inte som att det bör vara så mycket mer. Bygg och publiceringsprocessen är inte intressanta ur varken DSL eller didaktikperspektiv, så denna kortare översiktliga text känns lagom. Kräver ev. förklaring om diverse begrepp så som "branch", "GitHub Pages"
1 parent 0e16126 commit 352900c

File tree

1 file changed

+26
-34
lines changed

1 file changed

+26
-34
lines changed

Rapport/include/Metod.tex

Lines changed: 26 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -385,44 +385,36 @@ \subsection{Skriva lärotext}
385385
till att implementera och lösa mer komplexa problem.
386386

387387
\end{draft}
388-
\begin{binge}
388+
\begin{draft}
389389

390390
\section{Skapande av och publicering på hemsidan}
391391

392-
Läromaterialet publiceras på en internethemsida, varpå man kan läsa
393-
allt o ha skoj.
394-
395-
TODO: Slå ihop underrubriker till ett stycke.
396-
397-
\subsection{Beskrivning}
398-
399-
Ett build-script hämtar .lhs källfilerna, i vilka lärotexten är
400-
skriven med markdown. Rendrar med pandoc, och sätter in lite
401-
navigationselement etc. med hjälp av eget templating-system. Manuellt
402-
läggs sedan stoffet på gh-pages branchen för att automatiskt visas på
403-
dslsofmath.github.io/BScProj2018. \todo{Förklara templating, rendrar, branch}
404-
405-
Obs: Medan bygget är scriptat så är inte publiceringen det, och
406-
ingenting genereras/publiceras automatiskt kontinuerligt. Måste köra
407-
scriptet manuellt och lägga stoff på gh-pages branchen.
408-
409-
\subsection{Build-script}
410-
411-
I.e. implementation av python-build-scriptet i mer detalj.
392+
Läromaterialet kompilerades med hjälp av ett bygg-script och
393+
publicerades på en internethemsida. Bygg-scriptet anropar
394+
\textit{Pandoc} för att konvertera från källkod och text i Literate
395+
Haskell format till HTML, redo att visas på en hemsida. Pandoc
396+
packeterar även med \textit{MathJax} som använder JavaScript för att
397+
rendera matematiska formler i LaTeX format på fint och läsbart
398+
vis. Utan stöd för JavaScript skrivs matematik ut som omodifierad
399+
LaTeX kod, vilket är mer svårläst, men fortfarande tolkningsbart. Det
400+
skrevs även \textit{CSS} manuellt för att modifiera utseendet av
401+
hemsidan sådant att den blev mer fin och läsbar enligt
402+
projektmedlemmarna.
403+
404+
Varje källfil betraktades som ett kapitel och publicerades som
405+
separata undersidor. Med hjälp av ett index beskrivet i bygg-scriptet
406+
konstruerades navigationselement mellan kapitel på varje undersida
407+
och en innehållsförteckning.
408+
409+
För publicering lades all data producerad av bygg-scriptet i en ny git
410+
branch med namnet \texttt{gh-pages}. Att alla branches synkroniseras
411+
mot GitHub medför att alla filer på \texttt{gh-pages} branchen
412+
serveras som en hemsida med hjälp av \textit{GitHub
413+
Pages}. Publiceringen skedde inte kontinuerligt eller automatiskt,
414+
utan krävde en manuell synkronisering vid varje önskad uppdatering av
415+
hemsidan.
412416

413-
TODO: Är detta ens intressant? Viktigt för att producera sidan såklart, men
414-
inte intressant ur varken matte eller haskell/DSL perspektiv.
415-
416-
\subsection{Hemsidan}
417-
418-
TODO: Nåt om design, läslighet, grafik(?), navigation, avsiktligt undvikande
419-
av javascript, etc.
420-
421-
Från resultat: ska integreras här
422-
423-
Hemsidan består av grundläggande HTML, CSS och javascript. På hemsidan finns en innehållsförteckning med klickbara länkar till de olika kapitlen. Hemsidan är öppen för alla och bör fungera i de flesta webläsare. Javascript är inget krav för hemsidan. Matematiska formler visas ändå, om än inte lika tydligt.
424-
425-
\end{binge}
417+
\end{draft}
426418
\begin{draft}
427419

428420
\section{Utvärdering med testgrupp}

0 commit comments

Comments
 (0)