TeXempelvis

En blogg om typsättning med TeX och LaTeX

Anteckningar i dokumentutkast

När man skriver på dokument, speciellt längre sådana, så är det ofta man har versioner av dokumentet med kommentarer och information. Ett vanligt sätt att göra det här på är att skriva texten i en annan färg, i fet stil eller liknande formatering som sticker ut. Detta flera problem, bland annat så sticker texten ut så att det blir svårläst och dels är det lätt att glömma kvar sådan text i dokumenten i den slutgiltiga versionen, vilket givetvis inte är roligt.

Detta är ett vanligt problem, och det finns således ett paket som kan hjälpa med detta, todonotes-paketet.

Användande

Paketet finns med i både TeX Live och MikTeX och används i dokumentet med

1
\usepackage[inställningar]{todonotes}

Paketet har flera inställningar som finns beskrivna i manualen, men jag tänker beskriva de som jag tycker är viktigaste här.

disable, obeyDraft, obeyFinal

disable stänger av all funktionalitet och gör så att ingen text skrivs ut. Bra om man till exempel ska lämna in ett utkast utan anteckningar. obeyDraft kollar om inställningen draft är given till dokumentklassen och slår i så fall på funktionaliteten, annars är den avstängd. obeyFinal gör nästan samma sak, men stänger istället av om dokumentklassen har inställningen final.

Jag brukar använda obeyFinal, och sedan inställningen final i dokumentklassen när jag vill ha ett riktigt dokument utan anteckningar. Den flaggan användes av fler paket också, och det är i mitt tycke det smidigaste sättet.

1
\documentclass[final]{article}

color, backgroundcolor, linecolor, bordercolor

Alla dessa inställningar rör hur rutorna från \todo ser ut. Färgerna som används måste vara giltiga enligt paketet xcolor. Basfärgerna som alltid finns tillgängliga kan ses i figuren nedan, och hur man definierar fler färger kan man läsa i xcolors manual.

\todo

Det kanske tydligaste kommandot är \todo, som lägger till en anteckning.

An example

Inställningarna color, backgroundcolor och dylikt kan även ges till enskilda notiser, koden \todo[color=green!40]{En grön notis} ger till exempel en notis med grön bakgrundsfärg.

Andra intressanta inställningar är inline, som gör att notisen hamnar bland texten istället för i marginalen. Det här är speciellt bra om man vill ha notiser i bildtexter eller skriver dokument med flera kolumner. Den sista användbara inställningen är author, som skriver ut författaren till notisen först och är användbart om man är flera som arbetar på samma dokument.

1
\todo[author=Viktor,inline]{En notis skriven av Viktor som dyker upp bland texten.}

\missingfigure

Ofta börjar man skriva på sin rapport utan att vara klar med allting och om man ska lämna ut den på korrekturläsning kan det vara bra att visa var figurerna är tänkt att vara och kanske ha med bildtext även om figurerna i sig inte är färdiga.

\missingfigure lägger till en bild som kan användas för att markera att det i ett senare skede kommer att infogas riktig grafik på den platsen. Hur det ser ut i dokumentet kan ses i figuren ovan.

1
\missingfigure[figwidth=0.5\textwidth, figheight=5cm]{Här ska det vara en graf som illustrerar sambandet.}

Argumenten figwidth och figheight gör precis de som det låter som, de styr bredden och höjden på figuren som visas. Det obligatoriska argumentet är en text som skrivs ut bredvid varningsikonen och används förslagsvis för att förklara vilken figur som ska visas.

\listoftodos

I ett stort dokument med många kommentarer och notiser kan det vara bra att samla alla i en lista likt en innehållsförteckning. \todonotes gör just detta, den skriver ut en lista över alla todonotes i dokumentet. Kommandot tar ett valfritt argument som används som rubrik för listan.

1
\listoftodos[Allting jag ska ändra och komma ihåg.]

Comments