Back to site

Што такое мінімальны працоўны прыклад?

Хрысціянскі Faulhammer
Версія: 0.6

2009-08-18

Змест

1 Падзякі
2 Якія мінімальныя працоўныя тэзіс прыкладамі (Mwesa) вы працягваеце казаць?
3 Інструменты
3,1 Перамяшчэнне канца
3.1.1 адзін файл
3.1.2 кампазітныя файлы
3,2 Спрашчэнне
3.2.1 Выдаленне пакетаў непатрэбныя
3.2.2 Уласныя каманды і асяроддзі
3.2.3 Скарачэнне
3.2.4 Выдаленне фатаграфіі
3.2.5 Дадатковыя файлы неабходныя
4 Прыклады
4,1 Няправільны сінтаксіс
4,2 Непажаданыя Паводзіны
4,3 невытлумачальнае ;-) comportement
4,4 каменем перапоны, акрамя зыходнага кода
4.4.1 Праблемы з інтэрфейсамі
4.4.2 праблемы, якія не пойдуць

Гэты дакумент быў створаны з-за неабходнасці пастаўляць пачаткоўцаў навін de.comp.text.tex з наборам прыкладаў, якія дэманструюць Удакладніць і прынцып мінімальнага працоўныя прыклады. Гэты тэкст цалі грамадскім здабыткам, групы навін версія (на нямецкай мове) ў цяперашні час падтрымліваецца хрысціянскай Faulhammer і згаданыя ў увядзенні рэгулярна публікуецца. Калі ласка, накіроўвайце свае папраўкі, прапановы і заўвагі да хрысціянскай (у) faulhammer.org.

Хто хоча ныраць глыбей у сэнс паведамленні пра памылкі павінны "паглядзець на L A T E X Companion, што паблізу befriedigend для пачаткоўцаў.

Заўвага ў дачыненні да англійскай мове: На пачатковым этапе праца і першы поўны пераклад, зроблены карыстальнікам, Ульрых Шварц. Зараз гэта страціў сваю сілу хрысціянскай Faulhammer.

1 Падзякі

Перш за ўсё дзякуй усім membres дзю навін, якія неаднаразова расказаць людзям, як важна Мінімальная працоўная прыклад і парады, як яго стварыць. У прыватнасці я хачу падзякаваць Ульрых Шварц заліць ла Пачатковае Пераклад у Francais, Хилмар Прейс Для першага L A T E X версіі і Курт Lidwine заліць ла перапрацоўка "апошняга.

2 Якія мінімальныя працоўныя тэзіс прыкладамі (Mwesa) Вы захоўваеце кажаце?

Стварэнне MWE спосаб выяўлення і выпраўлення памылак, а таксама "У пошуках прычын некаторыя з паводзінаў. Mwesa павінны быць настолькі маленькі і просты, як магчыма, яшчэ поўным, г.зн. пагаднення яны да асноўнай структуры L T X дакуменце E і можа быць L A T E X Эд без далейшага дапаўненні.

MWE павінны быць поўнымі і працоўных,

MWE павінны быць невялікімі,

Нават навічкі павінныя мець ніякіх праблем Стварэнне Mwesa, шчырая Гэта зойме крыху цярпення і здаровага сэнсу. У МОСТ скрынкі, вы знойдзеце прычыну вашай праблемы самастойна, тым самым робячы непатрэбныя паведамленні. Пасля гэтай кароткай матывацыі, мы пералічыў сродкі і працэдуры на рукі, пасля чаго некалькі прыкладаў. Мы будзем мець справу з рознымі крыніцамі праблем (няправільны варыянты пакета, сутыкненне пакетаў, няспраўных сінтаксісу, і г.д.). Асобна. У складаных клетак, усё гэта павінна разглядацца ў той жа час.

3 Інструменты

