diff --git a/doc/binary_c2.lyx b/doc/binary_c2.lyx index 503e1309e3dc51eb7771193d9c3c769f02ad4856..3044a721fdcc04f77ae735d18012822b3fe2fa3c 100644 --- a/doc/binary_c2.lyx +++ b/doc/binary_c2.lyx @@ -726,6 +726,61 @@ LICENCE directory tree. \end_layout +\begin_layout Subsection +Websites +\end_layout + +\begin_layout Standard +\begin_inset CommandInset label +LatexCommand label +name "subsec:Website" + +\end_inset + + +\end_layout + +\begin_layout Itemize +The main +\begin_inset Formula $\binaryc$ +\end_inset + + website is at +\begin_inset CommandInset href +LatexCommand href +target "http://personal.ph.surrey.ac.uk/~ri0005/binary_c.html" +literal "false" + +\end_inset + + +\end_layout + +\begin_layout Itemize +\begin_inset Formula $\binaryc$ +\end_inset + +'s +\begin_inset Flex Software +status open + +\begin_layout Plain Layout +git +\end_layout + +\end_inset + + repository is at +\begin_inset CommandInset href +LatexCommand href +target "https://gitlab.eps.surrey.ac.uk/ri0005/binary_c" +literal "false" + +\end_inset + + +\end_layout + \begin_layout Subsection Mailing lists \end_layout diff --git a/doc/binary_c2.pdf b/doc/binary_c2.pdf index a66708efd336d3a24d2133964d415476452e6ded..c849c18d787fde4096b24d33d276a33c77b0d3d9 100644 Binary files a/doc/binary_c2.pdf and b/doc/binary_c2.pdf differ diff --git a/doc/binary_grid2_appendix.lyx b/doc/binary_grid2_appendix.lyx index 834f9dec5a36bea3cb8b3e2e2ab2fe430f61d46f..2e2fc7653e8958e363584756d7a786c8eaf6cf34 100644 --- a/doc/binary_grid2_appendix.lyx +++ b/doc/binary_grid2_appendix.lyx @@ -1,12 +1,12 @@ -#LyX 2.2 created this file. For more info see http://www.lyx.org/ -\lyxformat 508 +#LyX 2.3 created this file. For more info see http://www.lyx.org/ +\lyxformat 544 \begin_document \begin_header \save_transient_properties true \origin unavailable \textclass article \begin_preamble - \usepackage[usenames,dvipsnames]{xcolor} +\usepackage[usenames,dvipsnames]{xcolor} \usepackage{eurosym} \usepackage{eulervm} \usepackage{enumitem} @@ -27,11 +27,11 @@ %\usepackage{gradientframe} %\usepackage[pages=all,color=Sectioncolour,angle=90,hshift=-5cm,scale=1.5,contents={Nucleosynthesis in AGB Stars}]{background} - + %\usepackage{framed} %\colorlet{shadecolor}{gray!25} % you may try 'blue' here %\renewenvironment{leftbar}{% - % \def\FrameCommand{% +% \def\FrameCommand{% %{% %\textcolor{Sectioncolour2}{\vrule width 2pt}% %\textcolor{Sectioncolour1}{\vrule width 2pt}% @@ -74,7 +74,7 @@ keepaspectratio]{images/falk2-low-lolores.eps}% {1em}%sep {}%before code {}%after code - + % redefine subsections to use red colour \titleformat{name=\subsection}% command to alter {\color{Sectioncolour}\normalfont\itshape\bfseries\large\setstretch{0.5}}%format @@ -82,8 +82,8 @@ keepaspectratio]{images/falk2-low-lolores.eps}% {1em}%sep {}%before code {}%after code - - + + \def\aj{AJ} % Astronomical Journal \def\araa{ARA\&A} % Annual Review of Astron and Astrophys \def\apj{ApJ} % Astrophysical Journal @@ -106,7 +106,7 @@ keepaspectratio]{images/falk2-low-lolores.eps}% \usepackage{natbibspacing} \setlength{\bibspacing}{0mm} - + % header \usepackage{fancyhdr} \pagestyle{fancy} @@ -132,6 +132,8 @@ keepaspectratio]{images/falk2-low-lolores.eps}% \font_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 +\use_microtype false +\use_dash_ligatures true \graphics default \default_output_format default \output_sync 0 @@ -161,6 +163,7 @@ keepaspectratio]{images/falk2-low-lolores.eps}% \suppress_date false \justification true \use_refstyle 1 +\use_minted 0 \index Index \shortcut idx \color #008000 @@ -173,7 +176,10 @@ keepaspectratio]{images/falk2-low-lolores.eps}% \tocdepth 3 \paragraph_separation indent \paragraph_indentation default -\quotes_language english +\is_math_indent 0 +\math_numbering_side default +\quotes_style english +\dynamic_quotes 0 \papercolumns 1 \papersides 2 \paperpagestyle fancy @@ -317,7 +323,11 @@ args Not technically an option, but is the string of arguments which is passed to \emph on -binary_c/nucsyn + +\begin_inset Formula $\binaryc$ +\end_inset + + \emph default . Useful for logging or debugging. @@ -483,7 +493,11 @@ libpath \family default Path to libraries to be included in the calling of the \emph on -binary_c/nucsyn + +\begin_inset Formula $\binaryc$ +\end_inset + + \emph default executable. This harks back to the days whens @@ -506,7 +520,11 @@ log_args then the arguments passed to \emph on -binary_c/nucsyn + +\begin_inset Formula $\binaryc$ +\end_inset + + \emph default are saved in a file in \family typewriter @@ -589,7 +607,11 @@ nice \family default A string containing the nice command used to run \shape italic -binary_c/nucsyn + +\begin_inset Formula $\binaryc$ +\end_inset + + \shape default . Usually no nice is used, so this is ' @@ -686,9 +708,13 @@ reference "FAQ:functions and pointers" \family typewriter prog \family default - The + Th \emph on -binary_c/nucsyn +e +\begin_inset Formula $\binaryc$ +\end_inset + + \emph default executable name, usually ' \family typewriter @@ -776,7 +802,11 @@ rootpath \family default The directory in which the \emph on -binary_c/nucsyn + +\begin_inset Formula $\binaryc$ +\end_inset + + \emph default code source and executable reside. See also @@ -1253,7 +1283,11 @@ timeout Set to zero to ignore, usually 30 is enough. This assumes your \emph on - binary_c/nucsyn + +\begin_inset Formula $\binaryc$ +\end_inset + + \emph default process takes less than \family typewriter @@ -1342,7 +1376,10 @@ weight \end_layout \begin_layout Section -Binary_c/nucsyn options ( +\begin_inset Formula $\Binaryc$ +\end_inset + + options ( \emph on bse_options \emph default @@ -1362,9 +1399,9 @@ $binary_grid2_object->{_bse_options} \family default hash. These correspond to options of -\emph on -binary_c -\emph default +\begin_inset Formula $\binaryc$ +\end_inset + . \end_layout @@ -1375,9 +1412,9 @@ binary_c \emph default for the main options list because these options are (mostly) just passed to -\emph on -binary_c -\emph default +\begin_inset Formula $\binaryc$ +\end_inset + . The full list of options is given in \family typewriter @@ -1402,10 +1439,19 @@ binary_c --help \emph on BSE \emph default - refers to + refers to the +\begin_inset Quotes eld +\end_inset + +binary-star evolution +\begin_inset Quotes erd +\end_inset + + model of \begin_inset CommandInset citation LatexCommand citet key "2002MNRAS_329_897H" +literal "true" \end_inset @@ -1422,7 +1468,15 @@ alpha_ce Common envelope ejection efficiency, default 1.0. \end_layout \begin_layout Description -bb CRAP parameter, default 0. +bb CRAP parameter, default 0 (see +\begin_inset CommandInset citation +LatexCommand citealp +key "1988MNRAS.231..823T" +literal "false" + +\end_inset + +). Deprecated in binary_c V2.0, please use CRAP_parameter instead. \end_layout @@ -1436,8 +1490,7 @@ BSE \end_layout \begin_layout Description -Bondi_Hoyle_accretion_factorBondi-Hoyle accretion rate parameter (default - 1.5). +Bondi_Hoyle_accretion_factor accretion rate parameter (default 1.5). \end_layout @@ -1452,7 +1505,10 @@ delta_mcmin Shift in the core mass used to calculate the third dredge up \begin_layout Description eddfac Eddington limit multiplier (default 1e6, i.e. - no Eddington limit). +\begin_inset space ~ +\end_inset + +no Eddington limit). \end_layout \begin_layout Description @@ -1469,7 +1525,10 @@ binary_c \begin_layout Description lambda_ce Common envelope envelope binding energy parameter (default -1, i.e. - set according to fitting functions). +\begin_inset space ~ +\end_inset + +set according to fitting functions). \end_layout \begin_layout Description @@ -1533,6 +1592,7 @@ superwind_mira_switchon Mira period at which the superwind switches on in \begin_inset CommandInset citation LatexCommand citet key "1993ApJ...413..641V" +literal "true" \end_inset @@ -1549,6 +1609,7 @@ tpagbwind TPAGB wind prescription. \begin_inset CommandInset citation LatexCommand citet key "Parameterising_3DUP_Karakas_Lattanzio_Pols" +literal "true" \end_inset @@ -1591,9 +1652,13 @@ z The metallicity (default ). Deprecated in \emph on -binary_c V2.0 + +\begin_inset Formula $\binaryc$ +\end_inset + + \emph default - – please use + V2.0+ – please use \begin_inset Quotes eld \end_inset diff --git a/doc/make_html.pl b/doc/make_html.pl index fef0a832fa63c8a10e4e36afed4be19bcd5590bb..8e29af9188856359219b2f0729bb5965c74c68ae 100755 --- a/doc/make_html.pl +++ b/doc/make_html.pl @@ -190,16 +190,21 @@ while(1) $html =~s !binaryc!binary_c!g; $html =~s !libbinaryc!libbinary_c!g; $html =~s !binaryc_grid!binary_grid!g; + - # make binary_c etc. italic + # make binary_c etc. italic, except when preceded by / + # which means it's likely inside a URL + $html =~s !\/binary_c!___slashbinary_c!g; $html =~s !\bbinary_c\b!<i>binary_c</i>!g; + $html =~s !___slashbinary_c!\/binary_c!g; $html =~s !<title>.*<\/title>!<title>binary_c documentation<\/title>!; + no warnings; $html =~s !\blibbinary_c(.so)?\b!<i>libbinary_c$1</i>!g; use warnings; $html =~s ~\bbinary_grid(2?)(?![\:\;])\b~<i>binary_grid$1</i>~gx; - + # make Perl, C, GNU, FORTRAN italic $html =~s !\s\KFORTRAN\b!<i>FORTRAN</i>!gi; $html =~s !\s\KC\b!<i>C</i>!g; @@ -229,6 +234,10 @@ while(1) $html =~s !\\\s*<i>libbinary_c!libbinary_c!sg; $html =~s !\\\s*<i>binary_grid!binary_grid!sg; + # \b\\binary_c should be considered a mistake + $html =~s !\\([Bb])inaryc!<i>${1}inary_c</i>!g; + $html =~s !\\binarygrid!<I>binary_grid</I>!g; + # convert to </span>\n, to </span>, to avoid spurious spaces $html =~s !<\/span>\n,!<\/span>,!gs;