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 want to look like a chapter, section, or whatever.
79 // so we're going to look for the layout with the minimum toclevel
80 // number > 0, because we don't want Part.
81 // we'll take the first one, just because.
82 // FIXME This could be specified in the layout file.
83 DocumentClass const & dc = buffer().params().documentClass();
84 TextClass::LayoutList::const_iterator lit = dc.begin();
85 TextClass::LayoutList::const_iterator len = dc.end();
87 Layout const * lay = NULL;
88 for (; lit != len; ++lit) {
89 int const level = lit->toclevel;
90 if (level > 0 && (level == Layout::NOT_IN_TOC || level >= minlevel))
96 string const tocclass = lay ? " " + lay->defaultCSSClass(): "";
97 string const tocattr = "class='tochead" + tocclass + "'";
99 // we'll use our own stream, because we are going to defer everything.
100 // that's how we deal with the fact that we're probably inside a standard
101 // paragraph, and we don't want to be.
102 odocstringstream ods;
105 string const & cmdname = getCmdName();
106 if (cmdname == "tableofcontents") {
107 Toc const & toc = buffer().tocBackend().toc("tableofcontents");
111 xs << StartTag("div", "class='toc'");
112 xs << StartTag("div", tocattr)
113 << _("Table of Contents")
115 Toc::const_iterator it = toc.begin();
116 Toc::const_iterator const en = toc.end();
118 for (; it != en; ++it) {
119 Paragraph const & par = it->dit().innerParagraph();
120 int const depth = it->depth();
121 if (depth > buffer().params().tocdepth)
124 if (depth > lastdepth) {
126 // open as many tags as we need to open to get to this level
127 // this includes the tag for the current level
128 for (int i = lastdepth + 1; i <= depth; ++i) {
130 attr << "class='lyxtoc-" << i << "'";
131 xs << StartTag("div", attr.str());
135 else if (depth < lastdepth) {
136 // close as many as we have to close to get back to this level
137 // this includes closing the last tag at this level
138 for (int i = lastdepth; i >= depth; --i)
142 attr << "class='lyxtoc-" << depth << "'";
143 xs << StartTag("div", attr.str());
146 // no change of level, so close and open
149 attr << "class='lyxtoc-" << depth << "'";
150 xs << StartTag("div", attr.str());
152 string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
153 par.simpleLyXHTMLOnePar(buffer(), xs, op, dummy, true);
155 xs << StartTag("a", parattr);
157 // There ought to be a simple way to customize this.
158 xs << XHTMLStream::NextRaw() << "⇘";
161 for (int i = lastdepth; i > 0; --i)