Skip to content

Commit

Permalink
Fix horizontal overfull
Browse files Browse the repository at this point in the history
Signed-off-by: Kakadu <[email protected]>
  • Loading branch information
Kakadu committed Jan 6, 2023
1 parent 0af9bbc commit 2809a2c
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 31 deletions.
2 changes: 1 addition & 1 deletion 010task.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
% !TEX root = vkr.tex

\label{sec:task}
Дословно ``Целью работы является ... Для её выполнения были поставлены следующие задачи:''
Дословно ``Целью работы является... Для её выполнения были постав\-лены следующие задачи:''
\begin{enumerate}
\item реализовать это;
\item спроектировать это;
Expand Down
7 changes: 4 additions & 3 deletions 020related.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@

По-английски называется related works или previous works.

Если Ваша работа является развитием предыдущей и плохо понимаема без неё, то обзор должен идти в начале. Если же Вы решаете некоторую задачу новым интересным способом, то если поставить обзор в начале, то читатель может устать, пока доберется до вашего решения. В этом случае уместней поставить обзор после описания Вашего подхода к проблеме.
Если Ваша работа является развитием предыдущей и плохо понима\-ема без неё, то обзор должен идти в начале. Если же Вы решаете некоторую задачу новым интересным способом, то если поставить обзор в начале, то читатель может устать, пока доберется до вашего решения. В этом случае уместней поставить обзор после описания Вашего подхода к проблеме.

