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"
19 #include "LaTeXFeatures.h"
20 #include "OutputParams.h"
21 #include "output_xhtml.h"
22 #include "Paragraph.h"
23 #include "ParagraphParameters.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 Layout const & lay = buffer().params().documentClass().htmlTOCLayout();
79 string const & tocclass = lay.defaultCSSClass();
80 string const tocattr = "class='tochead " + tocclass + "'";
82 // we'll use our own stream, because we are going to defer everything.
83 // that's how we deal with the fact that we're probably inside a standard
84 // paragraph, and we don't want to be.
88 Toc const & toc = buffer().tocBackend().toc("tableofcontents");
92 xs << html::StartTag("div", "class='toc'");
95 Language const * lang = buffer().params().language;
96 static string toctitle = N_("Table of Contents");
97 docstring title = lang
98 ? translateIfPossible(from_ascii(toctitle), lang->code())
99 : translateIfPossible(from_ascii(toctitle));
100 xs << html::StartTag("div", tocattr)
102 << html::EndTag("div");
105 Toc::const_iterator it = toc.begin();
106 Toc::const_iterator const en = toc.end();
108 for (; it != en; ++it) {
109 // First, we need to manage increases and decreases of depth
110 int const depth = it->depth();
112 // Ignore stuff above the tocdepth
113 if (depth > buffer().params().tocdepth)
116 if (depth > lastdepth) {
118 // open as many tags as we need to open to get to this level
119 // this includes the tag for the current level
120 for (int i = lastdepth + 1; i <= depth; ++i) {
122 attr << "class='lyxtoc-" << i << "'";
123 xs << html::StartTag("div", attr.str());
127 else if (depth < lastdepth) {
128 // close as many as we have to close to get back to this level
129 // this includes closing the last tag at this level
130 for (int i = lastdepth; i >= depth; --i)
131 xs << html::EndTag("div");
134 attr << "class='lyxtoc-" << depth << "'";
135 xs << html::StartTag("div", attr.str());
138 // no change of level, so close and open
139 xs << html::EndTag("div");
141 attr << "class='lyxtoc-" << depth << "'";
142 xs << html::StartTag("div", attr.str());
145 // Now output TOC info for this entry
146 Paragraph const & par = it->dit().innerParagraph();
147 // First the label, if there is one
148 docstring const & label = par.params().labelString();
151 // Now the content of the TOC entry, taken from the paragraph itself
152 OutputParams ours = op;
155 par.simpleLyXHTMLOnePar(buffer(), xs, ours, dummy);
157 // Now a link to that paragraph
158 string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
159 xs << html::StartTag("a", parattr);
161 // There ought to be a simple way to customize this.
162 // Maybe if we had an InsetLayout for TOC...
163 xs << XHTMLStream::NextRaw() << ">";
164 xs << html::EndTag("a");
166 for (int i = lastdepth; i > 0; --i)
167 xs << html::EndTag("div");
168 xs << html::EndTag("div");