Асноўная канцэпцыя, якая ляжыць Стварэнне MWE з'яўляецца: "падзяляй і ўладар". Ёсць некалькі спосабаў, якія дзеляцца, некаторыя з якіх у залежнасці ад структуры дакумента. Перш за ўсё, каманда \ Listfiles павінны быць дададзены ў дакумент, так што ўсе выкарыстоўваюцца файлы (пакеты, класы і г.д.). У тым ліку інфармацыю аб версіі, буде часопіс. Гэтая важная інфармацыя для людзей можа быць і не павінен быць апушчаны адказу.

Акрамя таго, правёў звычайнае правіла: зрабіце рэзервовую копію, і мы працуем толькі копіі, каб прадухіліць выпадковае выдаленне матэрыялу!

3.1 Перамяшчэнне канца

3.1.1 Адзін файл

Калі ў цэлым аднаго зыходнага файла, наступная методыка карысная: Падыходзіць прасоўванне каманды "\ канец {} дакумент" дапаможа звузіць груба дзе гэтая праблема стаіць. Робячы гэта, мы рухацца ўверх па блоках. (Гэта значэнне-лагічных блокаў, то ёсць пунктаў, запячатаных асяроддзя канверце \ пачаць-\ канцы аднагодкаў і г.д.). Пры гэтым, мы толькі павінны рухацца ў адным радку (не забудзьцеся паўторна L A T E X кожны раз!) І Ці будзе атрымаць ацэнку года, у якім Блок памылка. Зараз выдаліце ўсе, ад толькі пасля "\ пачаць {} дакумент" да толькі падазроныя Перад блок, і ціс праблема застаецца, то ёсць дзе праблема.

3.1.2 Кампазітны файлы

У прынцыпе, выснова працэдура, аналагічная працэдуры абрысы вышэй, проста канец файла, які счытваецца з дапамогай \ ўваход пазначаецца \ endinput. Папярэдне, аднак, вы павінны "Вызначыць адказных частак паслядоўным каментуючы з \ ўваход і / ці ўключаць каманды або з дапамогай \ includeonly.

3.2 Спрашчэнне

Калі блок, які змяшчае праблема была "знойдзена, яна павінна быць дастаткова спрошчанай, аж да адсочвання памылка ў адным радку. Гэта тое, што наступныя праілюстраваць прыкладамі.

3.2.1 Выдаленне пакетаў непатрэбныя

Ёсць пакеты, якія проста не будуць працаваць разам. Пакет Мы выдалім крок за крокам, каб убачыць, калі гэта наша праблема. Каб палегчыць гэта, чалавек запісу выкарыстоўваць \ usepackage каманду:

1\usepackage{ 
2  amsmath, 
3  listings, 
4  lmodern 
5}

Пакетаў, якія можна так пракаментаваў з выкарыстаннем адной%. Як толькі памылка знікае, зноў ўключыць пакет апошні каментар, і пераходзіць да наступнай.

3.2.2 Каманды і асяроддзяў ўласныя прыстасаваныя каманды і асяроддзі павінны быць цалкам апушчаны, калі яны не выкарыстоўваюцца ў астатняй частцы дакумента "вычышчана" У адваротным выпадку, я толькі што атрымаў # 1 Ёсць другі аргумент або наогул нічога не рабіць. Гэта павінна быць ", а Праведзеныя крок за крокам, у выпадку памылкі, выкліканай С. адной з гэтых каманд.

3.2.3 Скарачэнне

Зараз мы ў асноўным ідуць назад на "перамяшчэнне канца", не толькі блок-парадкова. Я не думаю, што гэта павінна быць прапісана ў поўнай дэталізацыі. Аптымальна, адной радкі дакумента застаецца тое, што можа быць POURSUITES Акрамя таго, золата, калі нічога не дапамагае, апублікаванае на comp.text.tex (залатым эквіваленце Падыходзіць такія, як золата fr.comp.tex de.comp.text.tex).

Ёсць яшчэ больш адключэнне Шляхі акцый дакумента, напрыклад, як пакет, умовы (калі) і іншыя.

3.2.4 Выдаленне фатаграфіі

