Changeset 63896


Ignore:
Timestamp:
Jul 11, 2010, 11:15:18 PM (8 years ago)
Author:
Daniel James
Message:

Restore the invalid doc info attributes.

Removing them breaks the release notes, there's still a warning that
they're invalid. Refs #1281

Location:
trunk/tools/quickbook
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/tools/quickbook/detail/actions.cpp

    r63814 r63896  
    16941694        }
    16951695
    1696         if (qbk_version_n < 103)
    1697         {
    1698             if (!actions.doc_purpose_1_1.empty())
    1699             {
    1700                 if (actions.doc_type == "library")
    1701                 {
    1702                     out << "    <" << actions.doc_type << "purpose>\n"
    1703                         << "      ";
    1704                     detail::print_string(actions.doc_purpose_1_1, out.get());
    1705                     out << "    </" << actions.doc_type << "purpose>\n"
    1706                         << "\n"
    1707                     ;
    1708                 }
    1709                 else
    1710                 {
    1711                     invalid_attributes.push_back("purpose");
    1712                 }
    1713             }
    1714         }
    1715         else
    1716         {
    1717             if (!actions.doc_purpose.empty())
    1718             {
    1719                 if (actions.doc_type == "library")
    1720                 {
    1721                     out << "    <" << actions.doc_type << "purpose>\n"
    1722                         << "      " << actions.doc_purpose
    1723                         << "    </" << actions.doc_type << "purpose>\n"
    1724                         << "\n"
    1725                     ;
    1726                 }
    1727                 else
    1728                 {
    1729                     invalid_attributes.push_back("purpose");
    1730                 }
     1696        if (!actions.doc_purpose.empty())
     1697        {
     1698            if (actions.doc_type != "library")
     1699            {
     1700                invalid_attributes.push_back("purpose");
     1701            }
     1702
     1703            if (qbk_version_n < 103)
     1704            {
     1705                out << "    <" << actions.doc_type << "purpose>\n"
     1706                    << "      ";
     1707                detail::print_string(actions.doc_purpose_1_1, out.get());
     1708                out << "    </" << actions.doc_type << "purpose>\n"
     1709                    << "\n"
     1710                ;
     1711            }
     1712            else
     1713            {
     1714                out << "    <" << actions.doc_type << "purpose>\n"
     1715                    << "      " << actions.doc_purpose
     1716                    << "    </" << actions.doc_type << "purpose>\n"
     1717                    << "\n"
     1718                ;
    17311719            }
    17321720        }
     
    17341722        if (!actions.doc_categories.empty())
    17351723        {
    1736             if (actions.doc_type == "library")
    1737             {
    1738                 for(actions::string_list::const_iterator
    1739                     it = actions.doc_categories.begin(),
    1740                     end = actions.doc_categories.end();
    1741                     it != end; ++it)
    1742                 {
    1743                     out << "    <" << actions.doc_type << "category name=\"category:";
    1744                     detail::print_string(*it, out.get());
    1745                     out << "\"></" << actions.doc_type << "category>\n"
    1746                         << "\n"
    1747                     ;
    1748                 }
    1749             }
    1750             else
     1724            if (actions.doc_type != "library")
    17511725            {
    17521726                invalid_attributes.push_back("category");
     1727            }
     1728
     1729            for(actions::string_list::const_iterator
     1730                it = actions.doc_categories.begin(),
     1731                end = actions.doc_categories.end();
     1732                it != end; ++it)
     1733            {
     1734                out << "    <" << actions.doc_type << "category name=\"category:";
     1735                detail::print_string(*it, out.get());
     1736                out << "\"></" << actions.doc_type << "category>\n"
     1737                    << "\n"
     1738                ;
    17531739            }
    17541740        }
     
    17631749                << (invalid_attributes.size() > 1 ?
    17641750                    "Invalid attributes" : "Invalid attribute")
    1765                 << " for '" << actions.doc_type << "': "
     1751                << " for '" << actions.doc_type << " document info': "
    17661752                << boost::algorithm::join(invalid_attributes, ", ")
    17671753                << "\n"
  • trunk/tools/quickbook/doc/quickbook.qbk

    r63809 r63896  
    197197  * Avoid generating empty paragraphs.
    198198  * No longer wraps block templates in paragraphs.
    199   * Doesn't generate invalid doc_info members for docbook document types,
    200     warns if you use any.
     199  * Warns if you use invalid doc_info members for docbook document types.
    201200  * Fixes some other causes of invalid boostbook, although it still
    202201    generates invalid boostbook in places.
     
    801800=version=, =id=, =dirname=, =copyright=, =purpose=, =category=, =authors=,
    802801=license=, =last-revision= and =source-mode= are optional information.
     802
     803=dirname=, =purpose= and =category= are boostbook attributes which are only
     804valid for =library= documents. If you use them for other document types,
     805quickbook will warn about them, but still use them, generating invalid markup,
     806that's just ignored by the style sheets.
    803807
    804808=source-type= is a lowercase string setting the initial __source_mode__. If
  • trunk/tools/quickbook/test/doc-info-1.gold

    r63610 r63896  
    1313    </author>
    1414    </authorgroup>
     15    <articlepurpose>
     16      Inline code test: <code>1 + 2</code>
     17    </articlepurpose>
     18    <articlecategory name="category:tests"></articlecategory> <articlecategory name="category:irrelevance"></articlecategory>
    1519  </articleinfo>
    1620</article>
  • trunk/tools/quickbook/test/quickbook-manual.gold

    r63713 r63896  
    2222      </para>
    2323    </legalnotice>
     24    <articlepurpose>
     25      <emphasis>WikiWiki</emphasis> style documentation tool
     26    </articlepurpose>
    2427  </articleinfo>
    2528  <section id="quickbook.intro">
Note: See TracChangeset for help on using the changeset viewer.