/usr/share/help/te/gtk-doc-manual/index.docbook is in gtk-doc-tools 1.27-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 | <?xml version="1.0" encoding="utf-8" standalone="no"?>
<?xml-stylesheet type="text/xml" href="params.xsl"?>
<!-- vim: set ai tw=80 ts=3 sw=3: -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "
http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY FDL SYSTEM "fdl-appendix.xml">
<!ENTITY FDLlink "<link linkend='fdl'>included</link>">
]>
<!-- =============Document Header ============================= -->
<book id="index" lang="te">
<bookinfo>
<title>GTK-Doc మాన్యుయల్</title>
<edition>1.24.1</edition>
<abstract role="description"><para>GTK-Doc వినియోగపు సూచనలతో అభివృద్దికారుల కొరకు వినియోగదారి మాన్యుయల్.</para></abstract>
<authorgroup>
<author>
<firstname>Chris</firstname>
<surname>Lyttle</surname>
<affiliation>
<address>
<email>chris@wilddev.net</email>
</address>
</affiliation>
</author>
<author>
<firstname>Dan</firstname>
<surname>Mueth</surname>
<affiliation>
<address>
<email>d-mueth@uchicago.edu</email>
</address>
</affiliation>
</author>
<author>
<firstname>Stefan</firstname>
<surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
</address>
</affiliation>
</author>
</authorgroup>
<publisher role="maintainer">
<publishername>GTK-Doc project</publishername>
<address><email>gtk-doc-list@gnome.org</email></address>
</publisher>
<copyright>
<year>2000, 2005</year>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
<year>2007-2015</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<!-- translators: uncomment this:
<copyright>
<year>2000</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
<legalnotice>
<para>ఎటువంటి ఫ్రంట్-కవర్ పాఠ్యములు, మరియు బ్యాక్-కవర్ పాఠ్యములు లేకుండా, ఫ్రీ సాఫ్టువేరు ఫౌండేషన్ ద్వారా ప్రచురితమైన వర్షన్ 1.1 లేదా దాని తర్వాత వర్షన్ <citetitle>GNU Free Documentation License</citetitle> నియమాలకు లోబడి ఈ పత్రమును నకలు తీయుటకు, పంపిణీ చేయుటకు మరియు/లేదా సవరించుటకు అనుమతి యివ్వబడింది. లైసెన్సు యొక్క నకలు <link linkend="fdl">చేర్చబడింది</link>.న్ ద్వారా ప్రచురితమై,</para>
<para>కంపెనీలు వాటి వుత్పత్తులను మరియు సేవలను వర్గీకరించుటకు వుపయోగించు చాలా వరకు నామములు ట్రేడ్మార్కులుగా హక్కు కలిగివుంటాయి. అవి GNOME పత్రికీకరణనందు కనిపించునప్పుడు, మరియు GNOME Documentation Project సభ్యలు ఆ ట్రేడ్మార్కులను గుర్తించుటకు, ఆనామములు పెద్ద అక్షరములలో లేదా మొదటి అక్షరం పెద్ద అక్షరంగా ముద్రించబడతాయి.</para>
</legalnotice>
<revhistory>
<revision>
<revnumber>1.27</revnumber>
<date>07 Dec 2017</date>
<authorinitials>ss</authorinitials>
<revremark>fine tuning of the python port</revremark>
</revision>
<revision>
<revnumber>1.26</revnumber>
<date>11 Aug 2017</date>
<authorinitials>ss</authorinitials>
<revremark>port all tools from perl/bash to python</revremark>
</revision>
<revision>
<revnumber>1.25</revnumber>
<date>21 March 2016</date>
<authorinitials>ss</authorinitials>
<revremark>bug fixes, test cleanups</revremark>
</revision>
<revision>
<revnumber>1.24</revnumber>
<date>29 May 2015</date>
<authorinitials>ss</authorinitials>
<revremark>bug fix</revremark>
</revision>
<revision>
<revnumber>1.23</revnumber>
<date>17 May 2015</date>
<authorinitials>ss</authorinitials>
<revremark>bug fix</revremark>
</revision>
<revision>
<revnumber>1.22</revnumber>
<date>07 May 2015</date>
<authorinitials>ss</authorinitials>
<revremark>bug fixes, dropping deprecated features</revremark>
</revision>
<revision>
<revnumber>1.21</revnumber>
<date>17 Jul 2014</date>
<authorinitials>ss</authorinitials>
<revremark>bug fixes, dropping deprecated features</revremark>
</revision>
<revision>
<revnumber>1.20</revnumber>
<date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>bug fixes, markdown support, style improvements</revremark>
</revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<authorinitials>ss</authorinitials>
<revremark>bug fixes</revremark>
</revision>
<revision>
<revnumber>1.18</revnumber>
<date>14 Sep 2011</date>
<authorinitials>ss</authorinitials>
<revremark>bug fixes, speedups, markdown support</revremark>
</revision>
<revision>
<revnumber>1.17</revnumber>
<date>26 Feb 2011</date>
<authorinitials>sk</authorinitials>
<revremark>urgent bug fix update</revremark>
</revision>
<revision>
<revnumber>1.16</revnumber>
<date>14 Jan 2011</date>
<authorinitials>sk</authorinitials>
<revremark>bugfixes, layout improvements</revremark>
</revision>
<revision>
<revnumber>1.15</revnumber>
<date>21 May 2010</date>
<authorinitials>sk</authorinitials>
<revremark>bug and regression fixes</revremark>
</revision>
<revision>
<revnumber>1.14</revnumber>
<date>28 March 2010</date>
<authorinitials>sk</authorinitials>
<revremark>bugfixes and performance improvements</revremark>
</revision>
<revision>
<revnumber>1.13</revnumber>
<date>18 December 2009</date>
<authorinitials>sk</authorinitials>
<revremark>broken tarball update</revremark>
</revision>
<revision>
<revnumber>1.12</revnumber>
<date>18 December 2009</date>
<authorinitials>sk</authorinitials>
<revremark>new tool features and bugfixes</revremark>
</revision>
<revision>
<revnumber>1.11</revnumber>
<date>16 November 2008</date>
<authorinitials>mal</authorinitials>
<revremark>GNOME doc-utils migration</revremark>
</revision>
</revhistory>
</bookinfo>
<!-- ======== Chapter 1: Introduction ======================== -->
<chapter id="introduction">
<title>పరిచయం</title>
<para>ఈ అధ్యాయము GTK-Docను పరిచయం చేస్తుంది మరియు అది యేమిచేస్తుంది దానిని యెలా వుపయోగించాలి అనేదానిపై సంక్షిప్తంగా వివరిస్తుంది.</para>
<sect1 id="whatisgtkdoc">
<title>GTK-Doc అంటే యేమిటి?</title>
<para>GTK-Doc అనునది C కోడ్ను పత్రికీకరణ చేయుటకు వుపయోగించబడింది. ఇది ముఖ్యంగా GTK+ మరియు GNOME వంటి లైబ్రరీల పబ్లిక్ API పత్రికీకరణకు వుపయోగించబడింది. అయితే యిది అనువర్తనము కోడ్ను పత్రికీకరణ చేయుటకు కూడా వుపయోగించవచ్చును.</para>
</sect1>
<sect1 id="howdoesgtkdocwork">
<title>GTK-Doc యెలా పనిచేయును?</title>
<para>GTK-Doc అనునది మూలపు(సోర్స్) ఫైళ్ళ యొక్క ఫంక్షన్స్ నందు ప్రత్యేకించి-రూపొందించిన కామెంట్ బ్లాక్స్ నందలి పత్రికీకరణను వుపయోగించి పనిచేయును, లేదా GTK-Doc వుపయోగించే మాదిరి(టెంప్లేట్) ఫైళ్ళకు జతచేసిన పత్రికీకరణను వుపయోగించును (GTK-Doc హెడర్ ఫైళ్ళ నందు డిక్లేర్ చేసివున్న ఫంక్షన్లకు మాత్రమే పత్రికీకరణ యిచ్చును; అది స్టాటిక్ ఫంక్షన్ల కొరకు అవుట్పుట్ అందించదు).</para>
<para>
GTK-Doc consists of a number of python scripts, each performing a different step
in the process.
</para>
<para>అక్కడ కార్యక్రమమునందు 5 ముఖ్య స్టెప్పులు వున్నవి:</para>
<orderedlist>
<listitem>
<para><guilabel>పత్రికీకరణను వ్రాయుట.</guilabel> మూలకర్త(ఆథర్) సోర్స్ ఫైళ్ళనందు ప్రతి ఫంక్షన్కు, మాక్రోకు, యూనియన్కు పత్రకీకరణను యిస్తాడు. (గతంలో సమాచారమును మాదిరి ఫైళ్ళనందు ప్రవేశపెట్టేవారు, యిది యిప్పడు సమర్ధించబడదు).</para>
</listitem>
<listitem>
<para>
<guilabel>Gathering information about the code.</guilabel>
<application>gtkdoc-scan</application> scans the header files of the
code looking for declarations of functions, macros, enums, structs, and unions.
It creates the file <filename><module>-decl-list.txt</filename> containing a list of the
declarations, placing them into sections according to which header file they
are in. On the first run this file is copied to <filename><module>-sections.txt</filename>.
The author can rearrange the sections, and the order of the
declarations within them, to produce the final desired order.
The second file it generates is <filename><module>-decl.txt</filename>.
This file contains the full declarations found by the scanner. If for
some reason one would like some symbols to show up in the docs, where
the full declaration cannot be found by the scanner or the declaration
should appear differently, one can place entities similar to the ones in
<filename><module>-decl.txt</filename> into <filename><module>-overrides.txt</filename>.
</para>
<para>
<application>gtkdoc-scangobj</application> can also be used to dynamically query a library about
any GObject subclasses it exports. It saves information about each
object's position in the class hierarchy and about any GObject properties
and signals it provides.
</para>
<para>
<application>gtkdoc-scanobj</application> should not be used anymore.
It was needed in the past when GObject was still GtkObject inside gtk+.
</para>
</listitem>
<listitem>
<para>
<guilabel>Generating the XML and HTML/PDF.</guilabel>
<application>gtkdoc-mkdb</application> turns the template files into
XML files in the <filename class="directory">xml/</filename> subdirectory.
If the source code contains documentation on functions, using the
special comment blocks, it gets merged in here. If there are no tmpl files used
it only reads docs from sources and introspection data.
</para>
<para>
<application>gtkdoc-mkhtml</application> turns the XML files into HTML
files in the <filename class="directory">html/</filename> subdirectory.
Likewise <application>gtkdoc-mkpdf</application> turns the XML files into a PDF
document called <filename><package>.pdf</filename>.
</para>
<para>
Files in <filename class="directory">xml/</filename> and
<filename class="directory">html/</filename> directories are always
overwritten. One should never edit them directly.
</para>
</listitem>
<listitem>
<para><guilabel>పత్రముల మధ్య క్రాస్-రిఫరెన్సెస్ను పరిష్కరించుచున్నది.</guilabel> HTML ఫైళ్ళను సంస్థాపించిన తర్వాత, వేరు వేరు పత్రముల మధ్య క్రాస్-రిఫరెన్సెస్ను అమర్చుటకు <application>gtkdoc-fixxref</application> నడుపవచ్చును. ఉదాహరణకు, GTK+ పత్రికీకరణ అనునది GLib మాన్యుయల్ నందు వుంచిన పత్రికీకరణకు చాలా క్రాస్-రిఫరెన్సెస్ కలిగివుంది. పంపిణీ కొరకు మూలపు టార్బాల్ను సృష్టించునప్పుడు, <application>gtkdoc-rebase</application> అనునది అన్ని బహిర్గత లింకులను వెబ్-లింకులకు మార్చును. పంపిణీచేసిన (ముందుగాజనియింపచేసిన) పత్రములను సంస్థాపించునప్పుడు అదే అనువర్తనము లింకులను స్థానిక లింకులకు (ఆ పత్రములు యెక్కడ సంస్థాపించబడినవో అక్కడికి) తిరిగివుంచుటకు ప్రయత్నించును.</para>
</listitem>
</orderedlist>
</sect1>
<sect1 id="gettinggtkdoc">
<title>GTK-Doc పొందుట</title>
<sect2 id="requirements">
<title>అవసరములు</title>
<para>
<guilabel>python 2/3</guilabel> - the main scripts are written in python.
</para>
<para>
<guilabel>xsltproc</guilabel> - the xslt processor from libxslt
<ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
</para>
<para>
<guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
<ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
</para>
<para>
One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
<guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
</sect2>
</sect1>
<sect1 id="aboutgtkdoc">
<title>GTK-Doc గురించి</title>
<para>(FIXME)</para>
<para>
(History, authors, web pages, mailing list, license, future plans,
comparison with other similar systems.)
</para>
</sect1>
<sect1 id="aboutthismanual">
<title>ఈ మాన్యుయల్ గురించి</title>
<para>(FIXME)</para>
<para>(ఇది యెవరి కొరకు, మీరు దీనిని యెచటనుండి పొందగలరు, లైసెన్స్)</para>
</sect1>
</chapter>
<chapter id="settingup">
<title>మీ ప్రోజెక్టును అమర్చుట</title>
<para>
The next sections describe what steps to perform to integrate GTK-Doc into
your project. Theses sections assume we work on a project called 'meep'.
This project contains a library called 'libmeep' and
an end-user app called 'meeper'. We also assume you will be using autoconf
and automake. In addition section <link linkend="plain_makefiles">plain
makefiles or other build systems</link> will describe the basics needed to
work in a different build setup.
</para>
<sect1 id="settingup_docfiles">
<title>స్కెల్టెన్ పత్రికీకరణను అమర్చుచున్నది</title>
<para>మీ పై-స్థాయి ప్రోజెక్టు డైరెక్టరీ క్రింద docs/reference అను ఫోల్డర్లను సృష్టించుము (ఈ విధంగా మీరు docs/helpను అంత్య-వినియోగదారి పత్రికీకరణ కొరకు కలిగివుండవచ్చును). doc-package నామముతో వేరొక వుపసంచయంను సృష్టించుకొనుట సిఫార్సు చేయబడింది. కేవలం వొక లైబ్రరీ మాత్రమే వున్న ప్యాకేజీలకు యిది అవసరములేదు.</para>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
<programlisting><![CDATA[
meep/
docs/
reference/
libmeep/
meeper/
src/
libmeep/
meeper/
]]></programlisting>
</example>
</para>
</sect1>
<sect1 id="settingup_autoconf">
<title>autoconf తో విలీనం</title>
<para>చాలా సులువు! మీ <filename>configure.ac</filename> స్క్రిప్టునకు వొక లైను మాత్రమే జతచేయుము.</para>
<para>
<example><title>autoconf తో విలీనం</title>
<programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
]]></programlisting>
</example>
</para>
<para>
This will require all developers to have gtk-doc installed. If it is
okay for your project to have optional api-doc build setup, you can
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
<programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
]]></programlisting>
</example>
</para>
<para>ఆకృతీకరణ సమయము వద్ద gtkdocversion కొరకు పరిశీలించుటకు మొదటి ఆర్గుమెంటు వుపయోగించబడింది. 2వది, <application>gtkdocize</application> చేత వుపయోగించబడిన ఐచ్చిక ఆర్గుమెంట్. <symbol>GTK_DOC_CHECK</symbol> మాక్రో చాలా ఆకృతీకరణ స్విచ్లను జతచేస్తుంది:</para>
<orderedlist>
<listitem><para>--with-html-dir=PATH : సంస్థాపించిన పత్రములకు పాత్</para></listitem>
<listitem><para>--enable-gtk-doc : పత్రికీకరణను నిర్మించుటకు gtk-doc వుపయోగించుము [default=no]</para></listitem>
<listitem><para>--enable-gtk-doc-html : పత్రికీకరణను html ఫార్మాట్నందు నిర్మించుము [default=yes]</para></listitem>
<listitem><para>--enable-gtk-doc-pdf : పత్రికీకరణను pdf ఫార్మాట్ నందు నిర్మించుము [default=no]</para></listitem>
</orderedlist>
<important>
<para>GTK-Doc అప్రమేయంగా అచేతనము చేయబడింది! ఐచ్చికము <option>'--enable-gtk-doc'</option>ను తరువాతి <filename>configure</filename>కు నడుపుట మర్చిపోవద్దు. లేకపోతే ముందుగా జనియింపచేసిన పత్రికీకరణ సంస్థాపించబడుతుంది (ఇది వినియోగదారులకు వుపయోగకరం అయితే అభివృద్దికారులకు కాదు).</para>
</important>
<para>
Furthermore it is recommended that you have the following line inside
your <filename>configure.ac</filename> script.
This allows <application>gtkdocize</application> to automatically copy the
macro definition for <function>GTK_DOC_CHECK</function> to your project.
</para>
<para>
<example><title>gtkdocize కొరకు సన్నాహం</title>
<programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
]]></programlisting>
</example>
</para>
<para>
After all changes to <filename>configure.ac</filename> are made, update
the <filename>configure</filename> file. This can be done by re-running
<code>autoreconf -i</code> or <code>autogen.sh</code>.
</para>
</sect1>
<sect1 id="settingup_automake">
<title>automake తో విలీనం</title>
<para>
First copy the <filename>Makefile.am</filename> from the
<filename class="directory">examples</filename> sub directory of the
<ulink url="https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am">gtkdoc-sources</ulink>
to your project's API documentation directory (
<filename class="directory">./docs/reference/<package></filename>).
A local copy should be available under e.g.
<filename>/usr/share/doc/gtk-doc-tools/examples/Makefile.am</filename>.
If you have multiple doc-packages repeat this for each one.
</para>
<para>
The next step is to edit the settings inside the <filename>Makefile.am</filename>.
All the settings have a comment above that describes their purpose.
Most settings are extra flags passed to the respective tools. Every tool
has a variable of the form <option><TOOLNAME>_OPTIONS</option>.
All the tools support <option>--help</option> to list the supported
parameters.
</para>
<!-- FIXME: explain options ? -->
</sect1>
<sect1 id="settingup_autogen">
<title>autogen తో విలీనం</title>
<para>వర్షన్ కంట్రోల్ సిస్టమ్ (cvs/svn/git వంటి) నుండి చెక్అవుట్ తర్వాత బుల్డ్ నిర్మాణం అమర్చుటకు చాలా ప్రోజెక్టులు <filename>autogen.sh</filename> స్క్రిప్టును కలిగివుంటాయి. GTK-Doc అనునది <application>gtkdocize</application> అనబడు సాధనంతో వస్తుంది దీనిని అటువంటి స్క్రిప్టు నందు వుపయోగించవచ్చును. ఇది autoheader, automake లేదా autoconf ముందు నడుపవలెను.</para>
<para>
<example><title>autogen.sh నుండి gtkdocize నడుపుతోంది</title>
<programlisting><![CDATA[
gtkdocize || exit 1
]]></programlisting>
</example>
</para>
<para>
When running <application>gtkdocize</application> it copies
<filename>gtk-doc.make</filename> to your project root (or any directory
specified by the <option>--docdir</option> option).
It also checks you configure script for the <function>GTK_DOC_CHECK</function>
invocation. This macro can be used to pass extra parameters to
<application>gtkdocize</application>.
</para>
<para>
Historically GTK-Doc was generating template files where developers entered the docs.
This turned out to be not so good (e.g. the need for having generated
files under version control).
Since GTK-Doc 1.9 the tools can get all the information from source comments
and thus the templates can be avoided. We encourage people to keep
documentation in the code. <application>gtkdocize</application> supports now
a <option>--flavour no-tmpl</option> option that chooses a makefile that skips
tmpl usage totally. Besides adding the option directly to the command
invocation, they can be added also to an environment variable called <symbol>GTKDOCIZE_FLAGS</symbol>
or set as a 2nd parameter in <symbol>GTK_DOC_CHECK</symbol> macro in the configure script.
If you have never changed file in tmpl by hand and migrating from older gtkdoc versions,
please remove the directory (e.g. from version control system).
</para>
</sect1>
<sect1 id="settingup_firstrun">
<title>doc బుల్డును నడుపుట</title>
<para>గతంలో జరిపిన స్టెప్పుల తర్వాత యిప్పుడు బుల్డును నడుపవలెను. ముందుగా మనము <filename>autogen.sh</filename>ను తిరిగి నడుపవలెను. ఈ స్క్రిప్టు మీ కొరకు ఆకృతీకరణను నడిపితే, దానికి <option>--enable-gtk-doc</option> ఐచ్చికాన్ని యివ్వుము. లేదా తరువాత ఈ ఐచ్చికముతో మానవీయంగా <filename>configure</filename>ను నడుపుము.</para>
<para>
The first make run generates several additional files in the doc-directories.
The important ones are:
<filename><package>.types</filename>,
<filename><package>-docs.xml</filename> (in the past .sgml),
<filename><package>-sections.txt</filename>.
</para>
<para>
<example><title>doc బుల్డును నడుపుట</title>
<programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
]]></programlisting>
</example>
</para>
<para>ఇప్పుడు మీ బ్రౌజర్కు మీరు <filename>docs/reference/<package>/index.html</filename>ను సూచించవచ్చును. అవును, యిప్పటికి యిది కొంత నిరుత్సాహపరుస్తోంది. అయితే ఆగండి, తరువాతి అధ్యాయమునందు పేజీలను యెలా నింపాలో చెబుతాము.</para>
</sect1>
<sect1 id="settingup_vcs">
<title>వర్షన్ కంట్రోల్ సిస్టమ్తో విలీనం</title>
<para>
As a rule of thumb, it's the files you edit which should go under
version control. For typical projects it's these files:
<filename><package>.types</filename>,
<filename><package>-docs.xml</filename> (in the past .sgml),
<filename><package>-sections.txt</filename>,
<filename>Makefile.am</filename>.
</para>
<para>
Files in the <filename>xml/</filename> and <filename>html/</filename>
directories should not go under version control. Neither should any of
the <filename>.stamp</filename> files.
</para>
</sect1>
<sect1 id="plain_makefiles">
<title>Integration with plain makefiles or other build systems</title>
<para>
In the case one does not want to use automake and therefore
<filename>gtk-doc.mak</filename> one will need to call the gtkdoc tools
in the right order in own makefiles (or other build tools).
</para>
<para>
<example><title>Documentation build steps</title>
<programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) <source-dir>
gtkdoc-scangobj --module=$(DOC_MODULE)
gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=<source-dir>
// xml files have changed
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
]]></programlisting>
</example>
</para>
<para>
One will need to look at the <filename>Makefile.am</filename> and
<filename>gtk-doc.mak</filename> to pick the extra options needed.
</para>
</sect1>
<sect1 id="cmake">
<title>Integration with CMake build systems</title>
<para>
GTK-Doc now provides a <filename>GtkDocConfig.cmake</filename> module
(and the corresponding <filename>GtkDocConfigVersion.cmake</filename>
module). This provides a <literal>gtk_doc_add_module</literal>
command that you can set in your <filename>CMakeLists.txt</filename>
file.
</para>
<para>
The following example shows how to use this command.
<example><title>Example of using GTK-Doc from CMake</title>
<programlisting><![CDATA[
find_package(GtkDoc 1.25 REQUIRED)
# Create the doc-libmeep target.
gtk_doc_add_module(
libmeep ${CMAKE_SOURCE_DIR}/libmeep
XML meep-docs.xml
LIBRARIES libmeep
)
# Build doc-libmeep as part of the default target. Without this, you would
# have to explicitly run something like `make doc-libmeep` to build the docs.
add_custom_target(documentation ALL DEPENDS doc-libmeep)
# Install the docs. (This assumes you're using the GNUInstallDirs CMake module
# to set the CMAKE_INSTALL_DOCDIR variable correctly).
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html
DESTINATION ${CMAKE_INSTALL_DOCDIR})
]]></programlisting>
</example>
</para>
</sect1>
</chapter>
<chapter id="documenting">
<title>కోడ్ను పత్రికీకరణ చేయుట</title>
<para>
GTK-Doc uses source code comment with a special syntax for code documentation.
Further it retrieves information about your project structure from other
sources. During the next section you will find all information about the
syntax of the comments.
</para>
<note>
<title>పత్రికీకరణ స్థానము</title>
<para>గతంలో చాలా వరకు పత్రికీకరణ అనునది <filename>tmpl</filename> డైరెక్టరీ క్రిందని ఫైళ్ళలో నింపవలసివుండేది. సమాచారము సరిగా నవీకరించబడక పోవుట మరియు ఆ ఫైలు వర్షన్ కంట్రోల్ సిస్టమ్సుతో విభేదించుట వంటి లోపాలను యిది కలిగివుంది.</para>
<para>ముందుగా తెలిపిన సమస్యలను తప్పించుటకు మేము పత్రికీకరణను మూలముల లోపలే వుంచమని సూచించుచున్నాము. ఈ మాన్యుయల్ ఈ విధంగా కోడ్ పత్రికీకరణను మాత్రమే వివరించును.</para>
</note>
<para>
The scanner can handle the majority of C headers fine. In the case of
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
<programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
]]></programlisting>
</example>
</para>
<note>
<title>Limitations</title>
<para>
Note, that GTK-Doc's supports
<code>#ifndef(__GTK_DOC_IGNORE__)</code> but not
<code>#if !defined(__GTK_DOC_IGNORE__)</code> or other combinations.
</para>
</note>
<!-- -->
<sect1 id="documenting_syntax">
<title>పత్రికీకరణ వ్యాఖ్యలు</title>
<para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
<programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
]]></programlisting>
</example>
</para>
<para>'identifier' అనునది వ్యాఖ్యకు సంభందించిన అంశము యొక్క నామముతో వుండు వొక వరుస. అంశము పై ఆధారపడి సిన్టాక్సు అనునది కొద్దిగా విభేదించును. (చేయవలసినది identifies చూపు పట్టికను జతచేయి)</para>
<para>
The 'documentation' block is also different for each symbol type. Symbol
types that get parameters such as functions or macros have the parameter
description first followed by a blank line (just a '*').
Afterwards follows the detailed description. All lines (outside program
listings and CDATA sections) just containing a ' *' (blank-asterisk) are
converted to paragraph breaks.
If you don't want a paragraph break, change that into ' * '
(blank-asterisk-blank-blank). This is useful in preformatted text (code
listings).
</para>
<tip>
<para>
When documenting code, describe two aspects:
<itemizedlist>
<listitem>
<para>
What it is: The name for a class or function can sometimes
be misleading for people coming from a different background.
</para>
</listitem>
<listitem>
<para>
What it does: Tell about common uses. Put it in relation
with the other API.
</para>
</listitem>
</itemizedlist>
</para>
</tip>
<para>
One advantage of hyper-text over plain-text is the ability to have links
in the document. Writing the correct markup for a link can be tedious
though. GTK-Doc comes to help by providing several useful abbreviations.
<itemizedlist>
<listitem>
<para>
Use function() to refer to functions or macros which take arguments.
</para>
</listitem>
<listitem>
<para>
Use @param to refer to parameters. Also use this when referring to
parameters of other functions, related to the one being described.
</para>
</listitem>
<listitem>
<para>
Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS.
</para>
</listitem>
<listitem>
<para>
Use #symbol to refer to other types of symbol, e.g. structs and
enums and macros which don't take arguments.
</para>
</listitem>
<listitem>
<para>
Use #Object::signal to refer to a GObject signal.
</para>
</listitem>
<listitem>
<para>
Use #Object:property to refer to a GObject property.
</para>
</listitem>
<listitem>
<para>
Use #Struct.field to refer to a field inside a structure and
#GObjectClass.foo_bar() to refer to a vmethod.
</para>
</listitem>
</itemizedlist>
</para>
<tip>
<para>మీరు ప్రత్యేక ఆక్షరములు '<', '>', '()', '@', '%', or '#'ను మీ పత్రికీకరణనందు GTK-Doc వాటిని మార్చకుండా వుపయోగించాలి అంటే మీరు XML మూలకములు "&lt;", "&gt;", "&lpar;", "&rpar;", "&commat;", "&percnt;" మరియు "&num;" వుపయోగించవచ్చు లేదా వాటిని '\' బాక్స్లాష్తో ఎస్కేప్ చేయుము.</para>
</tip>
<para>
DocBook can do more than just links. One can also have lists,
examples, headings, and images. As of version 1.20, the
preferred way is to use a subset of the basic text formatting
syntax called
<ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>.
On older GTK-Doc versions any documentation that includes
Markdown will be rendered as is. For example, list items will
appear as lines starting with a dash.
</para>
<para>
While markdown is now preferred one can mix both. One limitation here is
that one can use docbook xml within markdown, but markdown within
docbook xml is not supported.
</para>
<para>
In older GTK-Doc releases, if you need support for additional
formatting, you would need to enable the usage of docbook
XML tags inside doc-comments by putting <option>--xml-mode</option>
(or <option>--sgml-mode</option>) in the variable
<symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</filename>.
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
<programlisting><
*
* 
*
* [A link to the heading anchor above][heading-two]
*
* A C-language example:
* |[<!-- language="C" -->
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
]]></programlisting>
</example>
</para>
<para>
More examples of what markdown tags are supported can be found in the
<ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">GTK+ Documentation Markdown Syntax Reference</ulink>.
</para>
<tip>
<para>ముందుగా చెప్పినట్లుగా GTK-Doc అనునది పబ్లిక్ API పత్రికీకరణ కొరకు. స్థిర చిహ్నములకు వొక్కరే పత్రికీకరణ వ్రాయలేరు. ఆ చిహ్నములను కూడా వ్యాఖ్యానించుట మంచిది. ఇది యితరులు కూడా మీ కోడ్ను అర్ధము చేసుకొనుటకు సహాయపడును. అందుకని వీటిని సాదారణ వ్యాఖ్యలు (మొదటి వరుసనందు 2వ '*' లేకుండా) వుపయోగించి వ్యాఖ్యానించమని సూచించడమైంది. తరువాత ఆ ఫంక్షన్ పబ్లిక్గా మార్చవలసివుంటే, చేయవలసినదల్లా వేరొక '*'ను వ్యాఖ్య బ్లాక్ నందు చేర్చి మరియు చిహ్నపు నామాన్నివిభగాముల ఫైలునందు సరైన స్థానములో వుంచడమే.</para>
</tip>
</sect1>
<sect1 id="documenting_sections">
<title>పత్రికీకరణ విభాగములు</title>
<para>పత్రికీకరణ యొక్క ప్రతి విభాగము వొక క్లాస్ లేదా మాడ్యూల్ గురించిన సమాచారమును కలిగివుంటుంది. మూలకాన్ని పరిచయం చేయుటకు వొకరు విభాగపు బ్లాక్ను వ్రాయవచ్చును. పొట్టి వివరణ అనునది పట్టిక యొక్క సారముల లోపలకూడా వుపయోగించబడును. అన్ని @fields ఐచ్చికమైనవి.</para>
<para>
<example><title>విభాగపు వ్యాఖ్య బ్లాక్</title>
<programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
* @title: Meep application
* @section_id:
* @see_also: #MeepSettings
* @stability: Stable
* @include: meep/app.h
* @image: application.png
*
* The application class handles ...
*/
]]></programlisting>
</example>
</para>
<variablelist>
<varlistentry>
<term>SECTION:<name></term>
<listitem>
<para>
The name links the section documentation to the respective part in
the <filename><package>-sections.txt</filename> file. The
name given here should match the <FILE> tag in the
<filename><package>-sections.txt</filename> file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@short_description</term>
<listitem>
<para>విభాగము యొక్క వివరణ వొక్క వరుసలో, తరువాత అది TOC నందు లింక్సు తరువాత మరియు విభాగపు పేజీ పైన కనిపించును.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@title</term>
<listitem>
<para>విభాగపు శీర్షిక అనునది SECTION డిక్లరేషన్ నుండి <name> అప్రమేయం కాబడును. ఇది @title క్షేత్రము ద్వారా దిద్దివ్రాయబడును.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@section_id</term>
<listitem>
<para>
Overrides the use of title as a section identifier. For GObjects
the <title> is used as a section_id and for other sections
it is <MODULE>-<title>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@see_also</term>
<listitem>
<para>
A list of symbols that are related to this section.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@stability</term>
<listitem>
<para>
An informal description of the stability level this API has.
We recommend the use of one of these terms:
<itemizedlist>
<listitem>
<para>
Stable
- The intention of a Stable interface is to enable arbitrary
third parties to develop applications to these interfaces,
release them, and have confidence that they will run on all
minor releases of the product (after the one in which the
interface was introduced, and within the same major release).
Even at a major release, incompatible changes are expected
to be rare, and to have strong justifications.
</para>
</listitem>
<listitem>
<para>
Unstable
- Unstable interfaces are experimental or transitional.
They are typically used to give outside developers early
access to new or rapidly changing technology, or to provide
an interim solution to a problem where a more general
solution is anticipated.
No claims are made about either source or binary
compatibility from one minor release to the next.
</para>
</listitem>
<listitem>
<para>
Private
- An interface that can be used within the GNOME stack
itself, but that is not documented for end-users. Such
functions should only be used in specified and documented
ways.
</para>
</listitem>
<listitem>
<para>
Internal
- An interface that is internal to a module and does not
require end-user documentation. Functions that are
undocumented are assumed to be Internal.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@include</term>
<listitem>
<para>విభాగపు సారాంశము నందు చూపుటకు <literal>#include</literal> ఫైళ్ళు (కామాతో వేరుచేయబడిన జాబితా), <link linkend="metafiles_sections">విభాగపు ఫైలు</link> లేదా ఆదేశ వరుసనుండి గ్లోబల్ విలువను దిద్దివ్రాయుట. ఈ అంశము ఐచ్చికము.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@image</term>
<listitem>
<para>ఈ విభాగము కొరకు సూచనపేజీ పైన ప్రదర్శించుటకు ప్రతిబింబము. ఇది తరుచుగా వొక క్లాస్ యొక్క విజువల్ అప్పియరెన్స్ వివరించుటకు డయాగ్రమ్ వంటిది లేదా యితర క్లాసులతో దాని సంభందాన్ని తెలిపే డయాగ్రమ్. ఈ అంశము ఐచ్చికము.</para>
</listitem>
</varlistentry>
</variablelist>
<tip>
<para>అనవసరపు రికంపైలేషన్ను విసర్జించుటకు doc-changes తర్వాత విభాగపు పత్రములను c-source నందు వీలైనచోట వుంచుము.</para>
</tip>
</sect1>
<sect1 id="documenting_symbols">
<title>చిహ్నముల పత్రికీకరణ</title>
<para>
Each symbol (function, macro, struct, enum, signal and property) is
documented in a separate block. The block is best placed close to the
definition of the symbols so that it is easy to keep them in sync.
Thus functions are usually documented in the c-source and macros,
structs and enums in the header file.
</para>
<sect2><title>సాధారణ టాగ్లు</title>
<para>
You can add versioning information to all documentation elements to tell
when an API was introduced, or when it was deprecated.
</para>
<variablelist><title>వర్షనింగ్ టాగ్స్</title>
<varlistentry><term>అప్పటినుంచి:</term>
<listitem>
<para>కోడ్ యొక్క యే వర్షన్ నుండి API అందుబాటులోవుందో వివరణ.</para>
</listitem>
</varlistentry>
<varlistentry><term>తీసివేసిన:</term>
<listitem>
<para>ఈ ఫంక్షన్ యికపై వుపయోగించుటలేదని పారాగ్రాఫ్ చెబుచున్నది. వివరణ చదువరిని కొత్త APIకు సూచించాలి.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
You can also add stability information to all documentation elements
to indicate whether API stability is guaranteed for them for all
future minor releases of the project.
</para>
<para>
The default stability level for all documentation elements can be set
by passing the <option>--default-stability</option> argument to
<application>gtkdoc-mkdb</application> with one of the values below.
</para>
<variablelist><title>Stability Tags</title>
<varlistentry><term>Stability: Stable</term>
<listitem>
<para>
Mark the element as stable. This is for public APIs which are
guaranteed to remain stable for all future minor releases of the
project.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Stability: Unstable</term>
<listitem>
<para>
Mark the element as unstable. This is for public APIs which are
released as a preview before being stabilised.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Stability: Private</term>
<listitem>
<para>
Mark the element as private. This is for interfaces which can be
used by tightly coupled modules, but not by arbitrary third
parties.
</para>
</listitem>
</varlistentry>
</variablelist>
<example><title>సాధారణ టాగ్లు</title>
<programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
*
* Retrieves @foo's bar.
*
* Returns: @foo's bar
*
* Since: 2.6
* Deprecated: 2.12: Use foo_baz_get_bar() instead.
*/
Bar *
foo_get_bar(Foo *foo)
{
...
]]></programlisting>
</example>
</sect2>
<sect2><title>Annotations</title>
<para>
Documentation blocks can contain annotation-tags. These tags will be
rendered with tooltips describing their meaning. The tags are used by
gobject-introspection to generate language bindings. A detailed list
of the supported tags can be found on
<ulink url="http://live.gnome.org/GObjectIntrospection/Annotations" type="http">the wiki</ulink>.
</para>
<example><title>Annotations</title>
<programlisting><![CDATA[
/**
* foo_get_bar: (annotation)
* @foo: (annotation): some foo
*
* Retrieves @foo's bar.
*
* Returns: (annotation): @foo's bar
*/
...
/**
* foo_set_bar_using_the_frobnicator: (annotation) (another annotation)
* (and another annotation)
* @foo: (annotation) (another annotation): some foo
*
* Sets bar on @foo.
*/
]]></programlisting>
</example>
</sect2>
<sect2><title>ఫంక్షన్ వ్యాఖ్యానపు బ్లాక్</title>
<para>
Please remember to:
<itemizedlist>
<listitem>
<para>
Document whether returned objects, lists, strings, etc, should be
freed/unrefed/released.
</para>
</listitem>
<listitem>
<para>
Document whether parameters can be NULL, and what happens if they are.
</para>
</listitem>
<listitem>
<para>
Mention interesting pre-conditions and post-conditions where appropriate.
</para>
</listitem>
</itemizedlist>
</para>
<para>Gtk-doc అన్ని చిహ్నములు (macros, functions) '_'తో ప్రారంభమగునవి వ్యక్తిగతమైనవని పరిగణించును. అవి స్టాటిక్ ఫంక్షన్సు వలె పరిగణించబడును.</para>
<example><title>ఫంక్షన్ వ్యాఖ్యానపు బ్లాక్</title>
<programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @...: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
*
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
]]></programlisting>
</example>
<variablelist><title>ఫంక్షన్ టాగ్లు</title>
<varlistentry><term>తిరిగివచ్చినవి:</term>
<listitem>
<para>పారాగ్రాఫ్ తిరిగివచ్చిన ఫలితాన్ని వివరిస్తుంది.</para>
</listitem>
</varlistentry>
<varlistentry><term>@...:</term>
<listitem>
<para>ఒకవేళ ఫంక్షన్ వేరియాడిక్ ఆర్గుమెంట్లను కలిగివుంటే, మీరు ఈ టాగ్ను వుపయోగించాలి (@Varargs: చారిత్రక కారణాలకు కూడా పనిచేయును).</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2><title>లక్షణము వ్యాఖ్యాము బ్లాక్</title>
<example><title>లక్షణము వ్యాఖ్యాము బ్లాక్</title>
<programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
]]></programlisting>
</example>
</sect2>
<sect2><title>సంకేతపు వ్యాఖ్యానము బ్లాక్</title>
<para>
Please remember to:
<itemizedlist>
<listitem>
<para>
Document when the signal is emitted and whether it is emitted before
or after other signals.
</para>
</listitem>
<listitem>
<para>
Document what an application might do in the signal handler.
</para>
</listitem>
</itemizedlist>
</para>
<example><title>సంకేతపు వ్యాఖ్యానము బ్లాక్</title>
<programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
* @foo: some foo
* @bar: some bar
*
* The ::foobarized signal is emitted each time someone tries to foobarize @widget.
*/
foo_signals[FOOBARIZED] =
g_signal_new ("foobarized",
...
]]></programlisting>
</example>
</sect2>
<sect2><title>Struct వ్యాఖ్యానము బ్లాక్</title>
<example><title>Struct వ్యాఖ్యానము బ్లాక్</title>
<programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
*
* This is the best widget, ever.
*/
typedef struct _FooWidget {
GtkWidget parent_instance;
gboolean bar;
} FooWidget;
]]></programlisting>
</example>
<para>
Use <code>/*< private >*/</code> before the private struct fields
you want to hide. Use <code>/*< public >*/</code> for the reverse
behaviour.
</para>
<para>
If the first field is "g_iface", "parent_instance" or "parent_class"
it will be considered private automatically and doesn't need to be
mentioned in the comment block.
</para>
<para>
Struct comment blocks can also be used for GObjects and GObjectClasses.
It is usually a good idea to add a comment block for a class, if it has
vmethods (as this is how they can be documented). For the GObject
itself one can use the related section docs, having a separate block
for the instance struct would be useful if the instance has public
fields. One disadvantage here is that this creates two index entries
of the same name (the structure and the section).
</para>
</sect2>
<sect2><title>Enum వ్యాఖ్యానము బ్లాక్</title>
<example><title>Enum వ్యాఖ్యానము బ్లాక్</title>
<programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
* @SOMETHING_BAR: something bar
*
* Enum values used for the thing, to specify the thing.
*/
typedef enum {
SOMETHING_FOO,
SOMETHING_BAR,
/*< private >*/
SOMETHING_COUNT
} Something;
]]></programlisting>
</example>
<para>
Use <code>/*< private >*/</code> before the private enum values
you want to hide. Use <code>/*< public >*/</code> for the reverse
behaviour.
</para>
</sect2>
</sect1>
<sect1 id="documenting_inline_program">
<title>Inline program documentation</title>
<para>
You can document programs and their commandline interface using inline
documentation.
</para>
<variablelist>
<title>Tags</title>
<varlistentry><term>PROGRAM</term>
<listitem>
<para>
Defines the start of a program documentation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@short_description:</term>
<listitem>
<para>
Defines a short description of the program. (Optional)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@synopsis:</term>
<listitem>
<para>
Defines the arguments, or list of arguments that the program can take.
(Optional)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@see_also:</term>
<listitem>
<para>
See Also manual page section. (Optional)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>@arg:</term>
<listitem>
<para>
Argument(s) passed to the program and their description. (Optional)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Description:</term>
<listitem>
<para>
A longer description of the program.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>తిరిగివచ్చినవి:</term>
<listitem>
<para>
Specificy what value(s) the program returns. (Optional)
</para>
</listitem>
</varlistentry>
</variablelist>
<sect2>
<title>Example of program documentation.</title>
<example><title>Program documentation block</title>
<programlisting><![CDATA[
/**
* PROGRAM:test-program
* @short_description: A test program
* @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*
* @see_also: test(1)
* @--arg1 *arg*: set arg1 to *arg*
* @--arg2 *arg*: set arg2 to *arg*
* @-v, --version: Print the version number
* @-h, --help: Print the help message
*
* Long description of program.
*
* Returns: Zero on success, non-zero on failure
*/
int main(int argc, char *argv[])
{
return 0;
}
]]></programlisting>
</example>
</sect2>
</sect1>
<sect1 id="documenting_docbook">
<title>ఉపయోగకర DocBook టాగ్స్</title>
<para>కోడ్ను పత్రికీకరణ చేయునప్పుడు యెక్కువ వుపయోగకరంగా వుండే మరికొన్ని DocBook టాగ్స్ యిక్కడ వున్నాయి.</para>
<para>
To link to another section in the GTK docs:
<informalexample>
<programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
the page title ("Hash Tables"). For widgets it is just the class name.
Spaces and underscores are converted to '-' to conform to SGML/XML.
</para>
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
<programlisting><![CDATA[
<function>...</function>
]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
<programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
<programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
|[
...
]|
]]>
</para>
<para>
To include bulleted lists:
<informalexample>
<programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
...
</para>
</listitem>
<listitem>
<para>
...
</para>
</listitem>
</itemizedlist>
]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
<programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
<programlisting><![CDATA[
<type>unsigned char</type>
]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
<programlisting><![CDATA[
<structname>XFontStruct</structname>
]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
<programlisting><![CDATA[
<structfield>len</structfield>
]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
<programlisting><![CDATA[
<classname>GtkWidget</classname>
]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
</para>
<para>
To emphasize text:
<informalexample>
<programlisting><![CDATA[
<emphasis>This is important</emphasis>
]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
<programlisting><![CDATA[
<filename>/home/user/documents</filename>
]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
<programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
]]></programlisting>
</informalexample>
</para>
</sect1>
</chapter>
<chapter id="metafiles">
<title>Filling the extra files</title>
<para>
There are a couple of extra files, that need to be maintained along with
the inline source code comments:
<filename><package>.types</filename>,
<filename><package>-docs.xml</filename> (in the past .sgml),
<filename><package>-sections.txt</filename>.
</para>
<sect1 id="metafiles_types">
<title>Editing the types file</title>
<para>
If your library or application includes GObjects, you want
their signals, arguments/parameters and position in the hierarchy to be
shown in the documentation. All you need to do, is to list the
<function>xxx_get_type</function> functions together with their include
inside the <filename><package>.types</filename> file.
</para>
<para>
<example><title>Example types file snippet</title>
<programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
]]></programlisting>
</example>
</para>
<para>
Since GTK-Doc 1.8 <application>gtkdoc-scan</application> can generate this list for you.
Just add "--rebuild-types" to SCAN_OPTIONS in <filename>Makefile.am</filename>. If you
use this approach you should not dist the types file nor have it under version control.
</para>
</sect1>
<sect1 id="metafiles_master">
<title>Editing the master document</title>
<para>
GTK-Doc produces documentation in DocBook SGML/XML. When processing the
inline source comments, the GTK-Doc tools generate one documentation
page per class or module as a separate file. The master document
includes them and place them in an order.
</para>
<para>
While GTK-Doc creates a template master document for you, later runs will
not touch it again. This means that one can freely structure the
documentation. That includes grouping pages and adding extra pages.
GTK-Doc has now a test suite, where also the master-document is recreated from scratch.
Its a good idea to look at this from time to time to see if there are
some new goodies introduced there.
</para>
<tip>
<para>
Do not create tutorials as extra documents. Just write extra chapters.
The benefit of directly embedding the tutorial for your library into
the API documentation is that it is easy to link for the tutorial to
symbol documentation. Apart chances are higher that the tutorial gets
updates along with the library.
</para>
</tip>
<para>
So what are the things to change inside the master document? For a start
is only a little. There are some placeholders (text in square brackets)
there which you should take care of.
</para>
<para>
<example><title>Master document header</title>
<programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
for MODULENAME [VERSION]
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
</releaseinfo>
</bookinfo>
<chapter>
<title>[Insert title here]</title>
]]></programlisting>
</example>
</para>
<para>
In addition a few option elements are created in commented form. You can
review these and enable them as you like.
</para>
<para>
<example><title>Optional part in the master document</title>
<programlisting><![CDATA[
<!-- enable this when you use gobject introspection annotations
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-->
]]></programlisting>
</example>
</para>
<para>
Finally you need to add new section whenever you introduce one. The
<link linkend="modernizing-gtk-doc-1-16">gtkdoc-check</link> tool will
remind you of newly generated xml files that are not yet included into
the doc.
</para>
<para>
<example><title>Including generated sections</title>
<programlisting><![CDATA[
<chapter>
<title>my library</title>
<xi:include href="xml/object.xml"/>
...
]]></programlisting>
</example>
</para>
</sect1>
<sect1 id="metafiles_sections">
<title>Editing the section file</title>
<para>
The section file is used to organise the documentation output by
GTK-Doc. Here one specifies which symbol belongs to which module or
class and control the visibility (public or private).
</para>
<para>
The section file is a plain text file with tags delimiting sections.
Blank lines are ignored and lines starting with a '#' are treated as
comment lines.
</para>
<note>
<para>
While the tags make the file look like xml, it is not. Please do not
close tags like <SUBSECTION>.
</para>
</note>
<para>
<example><title>Including generated sections</title>
<programlisting><![CDATA[
<INCLUDE>libmeep/meep.h</INCLUDE>
<SECTION>
<FILE>meepapp</FILE>
<TITLE>MeepApp</TITLE>
MeepApp
<SUBSECTION Standard>
MEEP_APP
...
MeepAppClass
meep_app_get_type
</SECTION>
]]></programlisting>
</example>
</para>
<para>
The <FILE> ... </FILE> tag is used to specify the file name,
without any suffix. For example, using '<FILE>gnome-config</FILE>'
will result in the section declarations being output in the template
file <filename>tmpl/gnome-config.sgml</filename>, which will be
converted into the DocBook XML file <filename>xml/gnome-config.sgml</filename>
or the DocBook XML file <filename>xml/gnome-config.xml</filename>.
(The name of the HTML file is based on the module name and the section
title, or for GObjects it is based on the GObjects class name converted
to lower case).
</para>
<para>
The <TITLE> ... </TITLE> tag is used to specify the title of
the section. It is only useful before the templates (if used) are
initially created, since the title set in the template file overrides
this. Also if one uses SECTION comment in the sources, this is obsolete.
</para>
<para>
You can group items in the section by using the <SUBSECTION> tag.
Currently it outputs a blank line between subsections in the synopsis
section.
You can also use <SUBSECTION Standard> for standard GObject
declarations (e.g. the functions like g_object_get_type and macros like
G_OBJECT(), G_IS_OBJECT() etc.).
Currently these are left out of the documentation.
You can also use <SUBSECTION Private> for private declarations
which will not be output (it is a handy way to avoid warning messages
about unused declarations).
If your library contains private types which you don't want to appear in
the object hierarchy and the list of implemented or required interfaces,
add them to a Private subsection.
Whether you would place GObject and GObjectClass like structs in public
or Standard section depends if they have public entries (variables,
vmethods).
</para>
<para>
You can also use <INCLUDE> ... </INCLUDE> to specify the
#include files which are shown in the synopsis sections.
It contains a comma-separate list of #include files, without the angle
brackets. If you set it outside of any sections, it acts for all
sections until the end of the file. If you set it within a section, it
only applies to that section.
</para>
</sect1>
</chapter>
<chapter id="reports">
<title>Controlling the result</title>
<para>
A GTK-Doc run generates report files inside the documentation directory.
The generated files are named:
<filename><package>-undocumented.txt</filename>,
<filename><package>-undeclared.txt</filename> and
<filename><package>-unused.txt</filename>.
All those are plain text files that can be viewed and postprocessed easily.
</para>
<para>
The <filename><package>-undocumented.txt</filename> file starts with
the documentation coverage summary. Below are two sections divided by
blank lines. The first section lists undocumented or incomplete symbols.
The second section does the same for section docs. Incomplete entries are
those, which have documentation, but where e.g. a new parameter has been
added.
</para>
<para>
The <filename><package>-undeclared.txt</filename> file lists symbols
given in the <filename><package>-sections.txt</filename> but not
found in the sources. Check if they have been removed or if they are
misspelled.
</para>
<para>
The <filename><package>-unused.txt</filename> file lists symbol
names, where the GTK-Doc scanner has found documentation, but does not
know where to put it. This means that the symbol has not yet been added to
the <filename><package>-sections.txt</filename> file.
</para>
<tip>
<para>
Enable or add the <option>TESTS=$(GTKDOC_CHECK)</option> line in Makefile.am.
If at least GTK-Doc 1.9 is installed, this will run sanity checks during
<command>make check</command> run.
</para>
</tip>
<para>
One can also look at the files produced by the source code scanner:
<filename><package>-decl-list.txt</filename> and
<filename><package>-decl.txt</filename>. The first one can be
compared with the section file if that is manually maintained. The second
lists all declarations from the headers. If a symbol is missing one could
check if this file contains it.
</para>
<para>
If the project is GObject based, one can also look into the files produced
by the object scanner:
<filename><package>.args.txt</filename>,
<filename><package>.hierarchy.txt</filename>,
<filename><package>.interfaces.txt</filename>,
<filename><package>.prerequisites.txt</filename> and
<filename><package>.signals.txt</filename>. If there are missing
symbols in any of those, one can ask GTK-Doc to keep the intermediate
scanner file for further analysis, by running it as
<command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>.
</para>
</chapter>
<chapter id="modernizing">
<title>Modernizing the documentation</title>
<para>
GTK-Doc has been around for quite some time. In this section we list new
features together with the version since when it is available.
</para>
<sect1 id="modernizing-gtk-doc-1-9">
<title>GTK-Doc 1.9</title>
<para>
When using xml instead of sgml, one can actually name the master
document <filename><package>-docs.xml</filename>.
</para>
<para>
This version supports <option>SCAN_OPTIONS=--rebuild-sections</option>
in <filename>Makefile.am</filename>. When this is enabled, the
<filename><package>-sections.txt</filename> is autogenerated and
can be removed from the vcs. This only works nicely for projects that
have a very regular structure (e.g. each .{c,h} pair will create new
section). If one organize a project close to that updating a manually
maintained section file can be as simple as running
<code>meld <package>-decl-list.txt <package>-sections.txt</code>.
</para>
<para>
Version 1.8 already introduced the syntax for documenting sections in
the sources instead of the separate files under <filename class="directory">tmpl</filename>.
This version adds options to switch the whole doc module to not use the
extra tmpl build step at all, by using <option>--flavour no-tmpl</option>
in <filename>configure.ac</filename>. If you don't have a <filename class="directory">tmpl</filename>
checked into your source control system and haven't yet switched, just
add the flag to <filename>configure.ac</filename> and you are done.
</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-10">
<title>GTK-Doc 1.10</title>
<para>
This version supports <option>SCAN_OPTIONS=--rebuild-types</option> in
<filename>Makefile.am</filename>. When this is enabled, the
<filename><package>.types</filename> is autogenerated and can be
removed from the vcs. When using this feature it is important to also
setup the <varname>IGNORE_HFILES</varname> in
<filename>Makefile.am</filename> for code that is build conditionally.
</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-16">
<title>GTK-Doc 1.16</title>
<para>
This version includes a new tool called gtkdoc-check. This tool can run
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
<programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
]]></programlisting>
</example>
</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-20">
<title>GTK-Doc 1.20</title>
<para>
Version 1.18 brought some initial markdown support. Using markdown in
doc comments is less intrusive than writing docbook xml. This version
improves a lot on this and add a lot more styles. The section that
explains the <link linkend="documenting_syntax">comment syntax</link>
has all the details.
</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-25">
<title>GTK-Doc 1.25</title>
<para>
The makefiles shipped with this version generate an entity file at <filename>xml/gtkdocentities.ent</filename>,
containing entities for e.g. package_name and package_version. You can
use this e.g. in the main xml file to avoid hardcoding the version
number. Below is an example that shows how the entity file is included
and how the entities are used. The entities can also be used in all
generated files, GTK-Doc will use the same xml header in generated xml
files.
<example><title>Use pre-generated entities</title>
<programlisting><![CDATA[
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>&package_name; Reference Manual</title>
<releaseinfo>
for &package_string;.
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://[SERVER]/&package_name;/index.html">http://[SERVER]/&package_name;/</ulink>.
</releaseinfo>
</bookinfo>
]]></programlisting>
</example>
</para>
</sect1>
</chapter>
<chapter id="documenting-others">
<title>Documenting other interfaces</title>
<para>
So far we have been using GTK-Doc to document the API of code. The next
sections contain suggestions how the tools can be used to document other
interfaces too.
</para>
<sect1 id="commandline-interfaces">
<title>Command line options and man pages</title>
<para>
As one can generate man pages for a docbook refentry as well, it sounds
like a good idea to use it for that purpose. This way the interface is
part of the reference and one gets the man-page for free.
</para>
<sect2 id="commandline-interfaces-file">
<title>Document the tool</title>
<para>
Create one refentry file per tool. Following
<link linkend="settingup_docfiles">our example</link> we would call it
<filename>meep/docs/reference/meeper/meep.xml</filename>. For the xml
tags that should be used and can look at generated file in the xml
subdirectory as well as examples e.g. in glib.
</para>
</sect2>
<sect2 id="commandline-interfaces-configure">
<title>Adding the extra configure check</title>
<para>
<example><title>Extra configure checks</title>
<programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
enable_man=no)
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
]]></programlisting>
</example>
</para>
</sect2>
<sect2 id="commandline-interfaces-make">
<title>Adding the extra makefile rules</title>
<para>
<example><title>Extra configure checks</title>
<programlisting><![CDATA[
man_MANS = \
meeper.1
if ENABLE_GTK_DOC
if ENABLE_MAN
%.1 : %.xml
@XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
endif
endif
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
]]></programlisting>
</example>
</para>
</sect2>
</sect1>
<sect1 id="dbus-interfaces">
<title>DBus interfaces</title>
<para>
(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html,
http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)
</para>
</sect1>
</chapter>
<chapter id="faq">
<title>Frequently asked questions</title>
<segmentedlist>
<?dbhtml list-presentation="list"?>
<segtitle>Question</segtitle>
<segtitle>Answer</segtitle>
<seglistitem>
<seg>No class hierarchy.</seg>
<seg>
The objects <function>xxx_get_type()</function> function has not been
entered into the <filename><package>.types</filename> file.
</seg>
</seglistitem>
<seglistitem>
<seg>Still no class hierarchy.</seg>
<seg>
Missing or wrong naming in <filename><package>-sections.txt</filename>
file (see <ulink url="http://mail.gnome.org/archives/gtk-doc-list/2003-October/msg00006.html">explanation</ulink>).
</seg>
</seglistitem>
<seglistitem>
<seg>Damn, I have still no class hierarchy.</seg>
<seg>
Is the object name (name of the instance struct, e.g. <type>GtkWidget</type>)
part of the normal section (don't put this into Standard or Private
subsections).
</seg>
</seglistitem>
<seglistitem>
<seg>No symbol index.</seg>
<seg>
Does the <filename><package>-docs.{xml,sgml}</filename> contain a
index that xi:includes the generated index?
</seg>
</seglistitem>
<seglistitem>
<seg>Symbols are not linked to their doc-section.</seg>
<seg>
Is the doc-comment using the correct markup (added #,% or ())?
Check if the gtkdoc-fixxref warns about unresolvable xrefs.
</seg>
</seglistitem>
<seglistitem>
<seg>A new class does not appear in the docs.</seg>
<seg>
Is the new page xi:included from
<filename><package>-docs.{xml,sgml}</filename>.
</seg>
</seglistitem>
<seglistitem>
<seg>A new symbol does not appear in the docs.</seg>
<seg>
Is the doc-comment properly formatted. Check for spelling mistakes in
the begin of the comment. Check if the gtkdoc-fixxref warns about
unresolvable xrefs. Check if the symbol is correctly listed in the
<filename><package>-sections.txt</filename> in a public subsection.
</seg>
</seglistitem>
<seglistitem>
<seg>A type is missing from the class hierarchy.</seg>
<seg>
If the type is listed in <filename><package>.hierarchy</filename>
but not in <filename>xml/tree_index.sgml</filename> then double check
that the type is correctly placed in the <filename><package>-sections.txt</filename>.
If the type instance (e.g. <type>GtkWidget</type>) is not listed or
incidentally marked private it will not be shown.
</seg>
</seglistitem>
<seglistitem>
<seg>I get foldoc links for all gobject annotations.</seg>
<seg>
Check that <filename>xml/annotation-glossary.xml</filename> is
xi:included from <filename><package>-docs.{xml,sgml}</filename>.
</seg>
</seglistitem>
<!-- gtk-doc warnings: -->
<seglistitem>
<seg>Parameter described in source code comment block but does not exist</seg>
<seg>Check if the prototype in the header has different parameter names as in the source.</seg>
</seglistitem>
<!-- docbook warnings: -->
<seglistitem>
<seg>multiple "IDs" for constraint linkend: XYZ</seg>
<seg>Symbol XYZ appears twice in <filename><package>-sections.txt</filename> file.</seg>
</seglistitem>
<seglistitem>
<seg>Element typename in namespace '' encountered in para, but no template matches.</seg>
<seg/>
</seglistitem>
</segmentedlist>
</chapter>
<chapter id="contrib">
<title>Tools related to gtk-doc</title>
<para>
GtkDocPlugin - a <ulink url="http://trac-hacks.org/wiki/GtkDocPlugin">Trac GTK-Doc</ulink>
integration plugin, that adds API docs to a trac site and integrates with
the trac search.
</para>
<para>
Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since
tags in the API to determine the minimum required version.
</para>
</chapter>
<!-- ======== Appendix: FDL ================================== -->
<!--
The GNU Free Documentation License 1.1 in DocBook
Markup by Eric Baudais <baudais@okstate.edu>
Maintained by the GNOME Documentation Project
http://developer.gnome.org/projects/gdp
Version: 1.0.1
Last Modified: Nov 16, 2000
-->
<appendix id="fdl">
<appendixinfo>
<releaseinfo>
Version 1.1, March 2000
</releaseinfo>
<copyright>
<year>2000</year><holder>Free Software Foundation, Inc.</holder>
</copyright>
<legalnotice id="fdl-legalnotice">
<para>
<address>Free Software Foundation, Inc. <street>51 Franklin Street,
Suite 330</street>, <city>Boston</city>, <state>MA</state>
<postcode>02110-1301</postcode> <country>USA</country></address>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
</para>
</legalnotice>
</appendixinfo>
<title>GNU Free Documentation License</title>
<sect1 id="fdl-preamble">
<title>0. PREAMBLE</title>
<para>
The purpose of this License is to make a manual, textbook, or
other written document <quote>free</quote> in the sense of
freedom: to assure everyone the effective freedom to copy and
redistribute it, with or without modifying it, either
commercially or noncommercially. Secondarily, this License
preserves for the author and publisher a way to get credit for
their work, while not being considered responsible for
modifications made by others.
</para>
<para>
This License is a kind of <quote>copyleft</quote>, which means
that derivative works of the document must themselves be free in
the same sense. It complements the GNU General Public License,
which is a copyleft license designed for free software.
</para>
<para>
We have designed this License in order to use it for manuals for
free software, because free software needs free documentation: a
free program should come with manuals providing the same
freedoms that the software does. But this License is not limited
to software manuals; it can be used for any textual work,
regardless of subject matter or whether it is published as a
printed book. We recommend this License principally for works
whose purpose is instruction or reference.
</para>
</sect1>
<sect1 id="fdl-section1">
<title>1. APPLICABILITY AND DEFINITIONS</title>
<para id="fdl-document">
This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be
distributed under the terms of this License. The
<quote>Document</quote>, below, refers to any such manual or
work. Any member of the public is a licensee, and is addressed
as <quote>you</quote>.
</para>
<para id="fdl-modified">
A <quote>Modified Version</quote> of the Document means any work
containing the Document or a portion of it, either copied
verbatim, or with modifications and/or translated into another
language.
</para>
<para id="fdl-secondary">
A <quote>Secondary Section</quote> is a named appendix or a
front-matter section of the <link linkend="fdl-document">Document</link> that deals exclusively
with the relationship of the publishers or authors of the
Document to the Document's overall subject (or to related
matters) and contains nothing that could fall directly within
that overall subject. (For example, if the Document is in part a
textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of
legal, commercial, philosophical, ethical or political position
regarding them.
</para>
<para id="fdl-invariant">
The <quote>Invariant Sections</quote> are certain <link linkend="fdl-secondary"> Secondary Sections</link> whose titles
are designated, as being those of Invariant Sections, in the
notice that says that the <link linkend="fdl-document">Document</link> is released under this
License.
</para>
<para id="fdl-cover-texts">
The <quote>Cover Texts</quote> are certain short passages of
text that are listed, as Front-Cover Texts or Back-Cover Texts,
in the notice that says that the <link linkend="fdl-document">Document</link> is released under this
License.
</para>
<para id="fdl-transparent">
A <quote>Transparent</quote> copy of the <link linkend="fdl-document"> Document</link> means a machine-readable
copy, represented in a format whose specification is available
to the general public, whose contents can be viewed and edited
directly and straightforwardly with generic text editors or (for
images composed of pixels) generic paint programs or (for
drawings) some widely available drawing editor, and that is
suitable for input to text formatters or for automatic
translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent file format
whose markup has been designed to thwart or discourage
subsequent modification by readers is not Transparent. A copy
that is not <quote>Transparent</quote> is called
<quote>Opaque</quote>.
</para>
<para>
Examples of suitable formats for Transparent copies include
plain ASCII without markup, Texinfo input format, LaTeX input
format, SGML or XML using a publicly available DTD, and
standard-conforming simple HTML designed for human
modification. Opaque formats include PostScript, PDF,
proprietary formats that can be read and edited only by
proprietary word processors, SGML or XML for which the DTD
and/or processing tools are not generally available, and the
machine-generated HTML produced by some word processors for
output purposes only.
</para>
<para id="fdl-title-page">
The <quote>Title Page</quote> means, for a printed book, the
title page itself, plus such following pages as are needed to
hold, legibly, the material this License requires to appear in
the title page. For works in formats which do not have any title
page as such, <quote>Title Page</quote> means the text near the
most prominent appearance of the work's title, preceding the
beginning of the body of the text.
</para>
</sect1>
<sect1 id="fdl-section2">
<title>2. VERBATIM COPYING</title>
<para>
You may copy and distribute the <link linkend="fdl-document">Document</link> in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License
applies to the Document are reproduced in all copies, and that
you add no other conditions whatsoever to those of this
License. You may not use technical measures to obstruct or
control the reading or further copying of the copies you make or
distribute. However, you may accept compensation in exchange for
copies. If you distribute a large enough number of copies you
must also follow the conditions in <link linkend="fdl-section3">section 3</link>.
</para>
<para>
You may also lend copies, under the same conditions stated
above, and you may publicly display copies.
</para>
</sect1>
<sect1 id="fdl-section3">
<title>3. COPYING IN QUANTITY</title>
<para>
If you publish printed copies of the <link linkend="fdl-document">Document</link> numbering more than 100,
and the Document's license notice requires <link linkend="fdl-cover-texts">Cover Texts</link>, you must enclose
the copies in covers that carry, clearly and legibly, all these
Cover Texts: Front-Cover Texts on the front cover, and
Back-Cover Texts on the back cover. Both covers must also
clearly and legibly identify you as the publisher of these
copies. The front cover must present the full title with all
words of the title equally prominent and visible. You may add
other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the
<link linkend="fdl-document">Document</link> and satisfy these
conditions, can be treated as verbatim copying in other
respects.
</para>
<para>
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto
adjacent pages.
</para>
<para>
If you publish or distribute <link linkend="fdl-transparent">Opaque</link> copies of the <link linkend="fdl-document">Document</link> numbering more than 100,
you must either include a machine-readable <link linkend="fdl-transparent">Transparent</link> copy along with
each Opaque copy, or state in or with each Opaque copy a
publicly-accessible computer-network location containing a
complete Transparent copy of the Document, free of added
material, which the general network-using public has access to
download anonymously at no charge using public-standard network
protocols. If you use the latter option, you must take
reasonably prudent steps, when you begin distribution of Opaque
copies in quantity, to ensure that this Transparent copy will
remain thus accessible at the stated location until at least one
year after the last time you distribute an Opaque copy (directly
or through your agents or retailers) of that edition to the
public.
</para>
<para>
It is requested, but not required, that you contact the authors
of the <link linkend="fdl-document">Document</link> well before
redistributing any large number of copies, to give them a chance
to provide you with an updated version of the Document.
</para>
</sect1>
<sect1 id="fdl-section4">
<title>4. MODIFICATIONS</title>
<para>
You may copy and distribute a <link linkend="fdl-modified">Modified Version</link> of the <link linkend="fdl-document">Document</link> under the conditions of
sections <link linkend="fdl-section2">2</link> and <link linkend="fdl-section3">3</link> above, provided that you release
the Modified Version under precisely this License, with the
Modified Version filling the role of the Document, thus
licensing distribution and modification of the Modified Version
to whoever possesses a copy of it. In addition, you must do
these things in the Modified Version:
</para>
<itemizedlist mark="opencircle">
<listitem>
<formalpara>
<title>A</title>
<para>
Use in the <link linkend="fdl-title-page">Title
Page</link> (and on the covers, if any) a title distinct
from that of the <link linkend="fdl-document">Document</link>, and from those of
previous versions (which should, if there were any, be
listed in the History section of the Document). You may
use the same title as a previous version if the original
publisher of that version gives permission.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>B</title>
<para>
List on the <link linkend="fdl-title-page">Title
Page</link>, as authors, one or more persons or entities
responsible for authorship of the modifications in the
<link linkend="fdl-modified">Modified Version</link>,
together with at least five of the principal authors of
the <link linkend="fdl-document">Document</link> (all of
its principal authors, if it has less than five).
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>C</title>
<para>
State on the <link linkend="fdl-title-page">Title
Page</link> the name of the publisher of the <link linkend="fdl-modified">Modified Version</link>, as the
publisher.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>D</title>
<para>
Preserve all the copyright notices of the <link linkend="fdl-document">Document</link>.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>E</title>
<para>
Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>F</title>
<para>
Include, immediately after the copyright notices, a
license notice giving the public permission to use the
<link linkend="fdl-modified">Modified Version</link> under
the terms of this License, in the form shown in the
Addendum below.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>G</title>
<para>
Preserve in that license notice the full lists of <link linkend="fdl-invariant"> Invariant Sections</link> and
required <link linkend="fdl-cover-texts">Cover
Texts</link> given in the <link linkend="fdl-document">Document's</link> license notice.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>H</title>
<para>
Include an unaltered copy of this License.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>I</title>
<para>
Preserve the section entitled <quote>History</quote>, and
its title, and add to it an item stating at least the
title, year, new authors, and publisher of the <link linkend="fdl-modified">Modified Version</link> as given on
the <link linkend="fdl-title-page">Title Page</link>. If
there is no section entitled <quote>History</quote> in the
<link linkend="fdl-document">Document</link>, create one
stating the title, year, authors, and publisher of the
Document as given on its Title Page, then add an item
describing the Modified Version as stated in the previous
sentence.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>J</title>
<para>
Preserve the network location, if any, given in the <link linkend="fdl-document">Document</link> for public access
to a <link linkend="fdl-transparent">Transparent</link>
copy of the Document, and likewise the network locations
given in the Document for previous versions it was based
on. These may be placed in the <quote>History</quote>
section. You may omit a network location for a work that
was published at least four years before the Document
itself, or if the original publisher of the version it
refers to gives permission.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>K</title>
<para>
In any section entitled <quote>Acknowledgements</quote> or
<quote>Dedications</quote>, preserve the section's title,
and preserve in the section all the substance and tone of
each of the contributor acknowledgements and/or
dedications given therein.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>L</title>
<para>
Preserve all the <link linkend="fdl-invariant">Invariant
Sections</link> of the <link linkend="fdl-document">Document</link>, unaltered in their
text and in their titles. Section numbers or the
equivalent are not considered part of the section titles.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>M</title>
<para>
Delete any section entitled
<quote>Endorsements</quote>. Such a section may not be
included in the <link linkend="fdl-modified">Modified
Version</link>.
</para>
</formalpara>
</listitem>
<listitem>
<formalpara>
<title>N</title>
<para>
Do not retitle any existing section as
<quote>Endorsements</quote> or to conflict in title with
any <link linkend="fdl-invariant">Invariant
Section</link>.
</para>
</formalpara>
</listitem>
</itemizedlist>
<para>
If the <link linkend="fdl-modified">Modified Version</link>
includes new front-matter sections or appendices that qualify as
<link linkend="fdl-secondary">Secondary Sections</link> and
contain no material copied from the Document, you may at your
option designate some or all of these sections as invariant. To
do this, add their titles to the list of <link linkend="fdl-invariant">Invariant Sections</link> in the
Modified Version's license notice. These titles must be
distinct from any other section titles.
</para>
<para>
You may add a section entitled <quote>Endorsements</quote>,
provided it contains nothing but endorsements of your <link linkend="fdl-modified">Modified Version</link> by various
parties--for example, statements of peer review or that the text
has been approved by an organization as the authoritative
definition of a standard.
</para>
<para>
You may add a passage of up to five words as a <link linkend="fdl-cover-texts">Front-Cover Text</link>, and a passage
of up to 25 words as a <link linkend="fdl-cover-texts">Back-Cover Text</link>, to the end of
the list of <link linkend="fdl-cover-texts">Cover Texts</link>
in the <link linkend="fdl-modified">Modified Version</link>.
Only one passage of Front-Cover Text and one of Back-Cover Text
may be added by (or through arrangements made by) any one
entity. If the <link linkend="fdl-document">Document</link>
already includes a cover text for the same cover, previously
added by you or by arrangement made by the same entity you are
acting on behalf of, you may not add another; but you may
replace the old one, on explicit permission from the previous
publisher that added the old one.
</para>
<para>
The author(s) and publisher(s) of the <link linkend="fdl-document">Document</link> do not by this License
give permission to use their names for publicity for or to
assert or imply endorsement of any <link linkend="fdl-modified">Modified Version </link>.
</para>
</sect1>
<sect1 id="fdl-section5">
<title>5. COMBINING DOCUMENTS</title>
<para>
You may combine the <link linkend="fdl-document">Document</link>
with other documents released under this License, under the
terms defined in <link linkend="fdl-section4">section 4</link>
above for modified versions, provided that you include in the
combination all of the <link linkend="fdl-invariant">Invariant
Sections</link> of all of the original documents, unmodified,
and list them all as Invariant Sections of your combined work in
its license notice.
</para>
<para>
The combined work need only contain one copy of this License,
and multiple identical <link linkend="fdl-invariant">Invariant
Sections</link> may be replaced with a single copy. If there are
multiple Invariant Sections with the same name but different
contents, make the title of each such section unique by adding
at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique
number. Make the same adjustment to the section titles in the
list of Invariant Sections in the license notice of the combined
work.
</para>
<para>
In the combination, you must combine any sections entitled
<quote>History</quote> in the various original documents,
forming one section entitled <quote>History</quote>; likewise
combine any sections entitled <quote>Acknowledgements</quote>,
and any sections entitled <quote>Dedications</quote>. You must
delete all sections entitled <quote>Endorsements.</quote>
</para>
</sect1>
<sect1 id="fdl-section6">
<title>6. COLLECTIONS OF DOCUMENTS</title>
<para>
You may make a collection consisting of the <link linkend="fdl-document">Document</link> and other documents
released under this License, and replace the individual copies
of this License in the various documents with a single copy that
is included in the collection, provided that you follow the
rules of this License for verbatim copying of each of the
documents in all other respects.
</para>
<para>
You may extract a single document from such a collection, and
distribute it individually under this License, provided you
insert a copy of this License into the extracted document, and
follow this License in all other respects regarding verbatim
copying of that document.
</para>
</sect1>
<sect1 id="fdl-section7">
<title>7. AGGREGATION WITH INDEPENDENT WORKS</title>
<para>
A compilation of the <link linkend="fdl-document">Document</link> or its derivatives with
other separate and independent documents or works, in or on a
volume of a storage or distribution medium, does not as a whole
count as a <link linkend="fdl-modified">Modified Version</link>
of the Document, provided no compilation copyright is claimed
for the compilation. Such a compilation is called an
<quote>aggregate</quote>, and this License does not apply to the
other self-contained works thus compiled with the Document , on
account of their being thus compiled, if they are not themselves
derivative works of the Document. If the <link linkend="fdl-cover-texts">Cover Text</link> requirement of <link linkend="fdl-section3">section 3</link> is applicable to these
copies of the Document, then if the Document is less than one
quarter of the entire aggregate, the Document's Cover Texts may
be placed on covers that surround only the Document within the
aggregate. Otherwise they must appear on covers around the whole
aggregate.
</para>
</sect1>
<sect1 id="fdl-section8">
<title>8. TRANSLATION</title>
<para>
Translation is considered a kind of modification, so you may
distribute translations of the <link linkend="fdl-document">Document</link> under the terms of <link linkend="fdl-section4">section 4</link>. Replacing <link linkend="fdl-invariant"> Invariant Sections</link> with
translations requires special permission from their copyright
holders, but you may include translations of some or all
Invariant Sections in addition to the original versions of these
Invariant Sections. You may include a translation of this
License provided that you also include the original English
version of this License. In case of a disagreement between the
translation and the original English version of this License,
the original English version will prevail.
</para>
</sect1>
<sect1 id="fdl-section9">
<title>9. TERMINATION</title>
<para>
You may not copy, modify, sublicense, or distribute the <link linkend="fdl-document">Document</link> except as expressly
provided for under this License. Any other attempt to copy,
modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
</para>
</sect1>
<sect1 id="fdl-section10">
<title>10. FUTURE REVISIONS OF THIS LICENSE</title>
<para>
The <ulink type="http" url="http://www.gnu.org/fsf/fsf.html">Free Software
Foundation</ulink> may publish new, revised versions of the GNU
Free Documentation License from time to time. Such new versions
will be similar in spirit to the present version, but may differ
in detail to address new problems or concerns. See <ulink type="http" url="http://www.gnu.org/copyleft">http://www.gnu.org/copyleft/</ulink>.
</para>
<para>
Each version of the License is given a distinguishing version
number. If the <link linkend="fdl-document">Document</link>
specifies that a particular numbered version of this License
<quote>or any later version</quote> applies to it, you have the
option of following the terms and conditions either of that
specified version or of any later version that has been
published (not as a draft) by the Free Software Foundation. If
the Document does not specify a version number of this License,
you may choose any version ever published (not as a draft) by
the Free Software Foundation.
</para>
</sect1>
<sect1 id="fdl-using">
<title>Addendum</title>
<para>
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
</para>
<blockquote>
<para>
Copyright YEAR YOUR NAME.
</para>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License, Version 1.1 or any later version published by the
Free Software Foundation; with the <link linkend="fdl-invariant">Invariant Sections</link> being LIST
THEIR TITLES, with the <link linkend="fdl-cover-texts">Front-Cover Texts</link> being LIST,
and with the <link linkend="fdl-cover-texts">Back-Cover
Texts</link> being LIST. A copy of the license is included in
the section entitled <quote>GNU Free Documentation
License</quote>.
</para>
</blockquote>
<para>
If you have no <link linkend="fdl-invariant">Invariant
Sections</link>, write <quote>with no Invariant Sections</quote>
instead of saying which ones are invariant. If you have no
<link linkend="fdl-cover-texts">Front-Cover Texts</link>, write
<quote>no Front-Cover Texts</quote> instead of
<quote>Front-Cover Texts being LIST</quote>; likewise for <link linkend="fdl-cover-texts">Back-Cover Texts</link>.
</para>
<para>
If your document contains nontrivial examples of program code,
we recommend releasing these examples in parallel under your
choice of free software license, such as the <ulink type="http" url="http://www.gnu.org/copyleft/gpl.html"> GNU General Public
License</ulink>, to permit their use in free software.
</para>
</sect1>
</appendix>
</book>
|