Размяшчэнне фатаграфіі (амаль) заўсёды праблема. Мы павінны прайсці 'Em, каб атрымаць Нараўне кампілюецца дакумента. Яны, як правіла, мэта вялікі памер файла і можа ўтрымліваць канфідэнцыйную інфармацыю. Такім чынам, мы не можам паставіць іх на вэб-дзе-то Eith. Што мы будзем рабіць тады? Ну, мы можам проста замяніць малюнак з чорным прастакутнікам памеру appropriee, якія мы можам генерыраваць з дапамогай \ правілы.

3.2.5 Дадатковыя файлы неабходныя

Часам Там няма Way Round Дадатковыя файлы для апісання праблемы, напрыклад, невялікі Bib TEX file. LATEX offers a simple way to keep everything in one file and on demand the additional files are created on-the-fly with a given content: the filecontents environment.

1\begin{filecontents}{filename.bib} 
2  Some nonsense 
3\end{filecontents} 
4\documentclass[a4paper]{article} 
5...

4 Прыклады

Калі ласка, звярніце ўвагу: нумары радкоў устаўленыя для растлумачэння былі і зручнасці карыстання. Далі ніжэй, не з'яўляюцца прыкладамі L A T E X кабеля. Калі ласка, апусціць нумары радкоў у вашым родным прыкладаў.

4.1 Няправільны сінтаксіс

Ніжэй прыводзіцца простае раўнаньне выраўнаваны, якія могуць быць створаны з дапамогай eqnarray навакольнага асяроддзя, але amsmath пакет з'яўляецца больш магутным на сённяшні дзень.

Над прыводзіць нас да падазраваным той памылкі ў лініі 6 да 9 . Такім чынам, тыдзень, як усе астатнія лініі ў выраўнаваць навакольнага асяроддзя.

