This repository has been archived by the owner on Feb 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathfstil.tex
184 lines (146 loc) · 12.3 KB
/
fstil.tex
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
% !TEX TS-program = XeLaTeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%Instruktion till paketet fstil.sty, fysiksektionens grafiska profil!
% Dokument skapat av Emil Ringh, F-08 (eringh)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentclass[a4paper]{article}
%Fysiksketionens grafiska profil
\usepackage{fstil}
%För att kunna använda bilder
\usepackage{graphicx}
%Svenska avstavning
\usepackage[swedish]{babel}
%För att inkludera kod
\usepackage{listings}
\lstset{
tabsize=1,
breaklines=true,
language=TeX,
basicstyle=\footnotesize
}
\newcommand{\bs}{\textbackslash}
\title{Introduktion till paketet \NoCaseChange{\texttt{fstil.sty}} }
\date{}
\author{Fysiksektionen}
\begin{document}
\fintro{Paketet \texttt{fstil.sty} är en \TeX-klass som har utvecklats för att ge \F ysiksektionen en enhetlig grafisk profil att använda i alla officiella dokument. Detta är en introduktion till hur detta paket fungerar och hur det används.}
\ftitlepage
\ftoc
\section{Paketet fstil}
Paketet \texttt{fstil.sty} är utvecklat för att ge \F ysiksektionen en grafisk profil. Det ställer om fonten till \textit{Garamond}, ger ett sidhuvud som innehåller sektionens logotyp samt en sektionsrelaterad sidfot. Den grafisk profilen är sådan att den efterliknar THS grafiska profil, fast anpassad till \F ysiksektionen. Detta dokument är skrivet med hjälp av fstil.
\subsection{Installera fstil}
För att köra fstil behöver man ha rätt teckensnitt installerade på sin datorn. Saknar man dessa kan man hitta dem här: \href{https://github.com/Fysiksektionen/latex/tree/master/fonts}{https://github.com/Fysiksektionen/latex/tree/master/fonts}
Det går även att köra utan rätt teckensnitt om man använder sig av option \texttt{NoFontChange}, inte att rekommendera men det fungerar.
Installera typsnitten på din dator:
\begin{itemize}
\item[] Windows: Öppna kontrollpanelen, gå till \textit{Teckensnitt}/\textit{Fonts} och dra in .TTF-erna. Alternativt dubbelklicka på dem och tryck \textit{installera}/\textit{install} uppe till höger.
\item[] Ubuntu: Dubbelklicka och välj installera.
\item[] Mac:
\end{itemize}
Orkar man inte installera paketet räcker det nu med att flytta med filen \texttt{fstil.sty} samt de medföljande bilderna till den map man har dokumentet man önskar kompilera. Om du ska använda det mer än en gång rekommenderas dock att du installerar det:
\begin{itemize}
\item[] MikTeX: Följ länkarna för \href{http://docs.miktex.org/faq/maintenance.html#styfiles}{kortare} och \href{http://docs.miktex.org/manual/localadditions.html}{längre} instruktioner. I korthet: \begin{itemize}
\item Skapa en map där du vill ha dina \TeX-paket, förslagsvis under \textit{Documents} eller liknande
\item I den mappen skapar du katalogträdet \textit{fstil/tex/xelatex}, där du lägger \texttt{fstil.sty} och medföljande bilder m.m. i \textit{xelatex}
\item Gå till MikTeX \textit{Settings}, välj fliken \textit{roots} och lägg till mappen \textit{fstil}. Gå sedan tillbaka till fliken \textit{General} och välj \textit{Refresh FNDB}
\end{itemize}
\end{itemize}
\subsection{Att använda fstil}
För att använda fstil skriver du helt enkelt \texttt{\bs usepackage\{fstil\}} i början av ditt \TeX-dokument.
För att kompilera dokumentet använder du \textit{XeLaTeX}. Detta kan du göra genom att skriva \\ \texttt{>xelatex MITTDOKUMENT.tex} i terminalen (\textit{XeLaTeX} följer med de flesta \TeX-distributioner) eller välja xelatex i menyn i ditt \TeX-program.
\subsection{Tänk på att}
Varje dokument behöver en titel, denna sätts med \texttt{\bs title\{TEXT\}} och syns i sidhuvudet. Dessutom förses varje dokument med ett datum, också det i sidhuvudet. Datumet är per automatik den dag du kompilerar dokumentet om du inte sätter det själv med kommandot \texttt{\bs date\{TEXT\}}. Vill du inte ha datum alls kan du sätta det som \texttt{\bs date\{\}}.
Du får \textbf{\underline{inte}} använda \texttt{\bs usepackage[T1]\{fontenc\}}, då kommer typsnittet att bli fel.
Använd inte fler paket än nödvändigt (fstil har det mesta inbyggt). Ska du använda fler paket, se till att ladda fstil först!
fstil är inställt för att jobba med dokument encodade med \textit{utf8}. Se till så att ditt dokumnet är skrivet i \textit{utf8}, annars fungerar inte å,ä,ö.
\section{Användbara kommandon}
\subsection{Allmänna kommandon}
\begin{itemize}
\item \texttt{\bs NoCaseChange\{TEXT som inte ska bli Caps i titeln\} }
\item \texttt{\bs href\{http://f.kth.se\}\{länk till Fysiksektionens hemsida\} } ger mycket riktigt en \href{http://f.kth.se}{länk till Fysiksektionens hemsida}. Observera färgen!
\end{itemize}
\subsection{Speciellt för fstil}
\begin{itemize}
\item \texttt{\bs ftitlepage} skapar en första sida. Den ser lika dan ut som till detta dokument och innehållet titeln samt en text som definieras av kommandot nedan. Om en vill ha en egen bild på första sidan används \texttt{\bs ftitlepage[BILD.EXT]}.
\item \texttt{\bs fintro\{TEXT\}} definierar det som ska stå på förstasidan. Tänk på att inte göra denna text för lång.
\item \texttt{\bs ftoc} ger en innehållsförteckning (på egen sida).
\item \texttt{\bs F} producerar ett \F.
\item \texttt{\bs noll} skriver ut \noll. Perfekt om man vill skriva \noll an eller \noll egasque.
\item \texttt{\bs fkm} ger klubbmästeriets logga \fkm.
\item \texttt{\bs FN} ger näringslivsnämndens logga \FN.
\item Definierar färgen \texttt{fysik} vilket get \textcolor{fysik}{en fin orange färg} som kan användas. Till exempel i kommandot \texttt{\bs textcolor\{fysik\}\{en fin orange färg\}}.
\item \texttt{\bs carlsven} ger det fanatiska namnet \carlsven, om man behöver det till en anmälningslista.
\item \texttt{\bs strike\{text\}} kan användas om man vill ha ett streck genom någon annan \strike{text}.
\item \texttt{\bs sign\{plats\}\{år\}\{namn\}\{titel\}} ger en underskrift frånen person (som den brukar se ut på motioner, fast med datum och plats).
\item \texttt{\bs twosign\{plats\}\{år\}\{namn1\}\{namn2\}\{titel1\}\{titel2\}} ger en underskrift från två personer (som den brukar se ut på protokol från SM). Ett förminskat exempel: {\footnotesize
\twosign{plats}{år}{namn1}{namn2}{titel1}{titel2}
}
\item \texttt{\bs threesign\{plats\}\{år\}\{namn1\}\{namn2\}\{namn3\}\{titel1\}\{titel2\}\{titel3\}} ger en underskrift från tre personer (som den brukar se ut på protokoll från STYM).
\item \texttt{\bs foursign\{år\}\{namn1\}\{namn2\}\{namn3\}\{namn4\}\{titel1\}\{titel2\}\{titel3\}\{titel4\}} ger en underskrift från fyra personer (som den brukar se ut på tex verksamhetsberättelser). (Stockholm är angivet som plats på grund av begränsingar i \TeX).
\item \texttt{\bs attest\{namn1 \& titel\}\{namn2 \& titel\}} ger sakattest och ekonomisk attest till verifikationer.
\item \texttt{\bs verifikat\{Nämnd\}} ger början på ett verifikat (verifikationsnummer och -datum samt bokföringsdatum).
\item \texttt{\bs utlägg\{Nämnd\}} ger början på en utläggsverifikation (de fem raderna samt det \bs verifikat{} gör).
\item \texttt{\bs ekostart} ger översta raden i tabellen (Kontonamn, kontonummer, KS, Projekt, Debet, Kredit).
\item \texttt{\bs ekorad\{Kontonamn\}\{kontonummer\}} ger en rad i tabellen med valt kontonamn och kontonummer.
\item \texttt{\bs ekoslut} avslutar tabellen och lägger till total. Observera att både \bs ekostart och \bs ekoslut båda behövs, annars kommer det generera ett felmeddelande.
\item \texttt{\bs textrad\{text\}} ger en rad med valfri text och avstånd.
\end{itemize}
\section{Options i fstil}
Ett paket kan laddas med olika options, vilket görs när du deklarerar att du vill använda paketet:\\ \texttt{$\bs$usepackage[ettOption,ettAnnatOption]\{fstil\}}. De options som fstil kan hantera är:
\begin{itemize}
\item \texttt{BigLogo} gör loggan i sidhuvudet mycket större.
\item \texttt{DateOnTitle} ser till att datumet läggs till på framsidan. Datumet får en egen rad och allt blir högerjusterat. Blir snyggast ihop med långa titlar som \textit{Verksamhetsberättelse Fysiksektionen} eller \textit{Halvårsrapport Fysiksektionen}.
\item \texttt{landscape} sätter om marginalerna och fixar titelsidan så att det blir snyggt på ett liggande dokument. \textbf{OBS:} Behöver inte laddas explicit, görs automatiskt om kommandot ges när du laddar dokumentklassen \texttt{$\bs$documentclass[a4paper,landscape]\{article\}}. Kan dock göras manuelt om man vill.
\item \texttt{NoFontChange} behåller standardfonten Latin Modern Roman genom hela dokumentet. Användbart om man har problem med att installera någon av fonterna som används av fstil i normala fall, då Latin Modern Roman är standardfonten.
\item \texttt{plain} tar bort all text i sidhuvud/sidfot.
\item \texttt{NoPageNumbering} tar bort sidnumreringen i sidhuvudet.
\item \texttt{fkm} gör om dokumentet enligt \fkm s grafiska profil.
\item \texttt{frum} ger dokumentet \F Rums logga i sidhuvudet.
\end{itemize}
\section{Ett exempel}
Detta är ett enkelt exemple på hur man använder paketet.
\begin{lstlisting}
\documentclass[a4paper]{article}
%Fysiksketionens grafiska profil
\usepackage{fstil}
%Svenska avstavning
\usepackage[swedish]{babel}
\title{Ett exempel}
\date{Dagens datum!}
\author{Emil Ringh}
\fintro{Detta är en introduktionstext. Den kan vara ett par rader lång...}
\begin{document}
\ftitlepage
\ftoc
\section{Detta är första rubriken}
\F ysiker vet att \noll\ gånger \noll\ är \noll.
\subsection{Denna syns inte i Innehållsförteckningen}
Här kan man skriva mer.
\section{Del två av detta exempel}
\F ysiksektionen använder ibland {\Huge \textcolor{fysik}{\F}} som symbol även om Kugghjulet är den officiella symbolen.
\end{document}
\end{lstlisting}
\section{Versionshistorik - \texttt{fstil.sty}}
\begin{itemize}
\item November 2011. Färdigställt. Skrivet av: Tomas Lycken (\F-08) och Emil Ringh (\F-08)
\item Januari 2012. Introducerat options-handeling i paketet. Kan nu även hantera option \texttt{landscape} till dokumentklassen genom att anpassa marginaler och titelsidan så att det blir snyggt. Skrivet av: Emil Ringh (\F-08)
\item September 2012. Option \texttt{DateOnTitle} tillagt. Fixat en bugg med att \texttt{\bs fkm} inte kunde skrivas i Sections. Skrivet av: Emil Ringh (\F-08)
\item Oktober 2012. La till kommandona \texttt{\bs fn}, \texttt{\bs twosign}, \texttt{\bs threesign}, \texttt{\bs foursign}. Skrivet av: Emil Ringh (\F-08)
\item Oktober 2012. La till kommandot \texttt{\bs strike} samt den studentikosa tillämpningen \texttt{\bs carlsven}. Skrivet av: Emil Ringh, (\F-08)
\item Januari 2013. Nu krävs det inte att man skriver ett datum, anger man istället \texttt{\bs date\{\}} så blir det en tom rad i sidhuvudet. Skrivet av: Emil Ringh, (\F-08)
\item Januari 2013. Options \texttt{plain} och \texttt{BigLogo} tillagda. Skrivet av: Tomas Lycken, (\F-08)
\item Januari 2014. Options \texttt{NoFontChange} tillagt. Skrivet av: Emil Ringh, (\F-08)
\item November 2015. Bytte adress till där Konsulatet faktiskt ligger. Skrivet av: Emil Ringh, (\F-08)
\item Maj 2016. Kommandon som rör verifikat och ekonomi: \texttt{\bs attes}, \texttt{\bs verifikat}, \texttt{\bs utlägg}, \texttt{\bs ekostart}, \texttt{\bs ekorad}, \texttt{\bs ekoslut}, \texttt{\bs textrad}. Skrivet av: Mårten Vuorinen, (\F-12)
\item September 2016. Bytte adress till där Konsulatet faktiskt ligger (flyttat igen!). Skrivet av: Emil Ringh, (\F-08)
\item April 2017. La till kommandon för motioner. Skrivet av: Johan Engvall, (\F-07)
\item Maj 2017. La till option att ta bort sidnumrering i sidhuvudet. Skrivet av Anton Lu, (\F-15)
\item Mars 2018. La till möjligheten att välja egen bild till titelsidan (\texttt{\bs ftitlepage[kugghjul.pdf]}). Skrivet av: Gustav Gybäck, (\F-15)
\item Mars 2018. La till \fkm s grafisa profil. Skrivet av: Gustav Gybäck, (\F-15)
\item Mars 2018. Flyttade ner det vänstra sidhuvudet i \texttt{landscape} så att titeln inte ligger på kanten. Skriven av: Gustav Gybäck, (\F-15)
\item Januari 2019. Rättade webbadressen till den faktiskt korrekta, och fixade brevhuvudets placering med plain option i landskapsorientering. La till möjlighet att inkludera \F Rums logga i sidhuvudet likt tidigare ändring för \fkm . Detta för att enkelt kunna låta \F Rums interna poster-stil ärva hela f-stil. Skrivet av: Jonas Nylund (\F -13).
\end{itemize}
\clearpage
\section{\texttt{fstil.sty}}
\lstinputlisting{fstil.sty}
\end{document}