> 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/cs/znalostni-baze/033-cross-referencing-with-the-xr-package-in-overleaf.md). # Křížové odkazy s balíčkem xr na Overleafu ## Přehled Ta [`xr` accents](https://ctan.org/pkg/xr?lang=en) umožňuje vytvářet křížové odkazy na rovnice, obrázky, tabulky apod. obsažené v externích LaTeXových dokumentech, pokud jsou tyto dokumenty *samostatné.* Samostatný LaTeXový dokument je takový, který lze zkompilovat, protože obsahuje `\documentclass{...}` příkaz a `\begin{document}`...`\end{document}` konstrukci. ### Stručný přehled použití 1. Napište `\usepackage{xr}` v preambuli LaTeXového souboru, který potřebuje odkazovat na obsah obsažený v externích LaTeXových souborech. 2. Použijte `xr` příkaz balíčku `\externaldocument{filename}` pro určení externího dokumentu/dokumentů, jejichž obsah chcete odkazovat pomocí křížových odkazů. Ta `xr` balíček funguje tak, že používá štítky křížových odkazů obsažené v `.aux` souborech vygenerovaných při kompilaci externích LaTeXových dokumentů. ### Jak fungují křížové odkazy (stručné shrnutí) Chcete-li odkazovat na položku v LaTeXovém dokumentu, musíte: 1. Dejte jí jedinečný identifikátor, `some_string`, pomocí `\label` příkazu: ```latex \label{some_string} ``` 3. V místě, kde chcete na daný prvek odkazovat, je třeba napsat ```latex \ref{some_string} ``` Stručně řečeno, LaTeX spravuje křížové odkazy tím, že zapisuje data do souboru nazvaného `filename.aux` kde `filename` je název hlavního `.tex` kompilovaného souboru. Aby proces fungoval, musí být LaTeXový dokument zkompilován alespoň dvakrát: první kompilace *vygeneruje* referenční data — zapíše je do `filename.aux`. Během druhé kompilace LaTeX *čte* `filename.aux` aby vyřešil odkazy a poskytl data pro nahrazení výskytů `\ref{some_string}`. * Pro více podrobností o křížových odkazech viz článek Overleaf [Křížové odkazy na sekce, rovnice a plovoucí objekty](/latex/cs/struktura-dokumentu/03-cross-referencing-sections-equations-and-floats.md). ## Projekty, kde balíček xr není vyžadován Velké LaTeXové projekty, jako jsou knihy nebo dlouhé zprávy, jsou často rozděleny do série menších `.tex` souborů, jeden na kapitolu, přičemž soubor každé kapitoly `.tex` je přidán do hlavního LaTeXového dokumentu pomocí `\input` nebo `\include`. Obvykle tyto kapitoly nejsou samostatné: jednotlivé kapitoly nelze zkompilovat, protože neobsahují `\documentclass{...}` příkaz ani `\begin{document}...\end{document}` konstrukci. Tyto kapitoly jsou určeny k *vložením* do „kontejnerového“ dokumentu, který *lze* zkompilovat. V takovém případě mohou křížové odkazy na prvky dokumentu — v rámci kteréhokoli jednotlivého souboru kapitoly — probíhat normálně: není třeba používat `xr` balíček. Chcete-li prozkoumat příklad velkého projektu, můžete [otevřít tento příklad v Overleafu.](https://www.overleaf.com/project/new/template/20618?id=70769185\&templateName=Managing+a+large+project+on+Overleaf\&latexEngine=pdflatex\&texImage=texlive-full%3A2020.1\&mainFile=) ## Příklad projektu, kde je balíček xr vyžadován Předpokládejme, že máte sadu samostatných LaTeXových dokumentů, například sbírku N článků: `article1.tex`, `article2.tex` ... `articleN.tex`. Každý z těchto článků lze zkompilovat samostatně a je pravděpodobné, že byly napsány s použitím různých tříd dokumentů, balíčků apod. Nyní si představte, že chcete pomocí LaTeXu napsat přehled nebo shrnutí těchto článků — náš soubor budeme nazývat `summary.tex`. Naše shrnutí potřebuje odkazovat na sekce, obrázky, tabulky, rovnice apod. obsažené v těchto jednotlivých samostatných N článcích. Jak to můžeme udělat? Ta `xr` balíček vám to umožňuje: umožňuje `summary.tex` používat referenční štítky vygenerované kterýmkoli ze samostatných `article*.tex` soubory. ### Poznámka k souborům .aux * Poznámka: zde používáme hvězdičku (`*`) jako zástupný symbol pro libovolné číslo od 1 do N. Zkompilování kteréhokoli ze samostatných souborů `article1.tex`, `article2.tex` ... `articleN.tex` způsobí, že LaTeX vygeneruje odpovídající `article*.aux` (\*\*`aux`pomocný soubor, který mimo jiné obsahuje údaje štítků potřebné pro vytváření křížových odkazů. Pokud některý z `article*.tex` souborů je upraven — například aby se změnily, přidaly nebo odstranily štítky (`\label{...}`) — odpovídající `article*.tex` soubor(y) musí být znovu zkompilovány, aby se aktualizovaly související `article*.aux` souboru/souborech). Zjišťování změn v `article*.tex`, a jejich následná rekompilace může být v Overleafu automatizována pomocí vhodného `latexmkrc` souboru. ## Jak používat xr v Overleafu Použijeme zjednodušenou verzi našeho příkladu s více články; konkrétně ukážeme, jak automatizovat kompilaci pomocí `latexmkrc` souboru [poskytnutého společnosti Overleaf Johnem Collinsem](#code-for-latexmkrc) ([správce `latexmk`](https://ctan.org/pkg/latexmk?lang=en)). ### Soubory použité v našem příkladu Náš příklad používá následující soubory: * `**summary.tex**`: toto je náš přehledový dokument. Potřebujeme, aby odkazoval na obsah obsažený v `article1.tex`, například obrázky a sekce. * `summary.tex` načítá `xr` balíček a používá `\externaldocument{article1}` k určení, že referenční data z `article1.aux` mají být použita. * `**article1.tex**`: jeden samostatný článek, který obsahuje vnitřní křížové odkazy. Kompilací `article1.tex` se vygenerují data křížových odkazů obsažená v souboru `article1.aux`. * Externí soubor jako například `article1.tex` který mohl napsat někdo jiný — abyste jej mohli použít „tak, jak byl poskytnut“, tj. beze změn. * `**latexmkrc**`: obsahuje kód (Perl) pro automatizaci rekompilace `article1.tex` kvůli jakýmkoli změnám v něm provedeným — za účelem vytvoření aktualizovaného `article1.aux` souboru. * Náš `latexmkrc` soubor byl [poskytnutého společnosti Overleaf Johnem Collinsem](#code-for-latexmkrc) ([správce `latexmk`](https://ctan.org/pkg/latexmk?lang=en)). ### O příkazu \externaldocument Ta `xr` balíček poskytuje`\externaldocument` příkaz, který má obecný tvar ```latex \externaldocument[prefix]{external_file} ``` * **`prefix` (volitelný):** Tento volitelný argument umožňuje definovat prefix, který bude přidán ke všem štítkům importovaným z externího dokumentu. To je užitečné, aby se předešlo konfliktům, pokud jsou ve více dokumentech použity stejné názvy štítků. * **`external_file` (povinný):** Tento povinný argument určuje název externího LaTeXového dokumentu (bez `.tex` přípony), ze kterého chcete importovat odkazy. Balíček `xr` bude hledat `.aux` soubor odpovídající `external_file` (např., `external_file.aux`) pro načtení štítků. Například pokud náš hlavní `.tex` souboru `summary.tex` a externí soubor, `article1.tex` oba obsahují štítek `\label{eq:1}` pak dochází ke kolizi názvů štítků. Té lze zabránit zápisem ```latex \externaldocument[art1-]{article1} ``` v takovém případě budou všechny štítky vytvořené kompilací `article1.tex` budou opatřeny prefixem `art1-`. Nyní můžete přistupovat k `\label{eq:1}`, obsažené v `article1.tex`, zápisem `\ref{art1-eq:1}` v `summary.tex`. ### Soubory projektu #### article1.tex Následující kód lze otevřít v Overleafu pomocí odkazu pod výpisem. ```latex \documentclass{article} \title{Toto je \texttt{article1.tex}} \begin{document} \section{Úvod} \label{introduction} Toto je samostatný \LaTeX{} dokument s odkazy, které chceme použít v \texttt{summary.tex}. \subsection{Matematické odkazy} \label{mathrefs} Jak bylo uvedeno v sekci \ref{introduction}, na různé prvky lze odkazovat v rámci dokumentu. \subsection{Mocninné řady} \label{powers} \begin{equation} \label{eq:1} \sum_{i=0}^{\infty} a_i x^i \end{equation} Rovnice \ref{eq:1} je typická mocninná řada. \end{document} ``` [Otevřít `article1.tex` v Overleafu](https://www.overleaf.com/docs?engine=%5B%5B%3ATemplate%3AEngine%5D%5D}\&snip_name\[]=readme.txt\&snip\[]=A+project+created+from+the+Overleaf+wiki\&snip_name\[]=article1.tex\&main_document=article1.tex\&snip\[]=%5Cdocumentclass%7Barticle%7D%0A%5Ctitle%7BThis+is+%5Ctexttt%7Barticle1.tex%7D%7D%0A%5Cbegin%7Bdocument%7D%0A%5Csection%7BIntroduction%7D%0A%5Clabel%7Bintroduction%7D%0A%0AThis+is+a+standalone+%5CLaTeX%7B%7D+document+with%0Areferences+we+want+to+use+in+%5Ctexttt%7Bsummary.tex%7D.%0A%0A%5Csubsection%7BMath+references%7D%0A%5Clabel%7Bmathrefs%7D%0AAs+mentioned+in+section+%5Cref%7Bintroduction%7D%2C+%0Adifferent+elements+can+be+referenced+within%0Aa+document.%0A%0A%5Csubsection%7BPowers+series%7D%0A%5Clabel%7Bpowers%7D%0A%0A%5Cbegin%7Bequation%7D%0A%5Clabel%7Beq%3A1%7D%0A%5Csum_%7Bi%3D0%7D%5E%7B%5Cinfty%7D+a_i+x%5Ei%0A%5Cend%7Bequation%7D%0A%0AEquation+%5Cref%7Beq%3A1%7D+is+a+typical+power+series.%0A%5Cend%7Bdocument) Kompilace `article1.tex` vytváří následující výstup: ![Výstup vytvořený kompilací souboru article1.tex v Overleafu](/files/a604ee791f8c9dae71507b4792f87aa51232a390) #### summary.tex Zde je náš počáteční `summary.tex` souboru *dříve, než* jsme určili, na který externí dokument chceme odkazovat. Pro jednoduchost, `summary.tex` neobsahuje žádné `\label` příkazy, protože neobsahuje žádné vnitřní křížové odkazy. Všechny `\ref` příkazy odkazují na štítky vygenerované `\label` příkazy obsažené v `article1.tex`. ```latex \documentclass{article} \usepackage{xr} \title{Toto je \texttt{summary.tex}} \begin{document} V souboru \texttt{article1.tex} je úvod sekce \ref{introduction}. V tomto souboru jsou dvě podsekce: \ref{mathrefs} a \ref{powers}. V podsekci \ref{powers} rovnice \ref{eq:1} demonstruje mocninnou řadu. \end{document} ``` [Otevřete tento *neúplný* `summary.tex` v Overleafu](https://www.overleaf.com/docs?engine=%5B%5B%3ATemplate%3AEngine%5D%5D}\&snip_name\[]=readme.txt\&snip\[]=A+project+created+from+the+Overleaf+wiki\&snip_name\[]=summary.tex\&main_document=summary.tex\&snip\[]=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bxr%7D%0A%5Ctitle%7BThis+is+%5Ctexttt%7Bsummary.tex%7D%7D%0A%5Cbegin%7Bdocument%7D%0AIn+the+file+%5Ctexttt%7Barticle1.tex%7D%2C+the+introduction+is+section+%5Cref%7Bintroduction%7D.++In+that+file%2C+there+are+two+subsections%3A+%5Cref%7Bmathrefs%7D+and+%5Cref%7Bpowers%7D.+In+subsection+%5Cref%7Bpowers%7D%2C+equation+%5Cref%7Beq%3A1%7D+demonstrates+a+power+series.%0A%5Cend%7Bdocument%7D) Pokud zkompilujeme tuto verzi `summary.tex` pokusí se načíst referenční data z `summary.aux` ale požadovaná data jsou obsažena v externím souboru `article1.aux` ke kterému zatím nelze přistoupit. Zkompilování tohoto neúplného `summary.tex` souboru vytvoří následující výstup, přičemž dvojité otazníky ukazují nedefinované odkazy: ![Obrázek zobrazující hlášení o chybějících odkazech](/files/85a94530e613a56e92ad9ea04fbd27c3196b757d) ### Určení externího dokumentu Dalším krokem je určit `article1` jako název externího dokumentu, jehož štítky chceme odkazovat. Přidejte následující řádek do preambule `summary.tex`: ```latex \externaldocument{article1} ``` Zde, `article1` lze nahradit libovolným souborem, jehož štítky chcete zpřístupnit — můžete použít více `\externaldocument` příkazů pro zpřístupnění dalších externích souborů. ### Vytvoření souboru latexmkrc Dalším krokem je vytvořit `latexmkrc` soubor, jak je znázorněno níže: * V okně editoru projektu vyberte **Nový soubor** ikonu v levém horním rohu okna projektu. * Vyberte **Nový soubor** z **Přidat soubory** vyskakovacího dialogového okna a pojmenujte soubor `latexmkrc`— poznámka: není zde žádná přípona souboru: ![Vytvoření souboru latexmkrc v Overleafu](/files/5d8d3df6a06914d562128dd750828806bd705219) * Ujistěte se, že `latexmkrc` soubor je vytvořen a uložen v horní (kořenové) úrovni oblasti souborů projektu. Tedy ne uvnitř žádné složky ve stromu souborů. * Zkopírujte a vložte následující kód do svého `latexmkrc` souboru. #### Kód pro latexmkrc Overleaf děkuje Johnu Collinsovi, [správce `latexmk`](https://ctan.org/pkg/latexmk?lang=en)za to, že nás kontaktoval a poskytl následující `latexmkrc` soubor, který s potěšením zveřejňujeme v plném znění — včetně mimořádně užitečných vložených komentářů. ```perl # Toto ukazuje, jak používat balíček xr s latexmk. # John Collins 2023-03-29 # # Balíček xr ("systém pro externí odkazy") je používán dokumentem # k vytváření odkazů na sekce, rovnice apod. v jiných externích # dokumentech. # Definice v tomto souboru umožňují latexmku spouštět latexmk pro # automaticky aktualizovat externí dokument pokaždé, když se jeho soubor .tex změní, # aby odkazy v hlavním dokumentu zůstaly aktuální. # Poznámky: # 1. Tato verze je nastavena tak, aby soubory z kompilací # externích dokumentů ukládala do určeného podadresáře, aby oddělila # potenciálně mnoho generovaných souborů od hlavního dokumentu # adresářů. # 2. Aby však bylo možné použít vlastní mechanismus závislostí latexmku, jako zde, # soubor aux z kompilace poddokumentu musí být vygenerován v # stejném adresáři jako odpovídající zdrojový soubor .tex. Proto se # soubor .aux kopíruje. # 3. Předpokládá se, že externí dokumenty mají být kompilovány pomocí # pdflatex. To lze samozřejmě změnit úpravou volby '-pdf' # předané spuštěnému latexmku na cokoli je potřeba. # 4. Ideální implementace by také zajistila, že rekompilace # externího dokumentu proběhne také pokaždé, když se některý z jeho dalších zdrojových # souborů změní. To však v této verzi není provedeno a # pravděpodobně by to vyžadovalo buď použití interních proměnných latexmku # nebo další rozšíření latexmku. # 5. Kód používá podprogramy copy a fileparse, které jsou načítány # latexmkem z Perl balíčků File::Copy a File::Basename. # 6. Používá také některé dosud nedokumentované vlastnosti latexmku: pole # proměnnou @file_not_found a podprogramy popd, pushd a # rdb_add_generated. #-------------------- # Konfigurovatelné volby pro kompilaci externích dokumentů # Podsložka pro výstupní soubory z kompilace externích dokumentů: $sub_doc_output = 'output-subdoc'; # Volby předávané latexmku pro kompilaci externích dokumentů: @sub_doc_options = (); push @sub_doc_options, '-pdf'; # Použijte pdflatex pro kompilaci externích dokumentů. # Nahraďte '-pdf' volbou '-pdfdvi', 'pdfxe' nebo 'pdflua', je-li třeba. #-------------------- # Přidejte vzor pro zprávu xr v log souboru o chybějících souborech do latexmk # seznamu. Proměnná latexmku @file_not_found zatím není zdokumentována. # Tento řádek není pro verzi 4.80 nebo novější latexmku potřeba. push @file_not_found, '^No file\\s*(.+)\s*$'; add_cus_dep( 'tex', 'aux', 0, 'makeexternaldocument' ); sub makeexternaldocument { if ( $root_filename ne $_[0] ) { my ($base_name, $path) = fileparse( $_[0] ); pushd $path; my $return = system "latexmk", @sub_doc_options, "-aux-directory=$sub_doc_output", "-output-directory=$sub_doc_output", $base_name; if ( ($sub_doc_output ne '') && ($sub_doc_output ne '.') ) { # V tomto případě soubor .aux vygenerovaný pdflatexem není ve stejném # adresáři jako soubor .tex. # Proto: # 1. Skutečně vygenerovaný soubor aux musí být uveden jako vytvořený touto # pravidlem, aby latexmk správně pracoval se závislostmi. # (Problém k překonání: pokud je $sub_dir_output stejný jako $aux_dir # pro hlavní dokument, xr může číst soubor .aux v # aux_dir spíše než ten, který latexmk u vlastní závislosti předpokládá # vytvořit, a který je ve stejném adresáři jako zdrojový soubor .tex # pro tuto vlastní závislost.) # Použijte dosud nedokumentovaný podprogram latexmku rdb_add_generated # k tomu: # 2. Kopie souboru .aux musí být ve stejném adresáři jako soubor .tex # aby byla splněna definice vlastního závislostního vztahu latexmku. rdb_add_generated( "$sub_doc_output/$base_name.aux" ); copy "$sub_doc_output/$base_name.aux", "."; } popd; return $return; } } ``` ### Otevřete projekt v Overleafu demonstrující xr Následující projekt se třemi soubory lze nyní otevřít v Overleafu pomocí odkazů uvedených výše a pod výpisy souborů. Všimněte si, že `latexmkrc` soubor obsahuje kód poskytnutý Johnem Collinsem, ale kvůli stručnosti byla většina komentářů odstraněna. [Otevřete tento příklad se třemi soubory v Overleafu.](/latex/cs/znalostni-baze/033-cross-referencing-with-the-xr-package-in-overleaf.md) **summary.tex** Toto je náš soubor shrnutí. Z tohoto souboru chceme používat křížové odkazy vytvořené v externích souborech. Zde chceme použít štítky vygenerované v `article1.tex`. ```latex \documentclass[12pt]{article} \usepackage{xr} \title{Použití balíčku xr v Overleafu} % vložte sem všechny externí dokumenty! \externaldocument{article1} \begin{document} V souboru \texttt{article1.tex} je úvod sekce \ref{introduction}. V tomto souboru jsou dvě podsekce: \ref{mathrefs} a \ref{powers}. V podsekci \ref{powers} rovnice \ref{eq:1} demonstruje mocninnou řadu. \end{document} ``` **article1.tex** Tento soubor je jedním z našich článků. Všimněte si, že obsahuje různé `\label` příkazy pro vytváření štítků, které díky `xr` balíčku můžeme použít v souboru `summary.tex`. ```latex \documentclass{article} \title{Toto je \texttt{article1.tex}} \begin{document} \section{Úvod} \label{introduction} Toto je samostatný \LaTeX{} dokument s odkazy, které chceme použít v \texttt{summary.tex}. \subsection{Matematické odkazy} \label{mathrefs} Jak bylo uvedeno v sekci \ref{introduction}, na různé prvky lze odkazovat v rámci dokumentu. \subsection{Mocninné řady} \label{powers} \begin{equation} \label{eq:1} \sum_{i=0}^{\infty} a_i x^i \end{equation} Rovnice \ref{eq:1} je typická mocninná řada. \end{document} ``` **latexmkrc** Tento `latexmkrc` soubor obsahuje kód, který zajišťuje kompilaci externích souborů. ```latex $sub_doc_output = 'output-subdoc'; @sub_doc_options = (); push @sub_doc_options, '-pdf'; # Použijte pdflatex pro kompilaci externích dokumentů. # Nahraďte '-pdf' volbou '-pdfdvi', 'pdfxe' nebo 'pdflua', je-li třeba. push @file_not_found, '^No file\\s*(.+)\s*$'; add_cus_dep( 'tex', 'aux', 0, 'makeexternaldocument' ); sub makeexternaldocument { if ( $root_filename ne $_[0] ) { my ($base_name, $path) = fileparse( $_[0] ); pushd $path; my $return = system "latexmk", @sub_doc_options, "-aux-directory=$sub_doc_output", "-output-directory=$sub_doc_output", $base_name; if ( ($sub_doc_output ne '') && ($sub_doc_output ne '.') ) { rdb_add_generated( "$sub_doc_output/$base_name.aux" ); copy "$sub_doc_output/$base_name.aux", "."; } popd; return $return; } } ``` [Otevřete tento příklad se třemi soubory v Overleafu.](/latex/cs/znalostni-baze/033-cross-referencing-with-the-xr-package-in-overleaf.md) Následující grafika je anotovanou verzí výstupu z typografického zpracování `summary.tex`, která ukazuje křížové odkazy a odpovídající štítky z externího souboru `article1.tex`. ![Zobrazení odkazů importovaných z externího souboru](/files/7f10da06ce71331d904512462e26df6fd6329e98) * Pro více podrobností o křížových odkazech viz článek Overleaf [Křížové odkazy na sekce, rovnice a plovoucí objekty](/latex/cs/struktura-dokumentu/03-cross-referencing-sections-equations-and-floats.md). ## Poznámka k syntaktickým chybám Pro hlavní soubor projektu můžete použít funkci Overleafu [režim kompilace „Zastavit při první chybě“](/latex/cs/znalostni-baze/149-using-the-stop-on-first-error-compilation-mode.md) aby kompilace skončila okamžitě po zjištění první chyby. To může pomoci izolovat a identifikovat chyby ve vašem kódu místo toho, aby se chyby řetězily, což výrazně ztěžuje hledání a ladění problémů. Ta *external* dokumenty jsou kompilovány automaticky prostřednictvím `latexmkrc` souboru; v důsledku toho se jakékoli syntaktické chyby LaTeXu v nich nezobrazí v rozhraní Overleafu — pokud je také znovu nezkompilujete v Overleafu. Chyby v těchto externích souborech mohou zabránit správnému zobrazení křížových odkazů ve vysázeném PDF souboru, proto důrazně doporučujeme takové chyby ihned po jejich výskytu zkontrolovat a opravit. --- # 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/cs/znalostni-baze/033-cross-referencing-with-the-xr-package-in-overleaf.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.