xref: /petsc/doc/manualpages/doctext/myst.def (revision 53673ba54f5aaba04b9d49ab22cf56c7a7461fe9)
1*46696af2SBarry Smith#
2*46696af2SBarry Smith# These are the definitions for doc2lt and doctext MyST (Markdown) output
3*46696af2SBarry Smith#
4*46696af2SBarry Smith
5*46696af2SBarry Smith# There are some HTML tags below. These should work with Markdown, but it would
6*46696af2SBarry Smith# be cleaner to use MyST-native syntax where possible.
7*46696af2SBarry Smith
8*46696af2SBarry Smith# Note that the definition lists require the MyST "deflist" extension to be active
9*46696af2SBarry Smith
10*46696af2SBarry Smithkey                %n`%1`
11*46696af2SBarry Smithsynopsis           %n%1
12*46696af2SBarry Smithdefinition         %n**%1**%n
13*46696af2SBarry Smith
14*46696af2SBarry Smith# I want to use
15*46696af2SBarry Smith#section            %n%n#### %1%n
16*46696af2SBarry Smith# but it gives the warning message: WARNING: Non-consecutive header level increase; H1 to H4
17*46696af2SBarry Smith# and uses H2 anyways. So we end up with huge headings that take up too much space on the page.
18*46696af2SBarry Smith# Changing the first # at the top of the page to ## also doesn't help, it ALWAYS starts with H1.
19*46696af2SBarry Smith# Question posted on stackoverflow but likely impossible since # is used to structure the
20*46696af2SBarry Smith# document, not just as size indicator
21*46696af2SBarry Smith
22*46696af2SBarry Smithsection            %n%n## %1%n
23*46696af2SBarry Smiths_synopsis         %n%n## Synopsis%n```%n
24*46696af2SBarry Smithe_synopsis         %n```%n
25*46696af2SBarry Smithem_dash
26*46696af2SBarry Smitheof
27*46696af2SBarry Smithbof
28*46696af2SBarry Smithbop
29*46696af2SBarry Smitheop
30*46696af2SBarry Smith
31*46696af2SBarry Smiths_arg_list         %n%n
32*46696af2SBarry Smiths_arg_inlist       - ***
33*46696af2SBarry Smithe_arg_inlist       -***
34*46696af2SBarry Smiths_defn_inlist      \
35*46696af2SBarry Smithe_defn_inlist      %n
36*46696af2SBarry Smithe_arg_list         %n%n
37*46696af2SBarry Smith
38*46696af2SBarry Smiths_arg              - ***
39*46696af2SBarry Smithe_arg              -***
40*46696af2SBarry Smiths_defn             \
41*46696af2SBarry Smithe_defn             %n
42*46696af2SBarry Smith
43*46696af2SBarry Smiths_doctext_verbatim %n```none%n
44*46696af2SBarry Smithe_doctext_verbatim %n```%n
45*46696af2SBarry Smiths_caption          <CENTER><B>
46*46696af2SBarry Smithe_caption          </B></CENTER>
47*46696af2SBarry Smithpicture            ![%1](%1)
48*46696af2SBarry Smith
49*46696af2SBarry Smithend_par            %n%n
50*46696af2SBarry Smithlocation           **Location:**<A HREF="PETSC_DOC_OUT_ROOT_PLACEHOLDER/%1#%rq0">%1</A>%n
51*46696af2SBarry Smith
52*46696af2SBarry Smithmantitle           # %1%n
53*46696af2SBarry Smithmantitlemany       %n%n# %1%n
54*46696af2SBarry Smithbofmanyend
55*46696af2SBarry Smithanchor             <a name="%1"></a>
56