3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
16 #include "BufferParams.h"
17 #include "DispatchResult.h"
18 #include "FuncRequest.h"
19 #include "LaTeXFeatures.h"
20 #include "MetricsInfo.h"
21 #include "OutputParams.h"
22 #include "output_xhtml.h"
23 #include "Paragraph.h"
24 #include "TextClass.h"
25 #include "TocBackend.h"
27 #include "support/debug.h"
28 #include "support/gettext.h"
37 InsetTOC::InsetTOC(Buffer * buf, InsetCommandParams const & p)
38 : InsetCommand(buf, p, "toc")
42 ParamInfo const & InsetTOC::findInfo(string const & /* cmdName */)
44 static ParamInfo param_info_;
45 if (param_info_.empty()) {
46 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
52 docstring InsetTOC::screenLabel() const
54 if (getCmdName() == "tableofcontents")
55 return buffer().B_("Table of Contents");
56 return _("Unknown TOC type");
60 int InsetTOC::plaintext(odocstream & os, OutputParams const &) const
62 os << screenLabel() << "\n\n";
63 buffer().tocBackend().writePlaintextTocList(getCmdName(), os);
64 return PLAINTEXT_NEWLINE;
68 int InsetTOC::docbook(odocstream & os, OutputParams const &) const
70 if (getCmdName() == "tableofcontents")
76 docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const
78 // we'll use our own stream, because we are going to defer everything.
79 // that's how we deal with the fact that we're probably inside a standard
80 // paragraph, and we don't want to be.
84 // This is temporary. We'll get the main TOC working first. The rest will
85 // then be a fairly simple adapation of this code, I hope.
86 if (getCmdName() != "tableofcontents")
88 Toc const & toc = buffer().tocBackend().toc("tableofcontents");
92 xs << StartTag("div", "class='toc'");
94 // we want to look like a chapter, section, or whatever.
95 // so we're going to look for the layout with the minimum toclevel
96 // number > 0, because we don't want Part.
97 // we'll take the first one, just because.
98 DocumentClass const & dc = buffer().params().documentClass();
99 TextClass::LayoutList::const_iterator lit = dc.begin();
100 TextClass::LayoutList::const_iterator len = dc.end();
102 Layout const * lay = NULL;
103 for (; lit != len; ++lit) {
104 int const level = lit->toclevel;
105 if (level > 0 && (level == Layout::NOT_IN_TOC || level >= minlevel))
111 string const tocclass = lay ? " " + lay->defaultCSSClass(): "";
112 string const tocattr = "class='tochead" + tocclass + "'";
114 xs << StartTag("div", tocattr)
115 << _("Table of Contents")
117 Toc::const_iterator it = toc.begin();
118 Toc::const_iterator const en = toc.end();
120 for (; it != en; ++it) {
121 Paragraph const & par = it->dit().innerParagraph();
122 int const depth = it->depth();
123 if (depth > buffer().params().tocdepth)
126 if (depth > lastdepth) {
128 // open as many tags as we need to open to get to this level
129 // this includes the tag for the current level
130 for (int i = lastdepth + 1; i <= depth; ++i) {
132 attr << "class='lyxtoc-" << i << "'";
133 xs << StartTag("div", attr.str());
137 else if (depth < lastdepth) {
138 // close as many as we have to close to get back to this level
139 // this includes closing the last tag at this level
140 for (int i = lastdepth; i >= depth; --i)
144 attr << "class='lyxtoc-" << depth << "'";
145 xs << StartTag("div", attr.str());
148 // no change of level, so close and open
151 attr << "class='lyxtoc-" << depth << "'";
152 xs << StartTag("div", attr.str());
154 string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
155 par.simpleLyXHTMLOnePar(buffer(), xs, op, dummy, true);
157 xs << StartTag("a", parattr);
159 // There ought to be a simple way to customize this.
160 xs << XHTMLStream::NextRaw() << "⇘";
163 for (int i = lastdepth; i > 0; --i)