> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/latex/fi/asiakirjan-rakenne/04-indices.md). # Hakemistot Joissakin suurissa asiakirjoissa, esimerkiksi kirjoissa, on tapana tehdä aakkosellinen luettelo, joka sisältää päätermit. LaTeXin ja tukiohjelman **imakeidx**, hakemisto voidaan luoda melko helposti. ## Johdanto Tarkastellaan yksinkertaista toimivaa esimerkkiä. ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex \begin{document} \section{Introduction} Tässä esimerkissä käytetään useita avainsanoja\index{keywords} jotka ovat tärkeitä ja ansaitsevat näkyä hakemistossa\index{Index}. Termit kuten generate\index{generate} ja some\index{others} tulevat myös näkyviin. \printindex \end{document} ``` [Avaa tämä esimerkki Overleafissa](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%0A%0A%5Cbegin%7Bdocument%7D%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+used+%0Awhich+are+important+and+deserve+to+appear+in+the+Index%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+will+%0Aalso+show+up.+%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Seuraava kuva näyttää yllä olevan esimerkin tuottaman tuloksen: ![Index1OLV2.png](/files/9dbfc0660b45b47feb0adc2b76e17175bc425e1b) Ensiksi paketti lisätään johdantoon rivillä ```latex \usepackage{imakeidx} ``` Sitten komento `\makeindex` on välttämätön, jotta hakemisto toimii, ja se voi ottaa joitakin parametreja ulkoasun mukauttamiseksi; seuraavissa osioissa tämä selviää. Hakemistoon lisättävän merkinnän lisäämiseksi käytetään komentoa `\index{}` jossa lisättävä sana annetaan parametrina. Ole varovainen, tätä sanaa ei tulosteta nykyiseen kohtaan vaan vain hakemistoon. Lopuksi komento `\printindex` todellisuudessa tuottaa hakemiston. Jos käytät erityistä lokalisointia `babel` paketin avulla, otsikko käännetään sen mukaisesti. Huomautus: sen sijaan, että `imakeidx`, paketti `makeidx` voidaan tuoda, mutta se tarjoaa vähemmän mukautusmahdollisuuksia. ## Hakemistot Overleafissa Kun lisäät hakemiston Overleaf-projektiin, **on tärkeää huomata** että jotta hakemisto kääntyy oikein, projektin pää `.tex` tiedoston on oltava projektin juurihakemistossa, *kansioiden ulkopuolella*. Tämä varmistaa, että hakemiston luomiseen tarvittavat aputiedostot välimuistitetaan niin, että kääntäjä pääsee niihin käsiksi. ## Merkinnät ja alimerkinnät Kuten edellisessä osiossa mainittiin, komento `\index` lisää sille annetun sanan hakemistoon, mutta tämä ei ole ainoa tapa käyttää sitä. ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex \begin{document} \section{Introduction} Tässä esimerkissä käytetään useita avainsanoja\index{keywords} jotka ovat tärkeitä ja ansaitsevat näkyä hakemistossa\index{Index}. Termit kuten generate\index{generate} ja some\index{others} tulevat myös esiintyviin. Hakemiston termejä voidaan myös sisentää \index{Index!nested} \clearpage \section{Second section} Tämä toinen osio\index{section} voi sisältää jonkin erityisen sanan, ja laajentaa jo käytettyjä\index{keywords!used}. \printindex \end{document} ``` [Avaa tämä esimerkki Overleafissa](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example+2\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%0A%0A%5Cbegin%7Bdocument%7D%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+used+%0Awhich+are+important+and+deserve+to+appear+in+the+Index%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+will+also+%0Ashow+up.+Terms+in+the+index+can+also+be+nested+%5Cindex%7BIndex%21nested%7D%0A%0A%5Cclearpage%0A%0A%5Csection%7BSecond+section%7D%0AThis+second+section%5Cindex%7Bsection%7D+may+include+some+special+word%2C+%0Aand+expand+the+ones+already+used%5Cindex%7Bkeywords%21used%7D.%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Seuraava kuva näyttää yllä olevan esimerkin tuottaman tuloksen: ![Index2OLV2.png](/files/8d65b1ee67514ef815a53de13e84c4611ee2ad86) On yleinen käytäntö laajentaa hakemiston termejä siten, että niihin sisällytetään erityisiä määritteitä. Esimerkiksi sana *Field* saattaa saada erityisen merkityksen, jos sen edellä on määrite *finite* tai sen jälkeen on *of characteristic 0*, ja erilaisten *Field*termien lisääminen erillisinä merkintöinä hakemistoon voi olla hieman hankalaa. Tällaisissa tapauksissa voit lisätä huutomerkin "!", joka lisää tämän merkin jälkeiset termit pääsanan alimerkinnöiksi *Field*. Esimerkissä sanalla "Index" on alimerkintänä sana "nested". ## Hakemiston muotoilu Yksinkertainen hakemiston muotoilu, kuten hakemiston otsikon muuttaminen, useiden sarakkeiden lisääminen ja sarakeleveyden muuttaminen, voidaan helposti tehdä antamalla valinnaisia arvoja komennolle `\makeindex`: ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex[columns=3, title=Alphabetical Index] \begin{document} \section{Introduction} Tässä esimerkissä käytetään useita avainsanoja\index{keywords}, jotka ovat tärkeitä ja ansaitsevat näkyä hakemistossa\index{Index}. Termit kuten generate\index{generate} ja some\index{others} tulevat myös esiintyviin. Hakemiston termejä voidaan myös sisentää \index{Index!nested} \clearpage \section{Second section} Tämä toinen osio\index{section} voi sisältää jonkin erityisen sanan, ja laajentaa jo käytettyjä\index{keywords!used}. \printindex \end{document} ``` [Avaa tämä esimerkki Overleafissa](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example+3\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%5Bcolumns%3D3%2C+title%3DAlphabetical+Index%5D%0A%0A%5Cbegin%7Bdocument%7D%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+used+which+%0Aare+important+and+deserve+to+appear+in+the+Index%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+will+also+%0Ashow+up.+Terms+in+the+index+can+also+be+nested+%5Cindex%7BIndex%21nested%7D%0A%0A%5Cclearpage%0A%0A%5Csection%7BSecond+section%7D%0AThis+second+section%5Cindex%7Bsection%7D+may+include+some+special+word%2C+%0Aand+expand+the+ones+already+used%5Cindex%7Bkeywords%21used%7D.%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Seuraava kuva näyttää yllä olevan esimerkin tuottaman tuloksen: ![Index3OLV2.png](/files/955588af9726bb3e8bf514a52ae8a1ac685c79a5) Tässä esimerkissä hakemisto esitetään kolmipalstaisessa muodossa parametrilla `columns=3`, ja otsikko muutetaan muotoon "Alphabetical Index" parametrilla `title=Alphabetical Index`; nämä parametrit annetaan komennolle `\makeindex` johdannossa. Katso [viiteopas](#reference-guide) saatavilla olevien parametrien luetteloa ja niiden kuvauksia varten. ### Tyylitiedostojen käyttäminen Hakemiston lisämukauttamiseen voi käyttää tyylitiedostoa. Tyylitiedostot kertovat `makeindex` sovellukselle halutun lopullisen tulosteen muodon. Tyylitiedostot sisältävät luettelon `` pareista. Jos esimerkiksi termit halutaan ryhmitellä hakemistossa niiden alkukirjaimen mukaan ja tasailla sivunumerot oikealle, seuraava tyylitiedosto hoitaa tehtävän: ```latex headings_flag 1 heading_prefix "\n\\centering\\large\\sffamily\\bfseries% \\noindent\\textbf{"heading_suffix "}\\par\\nopagebreak\n" item_0 "\n \\item \\small " delim_0 " \\hfill " delim_1 " \\hfill " delim_2 " \\hfill " ``` Avaimet muuttavat hakemiston tulosteen eri osia: * `headings_flag 1` ottaa käyttöön ryhmittelyn lisäämällä ryhmäotsikon (symbolit, numerot tai kirjaimet) uuden ryhmän eteen. * `heading_prefix` muotoilee otsikon, joka lisätään ennen uuden kirjaimen alkua. Se käyttää tavallisia muotoilukomentoja kirjasinperheelle, fonttikoolle ja tasaamiselle, mutta kenoviivat on pakko kirjoittaa kahdella kenoviivalla yhden sijaan. * `item_0` lisätään kahden ensisijaisen kohteen väliin. * `delim_*` on erotin, joka lisätään avaimen ja ensimmäisen sivunumeron väliin. Täydellinen luettelo .ist-tiedostossa käytettävistä avaimista ja arvoista löytyy [Viiteoppaassa oleva taulukko](#keys-to-create-styles-files). Oletetaan, että edellinen tiedosto on tallennettu nimellä "example\_style.ist". Käyttääksemme sitä asiakirjassa lisäämme parametrin `options= -s example_style.ist` komentoon. `\makeindex` \usepackage\[utf8]{inputenc} ```latex \documentclass{article} \makeindex[columns=3, title=Alphabetical Index, \usepackage[T1]{fontenc} \usepackage{imakeidx} options= -s example_style.ist] \tableofcontents \begin{document} Tässä esimerkissä käytetään useita avainsanoja\index{keywords}, jotka ovat tärkeitä ja ansaitsevat näkyä hakemistossa\index{Index}. \section{Introduction} Termit kuten generate\index{generate}, erinomainen\index{great} lista ja jotkin muut\index{others} termit, jotka saattavat olla tärkeitä\index{important} tulevat myös näkyviin. Hakemiston termejä voidaan myös sisentää \index{Index!nested} Tämä toinen osio\index{section} voi sisältää jonkin erityisen sanan, ja laajentaa jo käytettyjä\index{keywords!used}. \clearpage \section{Second section} Avaa esimerkki, jossa käytetään hakemiston tyylitiedostoa Overleafissa \printindex \end{document} ``` [Index4OLV2.png](https://www.overleaf.com/project/new/template/20614?id=70756423\&templateName=Using+an+index+style+file\&latexEngine=pdflatex\&texImage=texlive-full%3A2020.1\&mainFile=) Seuraava kuva näyttää yllä olevan esimerkin tuottaman tuloksen: ![Hakemiston sisällyttäminen sisällysluetteloon](/files/d693ec8ae6b7cfbba59c15d371219a69f796809f) ## Oletusarvoisesti hakemistoa ei sisällytetä sisällysluetteloon, mutta tämä voidaan helposti muuttaa. \makeindex\[columns=3, title=Alphabetical Index, intoc] ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} Tässä esimerkissä käytetään useita avainsanoja\index{keywords} jotka \begin{document} Tässä esimerkissä käytetään useita avainsanoja\index{keywords}, jotka ovat tärkeitä ja ansaitsevat näkyä hakemistossa\index{Index}. \section{Introduction} ovat tärkeitä ja ansaitsevat näkyä hakemistossa\index{Index}. Termit kuten generate\index{generate} ja some\index{others} tulevat myös näkyviin. Hakemiston termejä voidaan myös sisentää \index{Index!nested} Tämä toinen osio\index{section} voi sisältää jonkin erityisen \clearpage \section{Second section} sanan, ja laajentaa jo käytettyjä\index{keywords!used}. Index5OLV2.png \printindex \end{document} ``` [Avaa tämä esimerkki Overleafissa](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example+3\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%5Bcolumns%3D3%2C+title%3DAlphabetical+Index%2C+intoc%5D%0A%0A%5Cbegin%7Bdocument%7D%0A%5Ctableofcontents%0A%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+%0Aused+which+are+important+and+deserve+to+appear+in+the+%0AIndex%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+%0Awill+also+show+up.+Terms+in+the+index+can+also+be+%0Anested+%5Cindex%7BIndex%21nested%7D%0A%0A%5Cclearpage%0A%0A%5Csection%7BSecond+section%7D%0AThis+second+section%5Cindex%7Bsection%7D+may+include+some+special+%0Aword%2C+and+expand+the+ones+already+used%5Cindex%7Bkeywords%21used%7D.%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Seuraava kuva näyttää yllä olevan esimerkin tuottaman tuloksen: ![Lisäämällä parametrin](/files/a298ff5a7e49eaab28072ef264da3fb8c827a2f2) intoc `komentoon` hakemiston otsikon sisällyttäminen sisällysluetteloon otetaan käyttöön. `\makeindex` Viiteopas ## Parametrit \makeindex-komennolle ### title **Kyseisen hakemiston alkuun ladottava otsikko. Esimerkki on esitetty hakemiston muotoilussa.** Jos tämä valinta annetaan, hakemiston otsikko lisätään sisällysluetteloon. **komentoon** columns **Käyttää syntaksia key=value; arvon on oltava kokonaisluku, joka ilmaisee sarakkeiden lukumäärän. Oletusarvo on 2.** columnsep **Määrittää yksiköt, jotka kuvaavat sarakkeiden välistä erotusta. Syntaksin on oltava key=value, esimerkiksi columnsep=2em.** columnseprule **Jos valinta annetaan, sarakkeiden väliin piirretään pystysuora viiva.** Tyylitiedostojen luontiavaimet ### Seuraava taulukko näyttää avaimet, oletusarvot ja kuvaukset .ist-tyylitiedostojen luomista varten. key | Kuvaus | actual \ | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | `'@' Merkki, joka osoittaa, että seuraava merkintä tulee näkyä tulostiedostossa.` | arg\_close \ | | `'}' Hakemistomerkinnän argumentin sulkeva erotinmerkki.` | arg\_open \ | | `'{' Hakemistomerkinnän argumentin avaava erotinmerkki.` | encap \ | | `' Merkki, joka osoittaa, että argumenttilistan loppuosaa käytetään sivunumeron ympäröivänä komentona.` | escape \ | | `'\\' Merkki, joka pakottaa seuraavan kirjaimen, ellei sitä edeltävä merkki ole itse pakomerkki. Huomaa: lainausmerkkiä käytetään seuraavan kirjaimen pakottamiseen, mutta jos sitä edeltää pakomerkki, sitä käsitellään tavallisena merkkinä. Näiden kahden merkin on oltava erilaiset.` | keyword \ | | `"\\indexentry" Komento, joka kertoo makeindexille, että sen argumentti on hakemistomerkintä.` | level \ | | `'!' Erotin, joka osoittaa alimerkinnän uuden tason.` | quote \ | | `'"' Huomaa: lainausmerkkiä käytetään seuraavan kirjaimen pakottamiseen, mutta jos sitä edeltää pakomerkki, sitä käsitellään tavallisena merkkinä. Näiden kahden merkin on oltava erilaiset.` | range\_close \ | | `')' Sulkeva erotinmerkki, joka osoittaa eksplisiittisen sivuvälin päättymisen.` | range\_open \ | | `'(' Avaava erotinmerkki, joka osoittaa eksplisiittisen sivuvälin alkamisen.` | preamble \ | | `"\\begin{theindex}\n" Tulostiedoston johdanto.` | postamble \ | | `"\n\n\\end{theindex}\n" Tulostiedoston loppuosa.` | setpage\_prefix \ | | `"\n \\setcounter{page}{" Komennon etuliite, joka asettaa aloitussivunumeron.` | setpage\_suffix \ | | `"}\n" Komennon jälkiliite, joka asettaa aloitussivunumeron.` | group\_skip \ | | `"\n\n \\indexspace\n" Pystysuora tila, joka lisätään ennen uuden ryhmän alkua.` | headings\_flag \ | | `0 Lippu, joka osoittaa uusien ryhmäotsikoiden käsittelyn; ne lisätään ennen uutta ryhmää (symbolit, numerot ja 26 kirjainta): positiiviset arvot lisäävät ison kirjaimen etuliitteen ja jälkiliitteen väliin, ja negatiiviset arvot lisäävät pienen kirjaimen (oletus on 0, jolloin otsikkoa ei tuoteta).` | heading\_prefix \ | | `"" Otsikon etuliite, joka lisätään ennen uuden kirjaimen alkua.` | symhead\_positive \ | | `"Symbols" Symbolien otsikko, joka lisätään, jos headings_flag on positiivinen.` | symhead\_negative \ | | `"symbols" Symbolien otsikko, joka lisätään, jos headings_flag on negatiivinen.` | numhead\_positive \ | | `"Numbers" Numeroiden otsikko, joka lisätään, jos headings_flag on positiivinen.` | numhead\_negative \ | | `"numbers" Numeroiden otsikko, joka lisätään, jos headings_flag on negatiivinen.` | item\_0 \ | | `"\n \\item " Komento, joka lisätään kahden ensisijaisen (taso 0) kohteen väliin.` | item\_1 \ | | `"\n \\subitem " Komento, joka lisätään kahden toissijaisen (taso 1) kohteen väliin.` | item\_2 \ | | `"\n \\subsubitem " Komento, joka lisätään kahden tason 2 kohteen väliin.` | item\_01 \ | | `"\n \\subitem " Komento, joka lisätään tason 0 kohteen ja tason 1 kohteen väliin.` | item\_x1 \ | | `"\n \\subitem " Komento, joka lisätään tason 0 kohteen ja tason 1 kohteen väliin, kun tason 0 kohteella ei ole siihen liittyviä sivunumeroita.` | item\_12 \ | | `"\n \\subsubitem " Komento, joka lisätään tason 1 kohteen ja tason 2 kohteen väliin.` | item\_x2 \ | | `"\n \\subsubitem " Komento, joka lisätään tason 1 kohteen ja tason 2 kohteen väliin, kun tason 1 kohteella ei ole siihen liittyviä sivunumeroita.` | delim\_0 \ | | `", " Erotin, joka lisätään tason 0 avaimen ja sen ensimmäisen sivunumeron väliin (oletus: pilkku ja välilyönti).` | delim\_1 \ | | `", " Erotin, joka lisätään tason 1 avaimen ja sen ensimmäisen sivunumeron väliin (oletus: pilkku ja välilyönti).` | delim\_2 \ | | `", " Erotin, joka lisätään tason 2 avaimen ja sen ensimmäisen sivunumeron väliin (oletus: pilkku ja välilyönti).` | delim\_n \ | | `", " Erotin, joka lisätään kahden saman avaimen sivunumeron väliin millä tahansa tasolla (oletus: pilkku ja välilyönti).` | delim\_r \ | | `"--" Erotin, joka lisätään välin alku- ja loppusivunumeron väliin.` | delim\_t \ | | `"" Erotin, joka lisätään sivuluettelon loppuun. Tämä erotin ei vaikuta merkintöihin, joilla ei ole niihin liittyvää sivuluetteloa.` | encap\_prefix \ | | `"\\" Komennon etuliitteen ensimmäinen osa, joka ympäröi sivunumeron.` | encap\_infix \ | | `"{" Komennon etuliitteen toinen osa, joka ympäröi sivunumeron.` | encap\_suffix \ | | `"}" Komennon jälkiliite, joka ympäröi sivunumeron.` | line\_max \ | | `72 Tulosteen rivin enimmäispituus, jonka jälkeen rivi katkeaa.` | indent\_space \ | | `"\t\t" Rivin eteen lisättävä tila, kun rivi jatkuu seuraavalle riville (oletus: kaksi tabulaattoria).` | indent\_length \ | | `16 indent_space-mitan pituus (oletus: 16, vastaa kahta tabulaattoria).` | Lisälukemista | ## Lisätietoja: Sanastot * [Taulukko- ja kuvaluettelot](/latex/fi/asiakirjan-rakenne/05-glossaries.md) * [Sisällysluettelo](/latex/fi/kuvat-ja-taulukot/03-lists-of-tables-and-figures.md) * [Osiot ja luvut](/latex/fi/asiakirjan-rakenne/02-table-of-contents.md) * [Hyperlinkit](/latex/fi/asiakirjan-rakenne/01-sections-and-chapters.md) * [Kieltenvälinen tuki](/latex/fi/asiakirjan-rakenne/09-hyperlinks.md) * [Osioiden ja yhtälöiden ristiinviittaukset](/latex/fi/kielet/03-international-language-support.md) * [Hallinta suuressa projektissa](/latex/fi/asiakirjan-rakenne/03-cross-referencing-sections-equations-and-floats.md) * [Usean tiedoston LaTeX-projektit](/latex/fi/asiakirjan-rakenne/07-management-in-a-large-project.md) * [imakeidx-paketin dokumentaatio](/latex/fi/asiakirjan-rakenne/08-multi-file-latex-projects.md) * [imakeidx package documentation](http://mirror.math.ku.edu/tex-archive/macros/latex/contrib/imakeidx/imakeidx.pdf) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://overleaf-pro.ayaka.space/latex/fi/asiakirjan-rakenne/04-indices.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.