1\documentclass[a4paper]{article} 
2\usepackage{amsmath} 
3 
4\begin{document} 
5\begin{align*} 
6  S_1 > S > S_2 \\ 
7%  \Rightarrow S_1 & = \mathrm{e}^{x}  \\ 
8%  \Rightarrow S_1 & = \mathrm{e}^{y} \\ 
9%  \Rightarrow S_1 & = \mathrm{e^{x} \\ 
10%             & = \boxed{\mathrm{e}^{z}} 
11\end{align*} 
12\end{document}

Памылкі не ўзнікае больш, нефармальныя і неафіцыйныя, што мы выдалілі занадта шмат. Усталяваўшы зноўку лініі адзін за адным, L A T E X-ING зноў пасля кожнага з іх, з тым паказвае лініі 8 , Памылка паўтараецца. Тады, Усе Да гэтага да \ {пачаць выраўноўванне *} закаментаваны, але памылка "усё яшчэ застаецца. Такім чынам, у выходныя дні зараз выдаліць гэтыя лініі, у выніку чаго MWE год, так як толькі адзін пакет загружаецца з'яўляецца забеспячэнне ўзгаднення навакольнага асяроддзя, у першую чаргу:

1\documentclass[a4paper]{article} 
2\usepackage{amsmath} 
3 
4\begin{document} 
5\begin{align*} 
6  \Rightarrow S_1 & = \mathrm{e^{x} 
7\end{align*} 
8\end{document}

Уважліва паглядзець (і, магчыма, дапаможа вашым рэдактарам любы добры рэдактар канадскіх вылучыць адпаведныя дужках) у цяперашні час паказвае, што мы забыліся зачыняе дужку ў \ mathrm {E ^ {х}.

4.2 Непажаданыя Паводзіны

Дапусцім, крыніца Наступнае:

1\documentclass[a4paper]{article} 
2\usepackage{amsmath} 
3\newcommand{\im}{\mathrm{i}}   
4\newcommand{\e}{\mathrm{e}}   
5\begin{document} 
6\begin{align} 
7 f_N(t) = & \frac{A_0}{2} + \sum_{k=1}^{}\infty \left(  \frac{1}{2} \left( A_k -\im B_k \right) \e^{} {\im   \alpha t} + \frac{1}{2} \left( A_k +  \im B_k \right)   \e ^{} {- \im \alpha t} \right) \\   
8          & \text{mit } B_0=0 \text{ und } \alpha = \omega t 
9\end{align} 
10\end{document}

Мы не любім, відавочна, занадта маленькае прастору паміж імі знак роўнасці доляй Створана і ў лінію 7 . Мы хацелі б падрабязна гэта для чытачоў comp.text.tex, мэта, якую мы ведаем, гэта не з'яўляецца, але наглядны прыклад. Такім чынам, мы Прыклад Каб Гранічныя падзення акцый, не уключаючы, магчыма, што вызначаюцца карыстальнікам каманд у радках 3 і 4 , Якія выхадныя праверыць шляхам апаражнення іх.

1\documentclass[a4paper]{article} 
2\usepackage{amsmath} 
3\newcommand{\im}{} 
4\newcommand{\e}{} 
5\begin{document} 
6\begin{align} 
7 f_N(t) = & \frac{A_0}{2} + \sum_{k=1}^{}\infty \left( 
8  \frac{1}{2} \left( A_k -\im B_k \right) \e^{} {\im 
9  \alpha t} + \frac{1}{2} \left( A_k +  \im B_k \right) 
10  \e^{} {- \im \alpha t} \right) \\ 
11          & \text{mit } B_0=0 \text{ und } \alpha 
12             = \omega t 
13\end{align} 
14\end{document}

Мы не зацікавіць правільнасць матэматыкі Удзел для нашых мэтаў. Аб дакуменце яшчэ ўсё яшчэ даволі складаны (добра, мы гэта прэтэндаваць на момант, шчырая У адваротным выпадку гэта ўсё не мае сэнсу.) Тое, што мы сапраўды трэба, гэта лінія 7 І толькі дэ-Cette пачатку, таму мы спрашчаем і выдаліць адпачынку яшчэ трохі.

1\documentclass[a4paper]{article} 
2\usepackage{amsmath} 
3 
4\begin{document} 
5\begin{align} 
6 f = & \frac{a}{b} 
7\end{align} 
8\end{document}

А цяпер, атрымліваем, што O года MWE праілюстраваць праблемы цягнуць вакол Без дадатковых накладных расходаў. ПАСЛЯ Можна выказаць здагадку, каб выправіць праблему:

1\documentclass[a4paper]{article} 
2\usepackage{amsmath} 
3 
4\begin{document} 
5\begin{align} 
6  f & = \frac{a}{b} 
7\end{align} 
8\end{document}

4.3 Невытлумачальнае ;-) comportement

У гэтым прыкладзе асноўным браніравання каб паказаць, як замяніць тое, што не можа быць лёгка Для навін Паведамленні ў выглядзе тэксту. Што гэта азначае? Пры ўстаўкі фатаграфіі ў дакумент Гэтыя, як правіла, досыць шырокі і канадскіх правіла, не можа быць ўбудаваны ў праводку ў выглядзе тэксту, шчырым Большасць сервераў не дазваляюць тэкставых паведамленняў у бінарных груп, такіх як comp.text.tex.

Такім чынам, мы міленькі дакумент, які змяшчае выява і тэкст, і так як мы хочам зрабіць трохі матэматыкі, у нас ёсць некаторыя дадатковыя пакеты для гэтага.

1\documentclass[a4paper,12pt]{scrreprt} 
2\usepackage{graphicx} 
3\usepackage{ngerman,amsmath,exscale}  
4\usepackage[latin1]{inputenc} 
5\begin{document} 
6Dies ist ein Testtext, der nur ein bisschen helfen soll, Neuankommlingen in de.comp.text.tex das Prinzip des Minmalbeispiels zu erklaren. Und wir fugen jetzt einfach mal ein Bild ein. 
7\includegraphics{bild} Und wir schreiben neben dem    Bild einfach weiter. Leider ist die Oberkante nicht    bundig mit dem folgenden Text, sowas dummes aber    auch. Da sollte man doch glatt ein Minimalbeispiel 
8    basteln und in de.comp.text.tex nachfragen, warum    das so ist. Aber erst nach einer grundlichen 
9    Eigenrecherche. 
10\end{document}

Спачатку праверце праблема звязаная з Ужываныя любы іншы пакет, каб закаментаваць лініі 3 Не змяняе вынік. Паколькі мы не выкарыстоўваем стандартны клас тут, аднаўленне парадку з вельмі рэкамендуецца збор KOMA-Script выхадныя віну гэтага класа. Замена "Scrreprt" з "даклад" не робіць, аднак, паляпшае Матэрыі, мы пакінем гэтую мэту сітуацыі, шчырая мы можам чакаць, адтэрміноўка на кожны клас аб'екта. Зараз прывядзем беспарадак і Пакінутае прыбывае ў мінімальнай праўдзіва.

1\documentclass{report} 
2\usepackage{graphicx} 
3 
4\begin{document} 
5\includegraphics{pic} Testtext 
6\end{document}

But, come to think of it, it is not truly minimal yet, so we replace the graphic. Now, we’re done:

1\documentclass{report} 
2%\usepackage{graphicx} 
3 
4\begin{document} 
5\rule{3cm}{4cm} Testtext 
6\end{document}

4.4 Каменем перапоны, акрамя зыходнага кода

4.4.1 Праблемы з інтэрфейсамі

Многія людзі будуць выкарыстоўваць адзін з фонду абалонак або T E X-падтрымкі рэдактарамі (Emacs, кіл, T E X nicCenter, WinEdt мэта, каб назваць некалькі, з не прэтэндуючы на паўнату нармальнай рэкамендацыі) для рэдагавання файлаў і інтэрфейс іх у L T E X ЯНЫ паслуг (пункты меню, кнопкі, гарачыя клавішы для запуску L A T E X, B IB T E X, і г.д..). Мэта Часам, нават памылковым тэзіс праграмы можа быць у дапамогу, якую яны прапаноўваюць: яны могуць быць няправільна, можа быць, яны Некаторыя знайсці выкананыя файлы, можа быць, яны не месца паведамленні аб памылках пры некаторых абставінах, можа быць, яны абмежаваныя ў сваіх магчымасцях. Можа быць, яны думаюць вашыя артыкул цалі ISO фармату А5 Таму што вас ўставіць пятае дадатак праз \ ўваход {} a5. Калі ўсё ідзе не так, і вы сапраўды думаеце, што яны не павінны мець на ўвазе наступнае:

4.4.2 Праблемы, якія не пойдуць

Часам, L A T E X або пакет блытаецца Некаторыя Аб змесце дапаможных файлаў. Напрыклад, паспрабуйце наступнае:

1\documentclass{article} 
2\begin{document} 
3\makeatletter 
4\immediate\write\@auxout{foo} 
5\end{document}

Вы не павінны разумець, што тут адбываецца Акрамя фактаў, гэта пісьмовая форма "Фу" ў чаргу, каб (пайсці праверыць!). Першы запуск будзе паспяховым, другі спробы не атрымаецца, таму што вы не пускаюць для вываду тэксту на той момант, калі файл для чытання СІ. Калі вы перапыніць латекса (з X), ніякіх новых СІ спароджаных файл і далей працуе не атрымаецца, занадта. Гэта зусім не залежыць, што вы Змяненне TeX файл!

Каб павузіць, дзе гэта адбываецца, вы можаце разлічваць дужкі: калі TeX адкрывае файл, ён ставіць (імя файла на экран, і), калі яна зачыненая іх. У нашым выпадку, мы атрымліваем нешта накшталт

Звярніце ўвагу, што test.aux Адкрыты апошняя радок, а не закрытым, таму ён, хутчэй за ўсё, памылка Там. (Ну, я ўжо казаў вам, што гэта Там.)

Вядома, вы-можаце пайсці шляхам лёгкага выдалення часовых файлаў: мы пералічыў некаторыя распаўсюджаныя пашырэння дапаможных файлаў разам з іх змесціва, дзе бярэцца і для чаго ён патрэбны (так вы ведаеце, як да рэгенерацыі пасля выдалення ет е).

Popular Links
Published (Last edited): May 27 , source: http://www.minimalbeispiel.de/mini-en.html