В обзоре необходимо ссылаться на работы других людей. В данном шаблоне задумано, что литература будет указываться в файле \verb=vkr.bib=. В нём указываются пункты литературы в формате \BibTeX{}, а затем на них можно ссылаться с помощью \verb=\cite{...}=. Та литература, на которую Вы сошлетесь, попадет в список литературы в конце документа. Если не сошлетесь --- не попадёт. Спецификацию в формате \BibTeX{} почти никогда (для второго курса --- никогда), не нужно придумывать руками. Правильно: находить в интернете описание цитируемой статьи\footnote{Например, \url{https://dl.acm.org/doi/10.1145/3408995} (дата доступа: \DTMdate{2022-12-17}).},
копировать цитату с помощью кнопки ``Export Citation'' и вставлять в \BibTeX{} файл. Если так не делать, но оформление литературы будет обрастать багами. Например, \BibTeX{} по особенному обрабатывает точки, запятые и \verb=and= в списке авторов, что позволяет ему самому понимать, сколько авторов у статьи, и что там фамилия, что --- имя, а что --- отчество.
копировать цитату с помощью кнопки ``Export Citation'' и вставлять в \BibTeX{} файл. Если так не делать, но оформление литературы будет обрастать багами.
Например, \BibTeX{} по особенному обрабатывает точ\-ки, запятые и \verb=and= в списке авторов, что позволяет ему самому понимать, сколько авторов у статьи, и что там фамилия, что --- имя, а что --- отчество.

В обзоре и в статье вы наверняка будете использовать названия продуктов или языков программирования. Для них рекомендуется задать специальные команды (сейчас это сделано в файле \verb=header2.tex=), чтобы писать сложные названия правильно и одинаково по всему документу. Написать с ошибкой название любимого языка программирования научника --- идеальный вариант его выбесить.
В обзоре и в остальном тексте вы наверняка будете использовать названия продуктов или языков программирования. Для них рекоменду\-ется (в файле \verb=header2.tex=) за\-дать специальные команды, чтобы писать сложные названия правильно и одинаково по всему доку\-менту. Написать с ошибкой название любимого языка программирова\-ния науч\-ного руко\-водителя --- идеальный вариант его выбесить.

20 changes: 12 additions & 8 deletions 040method.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,43 @@

\emph{Крайне желательно} к Новому году иметь что-то, что сюда можно написать.

Для понимания того как курсовая записка (отзыв по учебной практике/ВКР) должна писаться, можно посмотреть видео ниже. Они про научные доклады и написание научных статей, учебные практики и ВКР отличаются тем, что тут есть требования отдельных глав (слайдов) со списком задач и списком результатов. Но даже если вы забьёте не требования специфичные для ВКР, и соблюдете все рекомендации ниже, получившиеся скорее всего будет лучше чем первая попытка 99\% ваших однокурсников.
Для понимания того как курсовая записка (отзыв по учебной практи\-ке/ВКР) должна писаться, можно посмотреть видео ниже. Они про научные доклады и написание научных статей, учебные практики и ВКР отличаются тем, что тут есть требования отдельных глав (слайдов) со списком задач и списком результатов. Но даже если вы забьёте не требования специфичные для ВКР, и соблюдете все рекомендации ниже, получившиеся скорее всего будет лучше чем первая попытка 99\% ваших однокурсников.

\begin{enumerate}
\item ``Как сделать великолепный научный доклад'' от Саймона Пейтона Джонса~\cite{SPJGreatTalk} (на английском).
\item ``Как написать великолепную научную статью'' от Саймона Пейтона Джонса~\cite{SPJGreatPaper} (на английском).
\item ``Как писать статьи так, чтобы люди их смогли прочитать'' от Дэрэка Драйера~\cite{DreyerYoutube2020} (на английском). По предыдующей ссылке разбираются, что должно быть в статье, т.е. как она должна выглядеть на высоком уровне. Тут более низкоуровнево изложено как должны быть устроены параграфы и т.п.
\item ``Как писать статьи так, чтобы люди их смогли прочитать'' от Дэрэка Драйера~\cite{DreyerYoutube2020} (на английском). По предыдующей ссылке разбираются, что должно быть в статье, т.е. как она должна выгля\-деть на высоком уровне. Тут более низкоуровнево изложено как должны быть устроены параграфы и т.п.
\item Ещё можно посмотреть ``How to Design Talks''~\cite{JhalaYoutube2020} от Ranjit Jhala, но я думаю, что первых трех ссылок всем хватит.
\end{enumerate}


\subsection{Некоторые типичные ошибки}
Здесь мы будем собирать основные ошибки, которые случаются при написании текстов. В интернетах тоже можно найти коллекции типичных косяков\footnote{\href{https://www.read.seas.harvard.edu/~kohler/latex.html}{https://www.read.seas.harvard.edu/~kohler/latex.html} (дата доступа: \DTMdate{2022-12-16}).}.
Здесь мы будем собирать основные ошибки, которые случаются при написании текстов.
В интернетах тоже можно найти коллекции типич\-ных косяков\footnote{\href{https://www.read.seas.harvard.edu/~kohler/latex.html}{https://www.read.seas.harvard.edu/~kohler/latex.html} (дата доступа: \DTMdate{2022-12-16}).}.

Рекомендуется по-умол\-ча\-нию использовать красивые греческие буквы $\sigma$ и $\phi$, а именно $\phi$ вместо $\varphi$. В данном шаблоне команды для этих букв переставлены местами по сравнению с ванильным \TeX'ом.
Рекомендуется по-умол\-ча\-нию использовать красивые греческие бук\-вы $\sigma$ и $\phi$, а именно $\phi$ вместо $\varphi$. В данном шаблоне команды для этих букв переставлены местами по сравнению с ванильным \TeX'ом.

Также, если работа пишется на русском языке, необходимо, чтобы работа была написана на \textit{грамотном} русском языке (даже, если автор, например, казах). Это включает в себя:
Также, если работа пишется на русском языке, необходимо, чтобы работа была написана на \textit{грамотном} русском языке даже, если автор, из ближнего зарубежья\footnote{
Теоретически, возможен вариант написания текстов на английском языке, но это необходимо обсудить в первую очередь с научным руководителем.}.
Это включает в себя:
\begin{itemize}
\item разделы должны оформляться с помощью \verb=\section{...}=, а также \verb=\subsection= и т.~п.; не нужно пытаться нумеровать вручную;
\item точки после окончания предложений;
\item пробелы после запятых и точек, в конце слова перед скобкой;
\item неразрывные пробелы, там, где нужны пробелы, но переносить на другую строку нельзя, например \verb=т.~е.= или \verb=А.~Н.~Терехов=;
\item дефис, там где нужен дефис (обозначается с помощью одиночного ``минуса'' (англ. dash) на клавиатуре);
\item двойной дефис, там где он нужен; а именно при указании промежутка в цифрах: в 1900--1910 г.~г., стр. 150--154;
\item двойной дефис, там где он нужен; а именно при указании проме\-жутка в цифрах: в 1900--1910 г.~г., стр. 150--154;
\item тире (т.~е. \verb=---= --- тройной минус) на месте тире, а не что-то другое.
\item правильные двойные кавычки, а именно они должны начинаться с двойного backtick \verb=``= (кнопка с буквой Ё), а заканчиваться двойной одинарной кавычкой \verb=''= (кнопка с буквой Э);
\item все перечисления должны оформляться с помощью \verb=\enumerate= или \verb=\itemize=; пункты перечислений должны либо начинаться с заглавной буквой и заканчиваться точкой, либо начинаться со строчной и закачиваться точкой с запятой; последний пункт перечислений всегда заканчивается точкой.
\item все перечисления должны оформляться с помощью \verb=\enumerate= или \verb=\itemize=; пункты перечислений должны либо начинаться с заглавной буквой и заканчиваться точкой, либо начинаться со строчной и закачиваться точкой с запятой; последний пункт пере\-числений всегда заканчивается точкой.
\item Перед выкладкой финальной версии необходимо просмотреть лог \LaTeX'a, и обратить внимание на сообщения вида \emph{Overfull \textbackslash hbox (1.29312pt too wide) in paragraph}. Обычно, это означает, что текст выползает за поля, и надо подсказать, как правильно слова на слоги, чтобы перенос произощел автоматически. Это делается, например, так: \verb=соломо\-волокуша=.
\end{itemize}



\subsection{Листинги, картинка и прочий ``не текст''}

Различный ``не текст'' имеет свойство отображаться не там, где он написан в текстовом в \LaTeX{}, поэтому у него должна быть самодостаточная понятная подпись \verb=\caption{...}=, уникальная метка \verb=\label{...}=, чтобы на неё можно было бы ссылаться в тексте с помощью \verb=\ref{...}=. Ниже вы сможете таблицу \ref{time_cmp_obj_func}, на которую мы сослались буквально только что.
Различный ``не текст'' имеет свойство отображаться не там, где он написан в текстовом в \LaTeX{}, поэтому у него должна быть самодостаточ\-ная понятная подпись \verb=\caption{...}=, уникальная метка \verb=\label{...}=, чтобы на неё можно было бы ссылаться в тексте с помощью \verb=\ref{...}=. Ниже вы сможете таблицу \ref{time_cmp_obj_func}, на которую мы сослались буквально только что.


\begin{lstlisting}[caption={Название для листинга кода. Достаточно длинное, чтобы люди, которые смотрят картинку сразу после названия статьи (т.~е. все люди), смогли разобраться и понять к чему в статье листинги, картинки и прочий ``не текст''.}, language=Caml, frame=single]
Expand Down
Loading

0 comments on commit 2809a2c

Please sign in to comment.