scientific-skills/hypothesis-generation/assets/FORMATTING_GUIDE.md
This guide provides quick reference for using the hypothesis generation LaTeX template and style package. For complete documentation, see SKILL.md.
% !TEX program = xelatex
\documentclass[11pt,letterpaper]{article}
\usepackage{hypothesis_generation}
\usepackage{natbib}
\title{Your Phenomenon Name}
\begin{document}
\maketitle
% Your content
\end{document}
Compilation: Use XeLaTeX or LuaLaTeX for best results
xelatex your_document.tex
bibtex your_document
xelatex your_document.tex
xelatex your_document.tex
\begin{summarybox}[Executive Summary]
Content here
\end{summarybox}
Use for: High-level overview at the beginning of the document
\begin{hypothesisbox1}[Hypothesis 1: Title]
\textbf{Mechanistic Explanation:}
[2-3 paragraphs explaining HOW and WHY]
\textbf{Key Supporting Evidence:}
\begin{itemize}
\item Evidence point 1 \citep{ref1}
\item Evidence point 2 \citep{ref2}
\end{itemize}
\textbf{Core Assumptions:}
\begin{enumerate}
\item Assumption 1
\item Assumption 2
\end{enumerate}
\end{hypothesisbox1}
Available boxes: hypothesisbox1, hypothesisbox2, hypothesisbox3, hypothesisbox4, hypothesisbox5
Use for: Presenting each competing hypothesis with its mechanism, evidence, and assumptions
Best practices for 4-page main text:
\newpage before each hypothesis box to prevent overflow\begin{predictionbox}[Predictions: Hypothesis 1]
\textbf{Prediction 1.1:} [Specific prediction]
\begin{itemize}
\item \textbf{Conditions:} When/where this applies
\item \textbf{Expected Outcome:} Specific measurable result
\item \textbf{Falsification:} What would disprove it
\end{itemize}
\end{predictionbox}
Use for: Testable predictions derived from each hypothesis
Best practices for 4-page main text:
\begin{evidencebox}[Supporting Evidence]
Content discussing supporting evidence
\end{evidencebox}
Use for: Highlighting key supporting evidence or literature synthesis
Best practices:
\begin{comparisonbox}[H1 vs. H2: Key Distinction]
\textbf{Fundamental Difference:}
[Description of core difference]
\textbf{Discriminating Experiment:}
[Description of experiment]
\textbf{Outcome Interpretation:}
\begin{itemize}
\item \textbf{If [Result A]:} H1 supported
\item \textbf{If [Result B]:} H2 supported
\end{itemize}
\end{comparisonbox}
Use for: Explaining how to distinguish between competing hypotheses
Best practices:
\begin{limitationbox}[Limitations \& Challenges]
Discussion of limitations
\end{limitationbox}
Use for: Highlighting important limitations or challenges
Best practices:
Executive Summary (0.5-1 page)
summaryboxCompeting Hypotheses (2-2.5 pages)
hypothesisbox1, hypothesisbox2, etc.Testable Predictions (0.5-1 page)
predictionbox for each hypothesisCritical Comparisons (0.5-1 page)
comparisonbox for highest priority comparison onlyMain text total: Maximum 4 pages - be extremely selective about what goes here
Appendix A: Comprehensive Literature Review
Appendix B: Detailed Experimental Designs
Appendix C: Quality Assessment
Appendix D: Supplementary Evidence
References
\citep{author2023} for parenthetical citations\citet{author2023} for textual citations\begin{hypotable}{Caption}
\begin{tabular}{|l|l|l|}
\hline
\tableheadercolor
\textcolor{white}{\textbf{Header 1}} & \textcolor{white}{\textbf{Header 2}} \\
\hline
Data row 1 & Data \\
\hline
\tablerowcolor % Alternating gray background
Data row 2 & Data \\
\hline
\end{tabular}
\caption{Your caption}
\end{hypotable}
Best practices:
\tableheadercolor for header rows\tablerowcolor for tables >3 rows% Use \newpage before hypothesis box to prevent overflow
\newpage
\subsection*{Hypothesis N: [Concise Title]}
\begin{hypothesisboxN}[Hypothesis N: [Title]]
\textbf{Mechanistic Explanation:}
[1-2 brief paragraphs of explanation - 6-10 sentences max]
\vspace{0.3cm}
\textbf{Key Supporting Evidence:}
\begin{itemize}
\item [Evidence 1] \citep{ref1}
\item [Evidence 2] \citep{ref2}
\item [Evidence 3] \citep{ref3}
\end{itemize}
\vspace{0.3cm}
\textbf{Core Assumptions:}
\begin{enumerate}
\item [Assumption 1]
\item [Assumption 2]
\end{enumerate}
\end{hypothesisboxN}
\vspace{0.5cm}
Note: The \newpage before the hypothesis box ensures it starts on a fresh page, preventing overflow. This is especially important when boxes contain substantial content.
\subsection*{Predictions from Hypothesis N}
\begin{predictionbox}[Predictions: Hypothesis N]
\textbf{Prediction N.1:} [Statement]
\begin{itemize}
\item \textbf{Conditions:} [Conditions]
\item \textbf{Expected Outcome:} [Outcome]
\item \textbf{Falsification:} [Falsification]
\end{itemize}
\vspace{0.2cm}
\textbf{Prediction N.2:} [Statement]
[... continue ...]
\end{predictionbox}
\subsection*{Distinguishing Hypothesis X vs. Hypothesis Y}
\begin{comparisonbox}[HX vs. HY: Key Distinction]
\textbf{Fundamental Difference:}
[Description of core difference]
\vspace{0.3cm}
\textbf{Discriminating Experiment:}
[Experiment description]
\vspace{0.3cm}
\textbf{Outcome Interpretation:}
\begin{itemize}
\item \textbf{If [Result A]:} HX supported
\item \textbf{If [Result B]:} HY supported
\item \textbf{If [Result C]:} Both/neither supported
\end{itemize}
\end{comparisonbox}
\vspace{0.3cm} - Between elements within boxes\vspace{0.5cm} - Between major sections or boxes\vspace{1cm} - After title, before main contentCRITICAL: Prevent Content Overflow
LaTeX boxes (tcolorbox environments) do not automatically break across pages. Content that exceeds the remaining page space will overflow and cause formatting issues. Follow these guidelines:
\newpage % Start on fresh page if box will be long
\begin{hypothesisbox1}[Hypothesis 1: Title]
% Substantial content here
\end{hypothesisbox1}
Monitor Box Content Length:
When to Use \newpage:
Content Length Guidelines for Main Text:
Breaking Up Long Content:
% GOOD: Concise main text with page break
\newpage
\begin{hypothesisbox1}[Hypothesis 1: Brief Title]
\textbf{Mechanistic Explanation:}
Brief overview in 1-2 paragraphs (6-10 sentences).
\textbf{Key Supporting Evidence:}
\begin{itemize}
\item Evidence 1 \citep{ref1}
\item Evidence 2 \citep{ref2}
\end{itemize}
\textbf{Core Assumptions:}
\begin{enumerate}
\item Assumption 1
\end{enumerate}
See Appendix A for detailed mechanism and comprehensive evidence.
\end{hypothesisbox1}
% BAD: Overly long content that will overflow
\begin{hypothesisbox1}[Hypothesis 1]
\subsection{Very Long Section}
Multiple paragraphs...
\subsection{Another Long Section}
More paragraphs...
\subsection{Even More Content}
[Content continues beyond page boundary → OVERFLOW!]
\end{hypothesisbox1}
Page Break Commands:
\newpage - Force new page (recommended before long boxes)\clearpage - Force new page and flush floats (use before appendices)Already handled by style package, but you can adjust:
\vspace{0.5cm} % Add extra space if needed
Issue: "File hypothesis_generation.sty not found"
Issue: Boxes don't have colors
xelatex yourfile.texIssue: Citations show as [?]
xelatex yourfile.tex
bibtex yourfile
xelatex yourfile.tex
xelatex yourfile.tex
Issue: Fonts not found
\setmainfont{...} and \setsansfont{...}Issue: Box titles overlap with content
\vspace{0.3cm} after titlesIssue: Tables too wide
\small or \footnotesize before tabular, or use p{width} column specsIssue: Content overflowing off the page
\newpage before the box to start it on a fresh page\newpage liberally before boxes with substantial contentIssue: Main text exceeds 4 pages
Ensure these packages are installed:
tcolorbox (with most option)xcolorfontspec (for XeLaTeX/LuaLaTeX)fancyhdrtitlesecenumitembooktabsnatbibInstall missing packages:
# For TeX Live
tlmgr install tcolorbox xcolor fontspec fancyhdr titlesec enumitem booktabs natbib
# For MiKTeX (Windows)
# Use MiKTeX Package Manager GUI
Color Usage
Box Usage
Citation Style
\citep{} for most citations\citep{ref1, ref2, ref3}Hypothesis Numbering
Language
Before finalizing your document:
\newpage) used before long boxes to prevent overflow% !TEX program = xelatex
\documentclass[11pt,letterpaper]{article}
\usepackage{hypothesis_generation}
\usepackage{natbib}
\title{Role of X in Y}
\begin{document}
\maketitle
\section*{Executive Summary}
\begin{summarybox}[Executive Summary]
Brief overview of phenomenon and hypotheses.
\end{summarybox}
\section{Competing Hypotheses}
% Use \newpage before each hypothesis box to prevent overflow
\newpage
\subsection*{Hypothesis 1: Title}
\begin{hypothesisbox1}[Hypothesis 1: Title]
\textbf{Mechanistic Explanation:}
Brief explanation in 1-2 paragraphs.
\textbf{Key Supporting Evidence:}
\begin{itemize}
\item Evidence point \citep{ref1}
\end{itemize}
\end{hypothesisbox1}
\newpage
\subsection*{Hypothesis 2: Title}
\begin{hypothesisbox2}[Hypothesis 2: Title]
\textbf{Mechanistic Explanation:}
Brief explanation in 1-2 paragraphs.
\textbf{Key Supporting Evidence:}
\begin{itemize}
\item Evidence point \citep{ref2}
\end{itemize}
\end{hypothesisbox2}
\section{Testable Predictions}
\subsection*{Predictions from Hypothesis 1}
\begin{predictionbox}[Predictions: Hypothesis 1]
Predictions here.
\end{predictionbox}
\section{Critical Comparisons}
\subsection*{H1 vs. H2}
\begin{comparisonbox}[H1 vs. H2]
Comparison here.
\end{comparisonbox}
% Force new page before appendices
\appendix
\newpage
\appendixsection{Appendix A: Literature Review}
Detailed literature review here.
\newpage
\bibliographystyle{plainnat}
\bibliography{references}
\end{document}
Key Points:
\newpage used before each hypothesis box to ensure they start on fresh pageshypothesis_report_template.tex for complete annotated templateSKILL.md for workflow and methodology guidancereferences/hypothesis_quality_criteria.md for evaluation frameworkreferences/experimental_design_patterns.md for design guidance