/usr/share/perl5/RefDB/Makestyle.pm is in librefdb-perlmod-perl 1.2-2.
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 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 | package RefDB::Makestyle;
use 5.008006;
use strict;
use warnings;
use base qw(Exporter);
our $VERSION = '1.2';
=head1 NAME
RefDB::Makestyle - methods used by refdb-ms (RefDB style generator)
=head1 SUMMARY
Makestyle.pm - a module used by I<refdb-ms> (RefDB MakeStyle) -- a utility that generates RefDB bibliography I<style>s.
Provides C<< Element >> and C<< Attribute >> classes for use in generating RefDB I<style>s.
=head1 DEPENDENCIES
The following perl modules are required by this library:
=over
=item
B<Scalar::Util>
Provides a method of querying an object to determine its base class.
=item
B<Term::Clui>
Provides user interface.
For input it provides mechanisms for selection from menus, direct input and for yes/no question-answer prompts.
For output it provides for console output or display in the default editor.
This module, by default, records user choices in a hidden database. This behaviour is turned off.
Term::Clui::edit uses a console editor for display. It uses the editor specified by the EDITOR variable. If this variable is not set it falls back to the 'vi' editor.
=item
B<Text::Wrap>
Provides word-wrap for console display.
=item
B<File::Temp>
Provides useful methods for filename generation.
The OO methods are not used because, at the time of writing, the version shipped with some *nix-like OSes does not yet include the OO interface.
=back
=cut
use Scalar::Util 'blessed';
use Term::Clui;
$ENV{'CLUI_DIR'} = "OFF";
use Text::Wrap;
use File::Temp;
=head1 UNIVERSAL METHODS
These methods are supplied by a hidden base class.
=cut
package _Base;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = {};
bless ($self , $class);
return $self;
}
=over
=item
B<get_classname>
Returns classname of object.
=cut
sub get_classname { Scalar::Util::blessed( $_[0] ); }
=item
B<_is_valid_value>
Default method for determining validity of simple (scalar) user input. Checks that value is defined and not an empty string and not filled with whitespace.
Is overridden by derived classes with more stringent input requirements.
=cut
sub _is_valid_value {
if ( defined( $_[1] ) && ( $_[1] ne "" ) && ( not $_[1] =~ /^\s+$/ ) ) {
1;
} else {
print "Invalid value. Sorry, please try again.\n";
0;
}
}
=item
B<_input_choice>
User selects from a menu.
Returns user's selection.
Parameters: (0 = class), 1 = prompt, 2... = options.
Common usage:
my $value = undef;
while ( 1 ) {
$value = $self->_input_choice( "Select value:" , <@list> );
if ( $value ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
=cut
sub _input_choice {
my $self = shift;
Term::Clui::choose( shift , @_ );
}
=item
B<_input_ask>
User enters a value.
Returns user's input.
Parameters: (0 = class), 1 = prompt, 2 = default.
Common usage:
my $value = undef;
while ( 1 ) {
$value = $self->_input_ask( "Enter value:" , <$default> );
if ( $self->_is_valid_value( $value ) ) { last; }
}
=cut
sub _input_ask { Term::Clui::ask( $_[1] , $_[2] ); }
=item
B<_input_confirm>
User is asked a question to which s/he answers y/n.
Returns boolean.
Parameters: (0 = class), 1 = question.
Note: If multi-line question, then after answer only the first line is left on screen. The first line should be a short question with subsequent lines holding further information.
Common usage:
if (_input_confirm( "Short question?\n\nMore\nmulti-line\ntext." ) ) {
# do stuff
}
=cut
sub _input_confirm { Term::Clui::confirm( $_[1] ); }
=item
B<_display>
Displays screen text with word wrapping.
Parameters: (0 = class), 1 = display string.
Common usage:
_display( <$scalar> );
=cut
sub _display { print Text::Wrap::wrap( "" , "" , $_[1] . "\n" ); }
=item
B<_view>
Displays large volume of text in default editor and then returns viewer to original screen.
Parameters: (0 = class), 1 = title , 2 = help text.
Common usage:
_view( <$title> , <$help_text> );
=cut
sub _view {
my ( $self , $title , $body ) = ( shift , shift , shift );
my $text = "\n"
. $title
. "\n\n"
. "[This text should be displaying in your default editor.\n"
. " If no default editor is specified, vi(m) is used.\n"
. " To exit this screen, exit the editor as you normally would"
. " - 'ZQ' for vi(m).]"
. "\n\n"
. $body;
Term::Clui::edit( $title , $text );
}
=item
B<_entitize>
Takes string and replaces '&', '<' and '>' with xml entity equivalents.
=back
=cut
sub _entitize {
my ( $self , $string ) = ( shift , shift );
if ( $string ) {
$string =~ s/&/&/g;
$string =~ s/&/&/g;
$string =~ s/</</g;
$string =~ s/</</g;
$string =~ s/>/>/g;
$string =~ s/>/>/g;
}
return $string;
}
=head1 ATTRIBUTE CLASSES
These classes model the XML attributes found in the Refdb C<citestylex> DTD.
=head2 Attributes: Public Interface
=cut
package _Attribute;
use base qw/ _Base /;
=head3 Attributes: Data Members
%self = (
name => "ATTRIBUTE" ,
enumeration => [ "value_0" , "value_1" , ... ] ,
default => "value_x" ,
prompt => "This is the purpose and/or use of the attribute." ,
value => "User selected/entered value>" ,
summary => 0 | 1 ,
)
=cut
# Constructor
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
=over
=item
B<name>
Attribute name as per the Refdb C<citestylex> DTD. Always uppercase.
=cut
$self->{name} = $class->default_name();
=item
B<enumeration>
List of possible values for attribute. If empty then attribute takes user-entered value, eg. DISPLAYAUTHOR, which takes a number.
=cut
$self->{enumeration} = $class->default_enumeration();
=item
B<default>
The default value. If C<enumeration> is present, the default will always be one of the items in it. If no default then leave as C<undef> -- this is the 'default' value after object construction.
=cut
$self->{default} = $class->default_default();
=item
B<prompt>
The text string that is used by client methods to prompt users when entering data.
=cut
$self->{prompt} = $class->default_prompt();
=item
B<summary>
Boolean determining whether attribute is included in summary form.
=cut
$self->{summary} = $class->default_summary();
=item
B<value>
The attribute value as selected or input by the user.
=back
=cut
$self->{value} = $class->default_value();
=head3 Attributes: Constructors
In following method signatures replace ATTRIBUTE with the relevant attribute class name.
Some attributes have a maximum number of instances that can exist within a given PubType (see method I<select_value> below). When a class is asked to create an object in excess of the designed maximum for that class the constructor returns a scalar holding an error message. This enables a simple test (using C<ref> function) to determine whether the constructor returned an object/blessed variable or scalar.
my $at = ATTRIBUTE->new();
=cut
return $self;
}
# Default values (abstract)
sub default_name { undef; }
sub default_default { undef; }
sub default_prompt { undef; }
sub default_enumeration { undef; }
sub default_summary { 0; }
sub default_value { undef; }
=head3 Attributes: Setters
$at->set_name ( "<name>" );
$at->set_default ( "<default>" );
$at->set_prompt ( "<prompt>" );
$at->add_enumeration ( LIST );
$at->set_summary ( 0 | 1 );
=cut
sub set_name { $_[0]->{name} = $_[1]; }
sub set_default { $_[0]->{default} = $_[1]; }
sub set_prompt { $_[0]->{prompt} = $_[1]; }
sub add_enumeration { push @{ $_[0]->{enumeration} } , @_[1..$#_]; }
sub set_summary { $_[0]->{summary} = $_[1]; }
sub _set_value { $_[0]->{value} = $_[1]; }
=head3 Attributes: Getters
$at->get_name();
$at->get_default();
$at->get_prompt();
$at->get_enumeration(); # returns list with default value first
$at->get_enum_string(); # returns single text string
$at->get_summary();
$at->get_value();
=cut
sub get_name { $_[0]->{name}; }
sub get_default { $_[0]->{default}; }
sub get_prompt { $_[0]->{prompt}; }
sub get_value { $_[0]->{value}; }
sub get_summary { $_[0]->{summary}; }
sub get_enumeration { # puts default value first
my $self = shift;
if ( defined( $self->{enumeration} ) ) {
my $default = $self->get_default();
my @enum = grep /\b$default\b/ , @{ $self->{enumeration} };
push( @enum, grep( $_ ne $default , @{ $self->{enumeration} } ) );
return @enum;
} else {
return undef;
}
}
sub get_enum_string { defined( $_[0]->{enumeration} ) ? "@{ $_[0]->{enumeration} }" : undef; }
=head3 Attributes: Other methods
=over
=item
B<$at-E<gt>select_value();>
If enumeration exists then user selects from list. The default is always the first option in the list.
If there is no enumeration the user enters the value directly. The default value is given and can be selected by simply pressing C<Enter>.
Some attributes are set automatically depending on how many objects of this class have been created. In those classes this method has no effect. This applies to the I<Role_AuthorList>, I<Role_PubDate>, I<Role_Title>, I<Role_UserDef>, I<Role_Link> and I<Role_Misc> classes.
The C<citestylex> DTD design envisages a maximum number of objects of these classes being constructed -- the number varying between 3 and 5 depending on the class. See L</"Attributes: Constructors"> for what happens when the class is asked to create an object in excess of the designed maximum.
=cut
sub select_value {
my $self = shift;
print "Attribute: " . $self->get_name() . "\n";
$self->_display( $self->get_prompt() );
my $value = undef;
if ( defined ( $self->get_enumeration() ) ) { # choose from enum list
if ( scalar( $self->get_enumeration() ) == 0 ) { return undef; }
while ( 1 ) {
$value = $self->_input_choice( "Select value:" , $self->get_enumeration() );
if ( defined( $value ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
} else { # enter value directly
while ( 1 ) {
$value = $self->_input_ask( "Enter value:" , $self->get_default() );
if ( $self->_is_valid_value( $value ) ) { last; }
}
$value = $self->_entitize( $value );
}
$self->{value} = $value;
}
=item
B<$at-E<gt>get_xml_fragment();>
Returns minimal xml fragment indicating the attribute name and value:
ATTRIBUTE="VALUE"
=back
=cut
sub get_xml_fragment {
sprintf "%s=\"%s\"" ,
$_[0]->get_name() ,
defined( $_[0]->get_value() ) ? $_[0]->get_value() : "";
}
=head2 Attributes: List of Classes
To see a list of attribute classes use the C<document-dtd-entities> utility that shipped with this program. It extracts attribute and element properties from this script, assembles and formats them into a single html document.
=cut
package Type_PubType;
use base qw/ _Attribute /;
our %_level = (
"ABST" => 0 ,
"ADVS" => 0 ,
"ART" => 0 ,
"BILL" => 0 ,
"BOOK" => 0 ,
"CASE" => 0 ,
"CHAP" => 0 ,
"COMP" => 0 ,
"CONF" => 0 ,
"CTLG" => 0 ,
"DATA" => 0 ,
"ELEC" => 0 ,
"GEN" => 0 ,
"ICOMM" => 0 ,
"INPR" => 0 ,
"JFULL" => 0 ,
"JOUR" => 0 ,
"MAP" => 0 ,
"MGZN" => 0 ,
"MPCT" => 0 ,
"MUSIC" => 0 ,
"NEWS" => 0 ,
"PAMP" => 0 ,
"PAT" => 0 ,
"PCOMM" => 0 ,
"RPRT" => 0 ,
"SER" => 0 ,
"SLIDE" => 0 ,
"SOUND" => 0 ,
"STAT" => 0 ,
"THES" => 0 ,
"UNBILL" => 0 ,
"UNPB" => 0 ,
"VIDEO" => 0 ,
);
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "TYPE" );
$self->add_enumeration( qw/ ABST ADVS ART BILL BOOK CASE CHAP COMP CONF CTLG DATA ELEC GEN ICOMM INPR JFULL JOUR MAP MGZN MPCT MUSIC NEWS PAMP PAT PCOMM RPRT SER SLIDE SOUND STAT THES UNBILL UNPB VIDEO / );
$self->set_default ( "GEN" );
$self->set_prompt ( "The type of reference. Here is a summary (see manual for more detail): GEN (default style -- you really should include this one!), ABST (abstract), ADVS (audiovisual material), ART (art work), BILL (resolution/bill), BOOK (whole book), CASE (case), CHAP (book chapter), COMP (computer program), CONF (conference proceeding), CTLG (catalog), DATA (data file), ELEC (electronic citation), HEAR (hearing), ICOMM (internet communication), INPR (in press), JFULL (entire journal/periodical), JOUR (journal/periodical article), MAP (map), MGZN (magazine), MPCT (motion picture), MUSIC (music score), NEWS (newspaper), PAMP (pamphlet), PAT (patent), PCOMM (personal communication), RPRT (report), SER (serial--book, monograph), SLIDE (slide), SOUND (sound recording), STAT (statute), THES (thesis/dissertation), UNBILL (unenacted bill/resolution), UNPB (unpublished), VIDEO (video recording)");
$self->set_summary( 1 );
$self->_assign_level(); # Class-specific
return defined( $self->get_value() ) ? $self : "Error: Maximum number of " . $self->get_name() . " attributes already exist for element PUBTYPE.";
return $self;
}
# Class-specific
sub _assign_level {
my ( $self , $value ) = ( shift , undef );
if ( scalar( $self->get_enumeration() ) != 0 ) {
print "Attribute: " . $self->get_name() . "\n";
print $self->_display( $self->get_prompt() );
while ( 1 ) {
$value = $self->_input_choice( "Select value: " , $self->get_enumeration() );
if ( defined( $value ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
$_level{$value} = 1;
$self->{value} = $value;
}
}
sub DESTROY { if ( $_[0]->get_value() ) { $_level{$_[0]->get_value()} = 0 ; } }
sub select_value { }
sub get_enumeration {
my ( $self , @enum , $key , $value ) = ( shift );
while ( ( $key , $value ) = each %_level ) {
if ( not ( $_level{$key} ) ) { push( @enum , $key ); }
}
my ( $default , @ordered_array ) = ( $self->get_default() );
if ( grep /\b$default\b/ , @enum ) {
@ordered_array = grep /\b$default\b/ , @enum;
push( @ordered_array, grep( $_ ne $default , @enum ) );
@enum = @ordered_array;
}
return @enum;
}
package Type_PageRange;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "TYPE" );
$self->add_enumeration( qw/ ABBREV CHICAGO FULL STARTONLY TWODIGIT / );
$self->set_default ( "FULL" );
$self->set_prompt ( "Default = \"FULL\".\nDetermines how a page range is displayed. Assuming a page range of 3336-3339, the various options result in -- ABBREV: '3336-9', CHICAGO: '3336-3339', FULL: '3336-3339', STARTONLY: '3336' and TWODIGIT: '3336-39'." );
return $self;
}
package Style;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "STYLE" );
$self->add_enumeration( qw/ BOLD BOLDITALIC BOLDITULINE BOLDULINE ITALIC ITULINE NONE SUB SUPER ULINE / );
$self->set_default ( "NONE" );
$self->set_prompt ( "Sets the style of displayed text. Options -- BOLD = bold, BOLDITALIC = bold italic, BOLDITULINE = bold italic underlined, BOLDULINE = bold underlined, ITALIC = italic, ITULINE = italic underlined, NONE = no special formatting, SUB = subscript, SUPER = superscript and ULINE = underlined." );
return $self;
}
package AlternateStyle;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ALTERNATESTYLE" );
$self->add_enumeration( qw/ ABOLD ABOLDITALIC ABOLDITULINE ABOLDULINE AITALIC AITULINE ASUB ASUPER AULINE NONE / );
$self->set_default ( "NONE" );
$self->set_prompt ( "Warning: Not currently implemented.\nSome author-date bibliographic styles use title instead of author when there is no author specified. This attribute determines the style of the title when it is used this way. Options -- ABOLD = bold, ABOLDITALIC = bold italic, ABOLDITULINE = bold italic underlined, ABOLDULINE = bold underlined, AITALIC = italic, AITULINE = italic underlined, ASUB = subscript, ASUPER = superscript, AULINE = underlined and ANONE = no special formatting." );
return $self;
}
package Role_AuthorList;
use base qw/ _Attribute /;
our %_level = (
"1" => "PRIMARY" ,
"2" => "SECONDARY" ,
"3" => "TERTIARY" ,
);
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ROLE" );
$self->add_enumeration( qw/ PRIMARY SECONDARY TERTIARY / );
$self->set_default ( "PRIMARY" );
$self->set_prompt ( "Determines which 'level' of author the enclosing element refers to." );
$self->set_summary( 1 );
++ $_level{"level"}; # Class-specific
$self->_assign_level(); # Class-specific
return defined( $self->get_value() ) ? $self : "Error: Maximum number of " . $self->get_name() . " attributes already exist for element AUTHORLIST.";
}
# Class-specific
sub _assign_level { $_[0]->{value} = $_level{ $_level{"level"} }; }
sub DESTROY { -- $_level{"level"}; }
sub select_value { }
sub reset_counter { $_level{"level"} = 0; }
package Role_PubDate;
use base qw/ _Attribute /;
our %_level = (
"1" => "PRIMARY" ,
"2" => "SECONDARY" ,
);
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ROLE" );
$self->add_enumeration( qw/ PRIMARY SECONDARY / );
$self->set_default ( "PRIMARY" );
$self->set_prompt ( "Determines which 'level' of publication date the enclosing element refers to." );
$self->set_summary( 1 );
++ $_level{"level"}; # Class-specific
$self->_assign_level(); # Class-specific
return defined( $self->get_value() ) ? $self : "Error: Maximum number of " . $self->get_name() . " attributes already exist for element PUBDATE.";
}
# Class-specific
sub _assign_level { $_[0]->{value} = $_level{ $_level{"level"} }; }
sub DESTROY { -- $_level{"level"}; }
sub select_value { }
sub reset_counter { $_level{"level"} = 0; }
package Role_Title;
use base qw/ _Attribute /;
our %_level = (
"1" => "PRIMARY" ,
"2" => "SECONDARY" ,
"3" => "TERTIARY" ,
);
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ROLE" );
$self->add_enumeration( qw/ PRIMARY SECONDARY TERTIARY / );
$self->set_default ( "PRIMARY" );
$self->set_prompt ( "Determines which 'level' of title the enclosing element refers to." );
$self->set_summary( 1 );
++ $_level{"level"}; # Class-specific
$self->_assign_level(); # Class-specific
return defined( $self->get_value() ) ? $self : "Error: Maximum number of " . $self->get_name() . " attributes already exist for element TITLE.";
}
# Class-specific
sub _assign_level { $_[0]->{value} = $_level{ $_level{"level"} }; }
sub DESTROY { -- $_level{"level"}; }
sub select_value { }
sub reset_counter { $_level{"level"} = 0; }
package Role_UserDef;
use base qw/ _Attribute /;
our %_level = (
"1" => 0 ,
"2" => 0 ,
"3" => 0 ,
"4" => 0 ,
"5" => 0 ,
);
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ROLE" );
$self->add_enumeration( qw/ 1 2 3 4 5 / );
$self->set_default ( "1" );
$self->set_prompt ( "Determines which user-defined field (U1 - U5) the enclosing element refers to. Each possible option can be used in only one attribute." );
$self->set_summary( 1 );
$self->_assign_level(); # Class-specific
return defined( $self->get_value() ) ? $self : "Error: Maximum number of " . $self->get_name() . " attributes already exist for element USERDEF.";
}
# Class-specific
sub _assign_level {
my ( $self , $value ) = ( shift , undef );
if ( scalar( $self->get_enumeration() ) != 0 ) {
print "Attribute: " . $self->get_name() . "\n";
print $self->_display( $self->get_prompt() );
while ( 1 ) {
$value = $self->_input_choice( "Select value: " , sort( $self->get_enumeration() ) );
if ( defined( $value ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
$_level{$value} = 1;
$self->{value} = $value;
}
}
sub DESTROY { if ( $_[0]->get_value() ) { $_level{$_[0]->get_value()} = 0 ; } }
sub select_value { }
sub get_enumeration {
my ( @enum , $key , $value ) = ( () );
while ( ( $key , $value ) = each %_level ) {
if ( not ( $_level{$key} ) ) { push( @enum , $key ); }
}
return @enum;
}
sub reset_counter { foreach ( keys %_level ) { $_level{$_} = 0; } }
package Role_Misc;
use base qw/ _Attribute /;
our %_level = (
"1" => 0 ,
"2" => 0 ,
"3" => 0 ,
);
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ROLE" );
$self->add_enumeration( qw/ 1 2 3 / );
$self->set_default ( "1" );
$self->set_prompt ( "Determines which miscellaneous field (M1 - M5) the enclosing element refers to. Each possible option can be used in only one attribute." );
$self->set_summary( 1 );
$self->_assign_level();
return defined( $self->get_value() ) ? $self : "Error: Maximum number of " . $self->get_name() . " attributes already exist for element MISC.";
}
# Class-specific
sub _assign_level {
my ( $self , $value ) = ( shift , undef );
if ( scalar( $self->get_enumeration() ) != 0 ) {
print "Attribute: " . $self->get_name() . "\n";
print $self->_display( $self->get_prompt() );
while ( 1 ) {
$value = $self->_input_choice( "Select value: " , sort( $self->get_enumeration() ) );
if ( defined( $value ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
$_level{$value} = 1;
$self->{value} = $value;
}
}
sub DESTROY { if ( $_[0]->get_value() ) { $_level{$_[0]->get_value()} = 0 ; } }
sub select_value { }
sub get_enumeration {
my ( @enum , $key , $value ) = ( () );
while ( ( $key , $value ) = each %_level ) {
if ( not ( $_level{$key} ) ) { push( @enum , $key ); }
}
return @enum;
}
sub reset_counter { foreach ( keys %_level ) { $_level{$_} = 0; } }
package Role_Link;
use base qw/ _Attribute /;
our %_level = (
"0" => 0 ,
"1" => 0 ,
"2" => 0 ,
"3" => 0 ,
"4" => 0 ,
);
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ROLE" );
$self->add_enumeration( qw/ 0 1 2 3 4 / );
$self->set_default ( "0" );
$self->set_prompt ( "Determines which link field the enclosing element refers to: 1-4 correspond to L1-L4, 0 corresponds to UR. Each possible option can be used in only one attribute." );
$self->set_summary( 1 );
$self->_assign_level();
return defined( $self->get_value() ) ? $self : "Error: Maximum number of " . $self->get_name() . " attributes already exist for element LINK.";
}
# Class-specific
sub _assign_level {
my ( $self , $value ) = ( shift , undef );
if ( scalar( $self->get_enumeration() ) != 0 ) {
print "Attribute: " . $self->get_name() . "\n";
print $self->_display( $self->get_prompt() );
while ( 1 ) {
$value = $self->_input_choice( "Select value: " , sort( $self->get_enumeration() ) );
if ( defined( $value ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
$_level{$value} = 1;
$self->{value} = $value;
}
}
sub DESTROY { if ( $_[0]->get_value() ) { $_level{$_[0]->get_value()} = 0 ; } }
sub select_value { }
sub get_enumeration {
my ( @enum , $key , $value ) = ( () );
while ( ( $key , $value ) = each %_level ) {
if ( not ( $_level{$key} ) ) { push( @enum , $key ); }
}
return @enum;
}
sub reset_counter { foreach ( keys %_level ) { $_level{$_} = 0; } }
package DisplayAuthor;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "DISPLAYAUTHOR" );
# No enumeration
$self->set_default ( "255" );
$self->set_prompt ( "Used in conjunction with MAXAUTHOR. If the number of authors exceeds MAXAUTHOR then only the first DISPLAYAUTHOR number of authors are shown. To show all authors always, select a large number, ie. the default." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\d+$/ ) { # digits only
1;
} else {
print "Invalid number. Sorry, please try again.\n";
0;
}
}
package MaxAuthor;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "MAXAUTHOR" );
# No enumeration
$self->set_default ( "256" );
$self->set_prompt ( "Used in conjunction with DISPLAYAUTHOR. If the number of authors exceeds MAXAUTHOR then only the first DISPLAYAUTHOR number of authors are shown. To show all authors always, select a large number, ie. the default." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\d+$/ ) { # digits only
1;
} else {
print "Invalid number. Sorry, please try again.\n";
0;
}
}
package UpperCase;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "UPPERCASE" );
$self->add_enumeration( qw/ ALL LASTNAME NONE / );
$self->set_default ( "NONE" );
$self->set_prompt ( "Default = \"NONE\".\nDetermines capitalisation of author names -- ALL: sur- and forenames changed to uppercase, LASTNAME: surnames only altered to uppercase and NONE: no alteration to case of author names." );
return $self;
}
package InitialStyle;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "INITIALSTYLE" );
$self->add_enumeration( qw/ F.M. F.SPCM. FIRSTSPCM. FIRSTSPCMIDDLE FM FSPCM / );
$self->set_default ( "F.M." );
$self->set_prompt ( "Default = \"F.M.\".\nDetermines the format of author forenames. The various options will affect the layout of the forenames 'John Henry' thus -- F.M. = 'J.H.', F.SPCM. = 'J. H.', FIRSTSPCM. = 'John H.', FIRSTSPCMIDDLE = 'John Henry', FM = 'JH', FSPCM = 'J H'." );
return $self;
}
package NameOrder;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "NAMEORDER" );
$self->add_enumeration( qw/ FIRSTMIDDLELAST LAST LASTCOMMAFIRSTMIDDLE LASTFIRSTMIDDLE LASTCOMMASPCFIRSTMIDDLE / );
$self->set_default ( "LASTFIRSTMIDDLE" );
$self->set_prompt ( "Default = \"LASTFIRSTMIDDLE\".\nDetermines how the surname is layed out in relation to the forenames. This attribute treats the forenames as an atomic whole -- formatting of the forenames is controlled by the attribute 'INITIALSTYLE' (in the following examples INITIALSTYLE is set to 'FM', ie. 'JH'). The various options for NAMEORDER will affect the layout of the name 'Citizen, John Henry' thus -- LASTFIRSTMIDDLE = 'Smith JH', FIRSTMIDDLELAST = 'JH Citizen', LAST = 'Citizen', LASTCOMMAFIRSTMIDDLE = 'Citizen,JH', LASTCOMMASPCFIRSTMIDDLE = 'Citizen, JH'." );
return $self;
}
package Sequence;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "SEQUENCE" );
$self->add_enumeration( qw/ DMY MDY MY Y YMD / );
$self->set_default ( "Y" );
$self->set_prompt ( "Default = \"Y\".\nDetermines which date elements are displayed, and in what order. Unsurprisingly, Y = year, M = month and D = day." );
return $self;
}
package Format;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FORMAT" );
$self->add_enumeration( qw/ NO YES / );
$self->set_default ( "YES" );
$self->set_prompt ( "Default = \"YES\".\nDetermines whether the associated publication date will be formatted. If set to 'YES', date format is determined by attributes SEQUENCE, YEARFORMAT, MONTHFORMAT, PADLEADINGZERO and DAYFORMAT. If set to 'NO', date format defaults to a fourdigit year (eg. '2001') and the aforementioned date formatting attributes are ignored." );
return $self;
}
package YearFormat;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "YEARFORMAT" );
$self->add_enumeration( qw/ FOURDIGIT ROMANYEAR TWODIGIT / );
$self->set_default ( "FOURDIGIT" );
$self->set_prompt ( "Default = \"FOURDIGIT\".\nDetermines format of year element of publication date. Has effect only if FORMAT = 'YES'. Options will format the year '2001' thus: FOURDIGIT = '2001', ROMANYEAR = 'MMI' and TWODIGIT = '01'." );
return $self;
}
package MonthFormat;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "MONTHFORMAT" );
$self->add_enumeration( qw/ ABBREVDOT ARABICMONTH FULL ROMANMONTH THREELETTER / );
$self->set_default ( "ARABICMONTH" );
$self->set_prompt ( "Default = \"ARABICMONTH\".\nDetermines the format of the month part of the publication date. Has effect only if FORMAT = 'YES'. The values displayed by the options THREELETTER, ABBREVDOT and FULL are those defined in the corresponding THREELET, ABBREV and FULL attributes, respectively, of the elements JAN, FEB ... NOV, DEC. The remaining options will format 'October' thus: ARABICMONTH = '10' and ROMANMONTH = 'X'. Note that ROMANMONTH uses uppercase characters." );
return $self;
}
package PadLeadingZero;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "PADLEADINGZERO" );
$self->add_enumeration( qw/ NN YY / );
$self->set_default ( "NN" );
$self->set_prompt ( "Default = \"NN\".\nDetermines whether the month and day parts of the publication date are shown with a leading zero when they are < 10." );
return $self;
}
package DayFormat;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "DAYFORMAT" );
$self->add_enumeration( qw/ ARABICDAY ROMANDAY / );
$self->set_default ( "ARABICDAY" );
$self->set_prompt ( "Default = \"ARABICDAY\".\nDetermines the format of the day part of publication date. These options will format the day '10' thus: ARABICDAY = '10' and ROMANDAY = 'x'. Note that ROMANDAY uses lower case characters." );
return $self;
}
package Case;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "CASE" );
$self->add_enumeration( qw/ ASIS ICAPS LOWER UPPER / );
$self->set_default ( "ASIS" );
$self->set_prompt ( "Default = \"ASIS\".\nDetermines the case of content in the enclosing element. The various options render 'This text' thus: ASIS = 'This text', ICAPS = 'This Text', LOWER = 'this text' and UPPER = 'THIS TEXT'." );
return $self;
}
package AlternateText_AuthorList;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ALTERNATETEXT" );
$self->add_enumeration( qw/ AEMPTY NONE TITLEPRIMARY TITLESECONDARY TITLETERTIARY / );
$self->set_default ( "AEMPTY" );
$self->set_prompt ( "Warning: Not currently implemented.\nDefault = \"AEMPTY\".\nSome author-year styles use title instead of author when the author is not specified. This attribute determines what value to use instead of author when there is no author. Options -- AEMPTY = use value specified by element AEMPTY, NONE = author left blank, TITLEPRIMARY = use primary title, TITLESECONDARY = use secondary title and TITLETERTIARY = use tertiary title." );
return $self;
}
package AlternateText_JournalName;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ALTERNATETEXT" );
$self->add_enumeration( qw/ AABBREV AFULL AUSERONE AUSERTWO / );
$self->set_default ( "AFULL" );
$self->set_prompt ( "Default = \"AFULL\".\nDetermines, in conjunction with DEFAULTTEXT, which field to use for journal name -- if field specified by DEFAULTTEXT is empty, refdb tries to use field specified by this attribute. The options refer to the following fields: AABBREV = 'JO', AFULL = 'JF', AUSERONE = 'J1', AUSERTWO = 'J2'." );
return $self;
}
package DefaultText;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "DEFAULTTEXT" );
$self->add_enumeration( qw/ ABBREV FULL USERONE USERTWO / );
$self->set_default ( "ABBREV" );
$self->set_prompt ( "Default = \"ABBREV\".\nIndicates which field refdb should retrieve the journal name from. Note: if the specified field is empty for a given record, refdb will try to use the field specified by ALTERNATETEXT. The options refer to the following fields: ABBREV = 'JO', FULL = 'JF', USERONE = 'J1', USERTWO = 'J2'." );
return $self;
}
package Punctuation;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "PUNCTUATION" );
$self->add_enumeration( qw/ PERIOD PERIODSPACE SPACE / );
$self->set_default ( "SPACE" );
$self->set_prompt ( "Default = \"SPACE\".\nControls formatting of the abbreviated journal name (field 'JO'). The options will format the abbreviated journal name 'J Some.Journal' thus: PERIOD = 'J.Some.Journal', PERIODSPACE = 'J. Some. Journal', SPACE = 'J Some Journal'. Note: The character immediately following the last part of the journal abbreviation is determined by the FOLLOWING element associated with the JOURNALNAME element." );
return $self;
}
package BiblioFirstIndent;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "BIBLIOFIRSTINDENT" );
# $self->add_enumeration( qw/ BASIS BAUTHORDATE BDATEASC BDATEDESC / );
# $self->set_default ( "BAUTHORDAT" );
$self->set_prompt ( "Sets indent of the first line of each bibliography entry. Is cumulative with value set for BIBLIOBLOCKINDENT. Can be negative. Units must be included. Absolute units: 'cm' (centimetres), 'in' (inches), 'mm' (millimetres), 'pc' (picas) or 'pt' (points). Relative units: '%' (of total width), 'em' (ems, relative to font size) or 'px' (pixels, relative to canvas resolution). Examples: '5em' and '-3%'." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^-?\d+\.?\d*(cm|em|in|mm|pc|px|pt|%)$/ ) { # decimal number followed by units
1;
} else {
print "Invalid value. Sorry, please try again.\n";
0;
}
}
package BiblioSequence;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "BIBLIOSEQUENCE" );
$self->add_enumeration( qw/ BASIS BAUTHORDATE BDATEASC BDATEDESC / );
$self->set_default ( "BAUTHORDATE" );
$self->set_prompt ( "Default = \"BAUTHORDATE\".\nDetermines the order of references in bibliography. The options are: BASIS = same order as citations appear in document, BAUTHORDATE = sort on author then date, BDATEASC = sort on date ascending and BDATEDESC = sort on date descending." );
return $self;
}
package BiblioBlockIndent;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "BIBLIOBLOCKINDENT" );
# $self->add_enumeration( qw/ BASIS BAUTHORDATE BDATEASC BDATEDESC / );
# $self->set_default ( "BAUTHORDAT" );
$self->set_prompt ( "Sets indent of the whole bibliography. Can be negative. Units must be included. Absolute units: 'cm' (centimetres), 'in' (inches), 'mm' (millimetres), 'pc' (picas) or 'pt' (points). Relative units: '%' (of total width), 'em' (ems, relative to font size) or 'px' (pixels, relative to canvas resolution). Examples: '5em' and '-3%'." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^-?\d+\.?\d*(cm|em|in|mm|pc|px|pt|%)$/ ) { # decimal number followed by units
1;
} else {
print "Invalid value. Sorry, please try again.\n";
0;
}
}
package FontSize;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FONTSIZE" );
# $self->add_enumeration( qw/ BASIS BAUTHORDATE BDATEASC BDATEDESC / );
# $self->set_default ( "BAUTHORDAT" );
$self->set_prompt ( "Sets font size of bibliography. Absolute sizes: 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large' or 'xx-large'. Relative sizes: 'smaller' or 'larger'. Numeric sizes cannot be negative. Numeric absolute units: 'in' (inches), 'cm' (centimetres), 'mm' (millimetres), 'pt' (points) or 'pc' (picas). Numeric relative units: 'em' (ems, relative to parent font), 'px' (pixels, relative to canvas resolution) or '%' (relative to parent font). If a number is used without units it is a relative multiplier of the parent font (acts as if 'em' units specified). Examples: 'x-small', 'larger', '0.8cm', '5em' and '0.8'." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^(((x?x-)?(small|large))|smaller|larger|\d+\.?\d*(cm|em|in|mm|pc|px|pt|%)?)$/ ) { # see prompt for explanation
1;
} else {
print "Invalid value. Sorry, please try again.\n";
0;
}
}
package InTextSequence;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "INTEXTSEQUENCE" );
$self->add_enumeration( qw/ ASIS AUTHORDATE DATEASC DATEDESC / );
$self->set_default ( "AUTHORDATE" );
$self->set_prompt ( "Default = \"AUTHORDATE\".\nDetermines the order of citations in multiple citations. The options are: ASIS = same order as citations appear in document, AUTHORDATE = sort on author then date, DATEASC = sort on date ascending and DATEDESC = sort on date descending." );
return $self;
}
package Threelet_Jan;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Jan" );
$self->set_prompt ( "Three letter abbreviation for the first month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Feb;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Feb" );
$self->set_prompt ( "Three letter abbreviation for the second month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Mar;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Mar" );
$self->set_prompt ( "Three letter abbreviation for the third month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Apr;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Apr" );
$self->set_prompt ( "Three letter abbreviation for the fourth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_May;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "May" );
$self->set_prompt ( "Three letter abbreviation for the fifth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Jun;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Jun" );
$self->set_prompt ( "Three letter abbreviation for the sixth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Jul;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Jul" );
$self->set_prompt ( "Three letter abbreviation for the seventh month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Aug;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Aug" );
$self->set_prompt ( "Three letter abbreviation for the eighth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Sep;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Sep" );
$self->set_prompt ( "Three letter abbreviation for the ninth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Oct;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Oct" );
$self->set_prompt ( "Three letter abbreviation for the tenth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Nov;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Nov" );
$self->set_prompt ( "Three letter abbreviation for the eleventh month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Threelet_Dec;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "THREELET" );
# No enumeration
$self->set_default ( "Dec" );
$self->set_prompt ( "Three letter abbreviation for the twelfth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^[a-zA-Z][a-zA-Z][a-zA-Z]$/ ) { # three letters only
1;
} else {
print "Invalid three letter abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Jan;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Jan." );
$self->set_prompt ( "Abbreviation for the first month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Feb;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Feb." );
$self->set_prompt ( "Abbreviation for the second month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Mar;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Mar." );
$self->set_prompt ( "Abbreviation for the third month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Apr;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Apr." );
$self->set_prompt ( "Abbreviation for the fourth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_May;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "May" );
$self->set_prompt ( "Abbreviation for the fifth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Jun;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Jun." );
$self->set_prompt ( "Abbreviation for the sixth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Jul;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Jul." );
$self->set_prompt ( "Abbreviation for the seventh month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Aug;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Aug." );
$self->set_prompt ( "Abbreviation for the eighth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Sep;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Sep." );
$self->set_prompt ( "Abbreviation for the ninth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Oct;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Oct." );
$self->set_prompt ( "Abbreviation for the tenth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Nov;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Nov." );
$self->set_prompt ( "Abbreviation for the eleventh month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Abbrev_Dec;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "ABBREV" );
# No enumeration
$self->set_default ( "Dec." );
$self->set_prompt ( "Abbreviation for the twelfth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+\.?$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Jan;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "January" );
$self->set_prompt ( "Full spelling of the first month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Feb;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "February" );
$self->set_prompt ( "Full spelling of the second month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Mar;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "March" );
$self->set_prompt ( "Full spelling of the third month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Apr;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "April" );
$self->set_prompt ( "Full spelling of the fourth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_May;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "May" );
$self->set_prompt ( "Full spelling of the fifth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Jun;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "June" );
$self->set_prompt ( "Full spelling of the sixth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Jul;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "July" );
$self->set_prompt ( "Full spelling of the seventh month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Aug;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "August" );
$self->set_prompt ( "Full spelling of the eighth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Sep;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "September" );
$self->set_prompt ( "Full spelling of the ninth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Oct;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "October" );
$self->set_prompt ( "Full spelling of the tenth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Nov;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "November" );
$self->set_prompt ( "Full spelling of the eleventh month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
package Full_Dec;
use base qw/ _Attribute /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name ( "FULL" );
# No enumeration
$self->set_default ( "December" );
$self->set_prompt ( "Full spelling of the name of the twelfth month." );
return $self;
}
sub _is_valid_value {
if ( $_[1] =~ /^\w+$/ ) { # only letters, numbers and underscores
1;
} else {
print "Invalid abbreviation. Sorry, please try again.\n";
0;
}
}
=head1 ELEMENT CLASSES
These classes model the XML elements found in the Refdb C<citestylex> DTD.
=cut
package _Element;
use base qw/ _Base /;
=head2 Elements: Public Interface
=head3 Elements: Data members
%self = (
name => "ELEMENT" ,
prompt => "This is the purpose of this element." ,
help => "This is help on how to use this element." ,
display => undef | "name" | "content" ,
summary => undef | "name" | "left" | "right" | "content" ,
attributes => {
mandatory => [ "Attribute_Class_0" , "Attribute_Class_1" , ... ] ,
optional => [ "Attribute_Class_0" , "Attribute_Class_1" , ... ] ,
selected => [ "Attribute_0" , "Attribute_1" , ... ] ,
man_complete => undef | 1 ,
opt_complete => undef | 1 ,
} ,
copyable => 1 | undef ,
content => {
allowed => undef | 1 ,
suggestion => "Possible value" ,
value => "User input" ,
complete => undef | 1 ,
} ,
model_order => [
[ Element_Class_0 , "? | + | 1" ] ,
[ Element_Class_1 , "? | + | 1" ] ,
... ,
] ,
model_noorder => {
element_list => [ Element_Class_0 , Element_Class_1 , ... ] ,
separator => "Separator" ,
} ,
children => {
elements => [ Element_0 , Element_1 , ... ] ,
complete => boolean ,
)
=over
=cut
# Constructor
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = {};
=item
B<name>
Element name as given in the Refdb C<citestylex> DTD. Unique.
=cut
$self->{name} = $class->default_name();
=item
B<prompt>
Brief statement of the element's purpose and/or function.
=cut
$self->{prompt} = $class->default_prompt();
=item
B<help>
More detailed instructions on how to use this element.
=cut
$self->{help} = $class->default_help();
=item
B<display>
Determines whether, and how, to display the element in brief form (used for the "progress report". If defined, the element is displayed. If set to "name" the element name is displayed. If set to "content" the element contents are displayed.
=cut
$self->{display} = $class->default_display();
=item
B<summary>
Determines whether, and how, to display the element in summary form. If defined, the element is displayed. If set to "name" the element name is displayed. If set to "content" the element contents are displayed.
=cut
$self->{summary} = $class->default_summary();
=item
B<attributes>
Attributes of this element. First two lists are of 'legal' attributes: mandatory and optional. Third list is of added attribute objects -- initially empty. Fourth and fifth hash values are flags indicating whether attributes have been added.
=cut
$self->{attributes} = $class->default_attributes();
=item
B<content>
Some elements hold #PCDATA content. The hash key C<allowed> determines whether element accepts input -- I<false>/I<undef> means it does not, I<true> means it does. The hash key C<suggested> holds a suggested value the user may use. The hash key C<value> holds the actual user input. The hash key C<complete> is a flag indicating whether content has been entered.
=cut
$self->{content} = $class->default_content();
=item
B<copyable>
Some elements cannot be copied, either because they have mandatory attributes which require user input or because they only occur once per citstyle.
=cut
$self->{copyable} = $class->default_copyable();
=item
B<model_order>
With I<model_noorder> this data member determines the content model for children elements. All of the 64 elements fall into one of three content models regarding children elements: 1. No children elements, 2. An ordered list and 3. An unordered list.
This data member is C<undef> in cases (1) and (3).
It holds the content model for the thirty elements which have content model (2) -- an ordered list:
( e[?|+|1] , e[?|+|1] , ... )
where 'e' is the element and the symbols indicate 0-1, 1 or more, and exactly 1 occurrence, respectively.
This data member holds an array of arrays. Each secondary array has two items: the element class and the number of objects that can be children.
=cut
$self->{model_order} = $class->default_order();
=item
B<model_noorder>
With I<model_order> this data member determines the content model for children elements. All of the 64 elements fall into one of three content models regarding children elements: 1. No children elements, 2. An ordered list and 3. An unordered list.
This data member is C<undef> in cases (1) and (2).
It holds the content model for the four elements (AUTHORONLY, INTEXTDEF, PUBTYPE and YEARONLY) which have content model (3) -- an unordered list:
( ( e | e | ... ) , e? )+
where 'e' is an element, '?' is 0 or 1 occurrence and '+' is 1 or more occurrances.
This data member holds a hash where the first key points to an array holding the list of alterate elements in the content model inner brackets. The second key points to the element represented in the content model as 'e+' (in every case it is SEPARATOR).
=cut
$self->{model_noorder} = $class->default_noorder();
=item
B<children>
This data member holds a hash. The first hash key ("elements") points to an array holding the children elements added by the user. The second hash key ("complete") is a boolean indicating whether all children have been added.
=back
=cut
$self->{children} = $class->default_children();
=head3 Elements: Constructors
In following method signatures replace ELEMENT with the relevant element class name.
my $el = ELEMENT->new();
=cut
bless ($self , $class);
return $self;
}
# Default values (abstract)
sub default_name { undef; }
sub default_prompt { undef; }
sub default_help { undef; }
sub default_display { undef; }
sub default_summary { undef; }
sub default_attributes { undef; }
sub default_content { undef; }
sub default_copyable { 1; }
sub default_order { undef; }
sub default_noorder { undef; }
sub default_children { undef; }
=head3 Elements: Setters
$el->set_name( "<name>" );
$el->set_prompt( "<prompt>" );
$el->set_help( "<help>" );
$el->set_display( undef | "name" | "content" );
$el->set_summary( undef | "name" | "left" | "right" | "content" );
$el->set_attributes( %hash );
$el->set_mandatory_attributes_complete( "1" | undef );
$el->set_optional_attributes_complete( "1" | undef );
$el->set_content( %hash );
$el->set_content_complete( "1" | undef );
$el->set_order( @ArrayOfArrays );
$el->set_noorder( %hash );
$el->set_complete( "1" | "0" | undef );
$el->_set_value( "<value>" );
=cut
sub set_name { $_[0]->{name} = $_[1]; }
sub set_prompt { $_[0]->{prompt} = $_[1]; }
sub set_help { $_[0]->{help} = $_[1]; }
sub set_display { $_[0]->{display} = $_[1]; }
sub set_summary { $_[0]->{summary} = $_[1]; }
sub set_attributes { $_[0]->{attributes} = $_[1]; }
sub set_mandatory_attributes_complete {
$_[0]->{attributes}->{man_complete} = $_[1];
}
sub set_optional_attributes_complete {
$_[0]->{attributes}->{opt_complete} = $_[1];
}
sub set_content { $_[0]->{content} = $_[1]; }
sub set_content_complete { $_[0]->{content}->{complete} = $_[1]; }
sub set_order { $_[0]->{model_order} = $_[1]; }
sub set_noorder { $_[0]->{model_noorder} = $_[1]; }
sub set_complete { $_[0]->{children}->{complete} = $_[1]; }
sub _set_value { $_[0]->{content}->{value} = $_[1]; }
=head3 Elements: Getters
$el->get_name();
$el->get_prompt();
$el->get_help();
$el->get_display();
$el->get_summary();
$el->get_attr_mandatory(); # list: $self->{attributes}->{mandatory}
$el->get_attr_optional(); # list: $self->{attributes}->{optional}
$el->get_attr_selected(); # list: $self->{attributes}->{selected}
$el->get_suggestion(); # scalar: $self->{content}->{suggestion}
$el->get_value(); # scalar: $self->{content}->{value}
$el->get_order(); # AoA: $self->{model_order}
$el->get_noorder_list(); # list: $self->{model_noorder}->{element_list}
$el->get_noorder_separator; # scalar: $self->{model_noorder}->{separator}
$el->get_children(); # list: $self->{children}->{element}
$el->get_last_child(); # object: $self->{children}->{element}[<last>]
=cut
sub get_name { $_[0]->{name}; }
sub get_prompt { $_[0]->{prompt}; }
sub get_help { $_[0]->{help}; }
sub get_display { $_[0]->{display}; }
sub get_summary { $_[0]->{summary}; }
sub get_attr_mandatory {
defined( $_[0]->{attributes}->{mandatory} )
? @{ $_[0]->{attributes}->{mandatory} }
: undef;
}
sub get_attr_optional {
defined( $_[0]->{attributes}->{optional} )
? @{ $_[0]->{attributes}->{optional} }
: undef;
}
sub get_attr_selected {
defined( $_[0]->{attributes}->{selected} )
? @{ $_[0]->{attributes}->{selected} }
: undef;
}
sub get_suggestion { $_[0]->{content}->{suggestion}; }
sub get_value { $_[0]->{content}->{value}; }
sub get_order {
defined( $_[0]->{model_order} )
? @{ $_[0]->{model_order} }
: undef;
}
sub get_noorder_list {
defined( $_[0]->{model_noorder}->{element_list} )
? @{ $_[0]->{model_noorder}->{element_list} }
: undef;
}
sub get_noorder_separator { $_[0]->{model_noorder}->{separator}; }
sub get_children {
defined( $_[0]->{children}->{elements} )
? @{ $_[0]->{children}->{elements} }
: undef;
}
sub get_last_child {
my $self = shift;
return $self->{children}->{elements}[$self->max_child_index()];
}
=head3 Elements: Other methods
=over
=item
B<$el-E<gt>content_is_complete();>
Returns boolean indicating whether element content has been entered.
Indicated by a data member which is set after C<enter_value()> method called.
=cut
sub content_is_complete { return $_[0]->{content}->{complete}; }
=item
B<$el-E<gt>enter_value();>
User enters element value if element can legally hold one. User may be presented with a suggested value.
If the element cannot accept a value nothing happens -- no error message/value is generated.
=cut
sub enter_value {
my $self = shift;
return undef if not $self->is_content_allowed() or $self->content_is_complete();
$self->_display( "\nElement: " . $self->get_full_tag() . "\n" );
$self->_display( "\nEntering element value/content." );
print "\n";
$self->_display( $self->get_prompt() );
my $value = undef;
while ( 1 ) {
$value = $self->_input_ask( "Enter value:" , $self->get_suggestion() );
if ( $self->_is_valid_value( $value ) ) { last; }
}
$value = $self->_entitize( $value );
$self->_set_value( $value );
$self->set_content_complete( 1 );
}
=item
B<$el-E<gt>is_content_allowed();>
Returns boolean indicating whether the element can hold content.
=cut
sub is_content_allowed { $_[0]->{content}->{allowed}; }
=item
B<$el-E<gt>children_are_complete();>
Returns boolean indicating whether all children have been added.
Simply returns $self-E<gt>{children}-E<gt>{complete} and relies on other subroutines having set it appropriately.
=cut
sub children_are_complete { return $_[0]->{children}->{complete}; }
=item
B<$el-E<gt>max_attribute_index();>
Returns maximum index value of selected attributes list: -1 if empty list.
=cut
sub max_attribute_index { return $#{ $_[0]->{attributes}->{selected} }; }
=item
B<$el-E<gt>max_child_index();>
Returns maximum index value of element children list: -1 if empty list.
=cut
sub max_child_index { return $#{ $_[0]->{children}->{elements} }; }
=item
B<$el-E<gt>is_last_element();>
Determines whether element index is the last element in the list of children in the ordered child model: $self-E<gt>{model_order}.
Parameters: [ 0 = class ] , 1 = array index.
=cut
sub is_last_element { return ( $#{ $_[0]->{model_order} } == $_[1] ); }
=item
B<$el-E<gt>is_last_child();>
Determines whether child index is the last element in the list of children: $self-E<gt>{children}-E<gt>{elements}.
Parameters: [ 0 = class ] , 1 = array index.
=cut
sub is_last_child { return ( $#{ $_[0]->{children}->{elements} } == $_[1] ); }
=item
B<$el-E<gt>is_creatable();>
Returns a boolean indicating whether this element class can legally create another object.
Intended to be called as a class method.
=cut
sub is_creatable {
my ( $proto , $result ) = ( shift , 0 );
my $class = ref($proto) || $proto;
if ( ref( $proto ) ) {
print "Warning: This method ('is_creatable') may return an inaccurate result when called by an object (instance) rather than a class.\n";
}
{
my $element = $class->new();
if ( ref( $element ) ) {
if ( $element->_test_attributes_mandatory() ) {
$result = 1;
}
}
}
return $result;
}
=item
B<$el-E<gt>list_selectable_attributes();>
Returns a list of all optional attributes available for selection. List consists of all attributes listed in 'optional' list I<minus> all attributes already selected.
=cut
sub list_selectable_attributes {
my $self = shift;
my ( @attributes , @selected );
if ( $self->max_attribute_index() < 0 ) {
@attributes = $self->get_attr_optional();
} else {
my @optional = $self->get_attr_optional();
for ( 0 .. $self->max_attribute_index() ) {
push( @selected , $self->{attributes}->{selected}[$_]->get_classname() );
}
foreach my $opt ( @optional ) {
my @matches = grep $_ eq $opt , @selected;
if ( not @matches ) { push( @attributes , $opt ); }
}
}
return @attributes;
}
=item
B<$el-E<gt>_build_attribute_help();>
Helper method for method C<add_attributes_optional>. Takes as parameter a list of attributes for which help screen is being built. Includes C<name> and C<prompt> for each attribute.
=cut
sub _build_attribute_help {
my ( $self , @attributes , $help ) = ( shift , @_ );
foreach my $attribute ( @attributes ) {
$help .= $attribute->new()->get_name() . "\n";
$help .= $attribute->new()->get_prompt() . "\n\n";
}
return $help;
}
=item
B<$el-E<gt>has_mandatory_attributes();>
Returns boolean indicating whether element has mandatory attributes.
=cut
sub has_mandatory_attributes { return $_[0]->{attributes}->{mandatory}; }
=item
B<$el-E<gt>_is_closed_tag();>
Returns boolean indicating whether element can be represented by closed tag. Requires no possible child elements and no current content.
=cut
sub _is_closed_tag {
my ( $self , $closed ) = ( shift , 1 );
if ( not $self->is_childless_model() ) { $closed = 0; }
if ( $self->is_content_allowed() && defined( $self->get_value() ) ) { $closed = 0; }
return $closed;
}
=item
B<$el-E<gt>get_xml_brief_tag();>
Returns opening xml tag for element.
Shows only mandatory attributes.
=cut
sub get_xml_brief_tag {
my ( $self ) = ( shift );
my $tag = "<" . $self->get_name();
if ( $self->max_attribute_index() >= 0 && $self->has_mandatory_attributes() ) {
for ( 0 .. $self->max_attribute_index() ) {
my $att_name = $self->{attributes}->{selected}[$_]->get_classname();
if ( grep /$att_name/ , $self->get_attr_mandatory() ) {
$tag .= " " . $self->{attributes}->{selected}[$_]->get_xml_fragment();
}
}
}
$tag .= ">";
return $tag;
}
=item
B<$el-E<gt>get_xml_open_tag();>
Returns opening xml tag for element.
Parameters: [ 0 = class ] , 1 = show attributes (bool) , 2 = show content (bool).
Designed to be used in conjunction with C<get_xml_close_tag> method. If element has no potential child elements and no content, then will return closed tag, eg. E<lt>ELEMENT/E<gt>.
=cut
sub get_xml_open_tag {
my ( $self , $show_attributes , $show_contents ) = ( shift , shift , shift );
my $tag = "<" . $self->get_name();
if ( $show_attributes ) {
if ( $self->max_attribute_index() >= 0 ) {
for ( 0 .. $self->max_attribute_index() ) {
$tag .= " " . $self->{attributes}->{selected}[$_]->get_xml_fragment();
}
}
}
if ( $self->_is_closed_tag() ) {
$tag .= "/>";
} else {
$tag .= ">";
if ( $show_contents && $self->get_value() ) {
$tag .= $self->get_value();
}
}
return $tag;
}
=item
B<$el-E<gt>get_xml_close_tag();>
Returns closing xml tag for element.
Designed to be used in conjunction with C<get_xml_open_tag> method. If element has no potential child elements and no content, then will return no closing tag since C<get_xml_open_tag> will have returned a closed tag, eg. E<lt>ELEMENT/E<gt>.
=cut
sub get_xml_close_tag { $_[0]->_is_closed_tag() ? "" : "</" . $_[0]->get_name() . ">"; }
=item
B<$el-E<gt>generate_full_xml();>
Generates full xml for element.
Displays all attributes and element content. If no possible child elements and no current element content, will display closed tag, eg. E<lt>ELEMENT/E<gt>.
Method is recursive.
Parameters (receives): [ 0 = class ] , 1 = element count , 2 = indent/tab count and 3 = output.
Returns: 0 = element count and 1 = output.
=cut
sub generate_full_xml {
my ( $self , $element_count , $indent , $output , @return ) =
( shift , shift , shift , shift );
$element_count = 0 if not defined $element_count;
$indent = -1 if not defined $indent;
$output = '' if not defined $output;
++$element_count;
for ( 0 .. $indent ) { $output .= "\t"; }
$output .= $self->get_xml_open_tag( "true" , "true" );
if ( $self->has_children() ) {
$output .= "\n";
++$indent;
foreach ( $self->get_children() ) {
( $element_count , $output ) = $_->generate_full_xml(
$element_count ,
$indent ,
$output
);
}
--$indent;
for ( 0 .. $indent ) { $output .= "\t"; }
}
$output .= $self->get_xml_close_tag() . "\n";
return ( $element_count , $output );
}
=item
B<$el-E<gt>get_a_child();>
Returns a single child element matching supplied array index. Returns C<undef> if index out of bounds.
Parameter: [ 0 = class ] , 1 = index.
=cut
sub get_a_child { return $_[0]->{children}->{elements}[$_[1]]; }
=item
B<$el-E<gt>show_progress();>
Generates abbreviated xml for element and element children. Designed to show user's "progress" to date.
Displays only opening tags. Child elements are displayed only where element is not set to "complete".
Only mandatory attributes are displayed.
Method is recursive.
Parameters (receives): [ 0 = class ] , 1 = output , 2 = stop flag.
Returns: 0 = output.
Algorithm (recursive):
if self is a stop element
set stop flag = true
endif
add self to output
if stop flag == true and children are complete
return 'output'
else
repeat for all children
recurse (returns 'output')
endrepeat
return 'output'
endif
if matching element
set stop flag = true
endif
add to output
if stop flag true
if is complete
if has children
recurse
else
add fragment to output
endif
else # not complete
if has children
repeat for all children
recurse (returns 'retval')
set output = 'retval'
endrepeat
endif
return output
=cut
sub show_progress {
my @stop_elements = qw/ PubType InTextDef AuthorOnly YearOnly /;
my @start_elements = qw/ CitStyle /;
my ( $self , $output , $stop , $root ) = ( shift , shift , shift , 0 );
( $output, $root , $stop ) = ( '' , 1 , 0 ) if not defined $output;
my $class = $self->get_classname();
# switch: $stop
# case: '0'
( $stop == 0 ) and do {
$stop = 1 if grep /\b$class\b/ , @stop_elements;
};
# case: '1'
( $stop == 1 ) and do {
$stop = 0 if grep /\b$class\b/ , @start_elements;
};
# case: default
( not grep /$stop/ , qw/ 0 1 / ) and do {
die "No matching case block for $stop";
};
# endswitch
$output .= $self->get_xml_brief_tag();
if ( $stop && $self->children_are_complete() ) {
# Check for special case where last child still incomplete
if ( $self->has_children() ) {
if ( $self->has_incomplete_descendent() ) {
my $second_last = $self->max_child_index() - 1;
for ( 0 .. $second_last ) {
$output .= $self->get_a_child( $_ )->get_xml_brief_tag();
}
$output .= $self->get_last_child()->show_progress();
}
}
} else {
if ( $self->has_children() ) {
foreach ( $self->get_children() ) {
$output = $_->show_progress( $output , $stop );
}
}
}
$output.= "\n" if $root;
return $output;
}
=item
B<$el-E<gt>generate_brief_xml();>
Generates abbreviated xml for element. Designed to show user's "progress" to date.
Displays only opening tags. Child elements are displayed only where element is not set to "complete".
Only mandatory attributes are displayed.
Method is recursive.
Parameters (receives): [ 0 = class ] and 1 = output.
Returns: 0 = output.
=cut
sub generate_brief_xml {
my ( $self , $output , $root ) = ( shift , shift , 0 );
( $output, $root ) = ( '' , 1 ) if not defined $output;
$output .= $self->get_xml_brief_tag();
if ( ( not $self->is_childless_model() )
&& ( not $self->children_are_complete )
&& $self->has_children() ) {
foreach ( $self->get_children() ) {
$output = $_->generate_brief_xml( $output );
}
}
$output.= "\n" if $root;
return $output;
}
=item
B<$el-E<gt>get_full_tag();>
Returns opening +/- closing xml tag for element.
Displays all attributes and element content. If no possible child elements and no current content, will display single closed tag, eg. E<lt>ELEMENT/E<gt>.
=cut
sub get_full_tag {
$_[0]->get_xml_open_tag( "true" , "true" ) . $_[0]->get_xml_close_tag();
}
=item
B<$el-E<gt>_test_attributes_mandatory();>
Intended as helper method for C<is_creatable>. Tests that mandatory attributes can be created.
Note: The attributes are not actually added to the element.
Returns boolean. False value indicates failure adding mandatory attributes and the associated element should be detroyed.
=cut
sub _test_attributes_mandatory {
my ( $self , $exit_status ) = ( shift , 1 );
if ( not defined( $self->get_attr_mandatory() ) ) { return $exit_status; }
foreach ( $self->get_attr_mandatory() ) {
my $attribute = $_->new();
if ( not ref( $attribute ) ) { $exit_status = 0; }
}
return $exit_status;
}
=item
B<$el-E<gt>add_attributes_mandatory();>
Mandatory attributes are immediately added (note: mandatory attributes should have been added during element construction).
Returns boolean. False value indicates failure adding mandatory attributes and the associated element should be detroyed.
Can be run in 'silent' mode with no output from method. There are no guarantees about the 'silence' of attributes' C<select_value> method, but all such methods should I<not> generate output.
Parameters: [ 0 = class ] , [ 1 = <text> | 1 ]
=cut
sub add_attributes_mandatory {
my ( $self , $silent , $exit_status ) = ( shift , shift , 1 );
if ( not defined( $self->get_attr_mandatory() ) ) { return $exit_status; }
foreach ( $self->get_attr_mandatory() ) {
if ( not $silent ) {
$self->_display( "\nElement: " . $self->get_full_tag() );
$self->_display( "\nAdding mandatory attribute(s)." );
print "\n";
}
my $attribute = $_->new();
if ( not ref( $attribute ) ) {
$exit_status = 0;
last;
}
$attribute->select_value();
$self->_push_attribute( $attribute );
}
return $exit_status;
}
=item
B<$el-E<gt>add_attributes_optional();>
The user selects optional attributes to add. Help is available. Element feedback is presented as the user proceeds.
=cut
sub add_attributes_optional {
my $self = shift;
if ( not defined( $self->get_attr_optional() ) ) { return; }
while ( 1 ) {
my @attributes = $self->list_selectable_attributes();
if ( not @attributes ) { return; }
push( @attributes , "[HELP]" , "[DONE]" );
$self->_display( "\nElement: " . $self->get_full_tag() );
$self->_display( "\nAdding optional attribute(s)." );
print "\n";
my $choice = undef;
while ( 1 ) {
$choice = $self->_input_choice( "Select attribute to add:" , @attributes );
if ( defined( $choice ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
if ( $choice eq "[DONE]" ) { return; }
if ( $choice eq "[HELP]" ) {
$self->_view( "HELP SCREEN: SELECTABLE ATTRIBUTES" ,
$self->_build_attribute_help(
$self->list_selectable_attributes() ) );
next; }
my $attribute = $choice->new();
$attribute->select_value();
$self->_push_attribute( $attribute );
}
}
=item
B<$el-E<gt>mandatory_attributes_complete();>
Returns boolean indicating whether mandatory attributes have been added.
Indicated by a data member which is set after C<add_attributes()> method called.
=cut
sub mandatory_attributes_complete { return $_[0]->{attributes}->{man_complete}; }
=item
B<$el-E<gt>optional_attributes_complete();>
Returns boolean indicating whether optional attributes have been added.
Indicated by a data member which is set after C<add_attributes()> method called.
=cut
sub optional_attributes_complete { return $_[0]->{attributes}->{opt_complete}; }
=item
B<$el-E<gt>add_attributes();>
First adds the mandatory attributes and then gives user chance to add optional attributes.
Returns boolean indicating whether attributes added successfully. Only mechanism of failure occurs when element requires mandatory attribute such as ROLE which cannot be added because maximum number of ROLE attributes already exist for this PUBTYPE.
=cut
sub add_attributes {
my ( $self , $exit_status ) = ( shift , 1 );
return 1 if $self->mandatory_attributes_complete() and $self->optional_attributes_complete();
if ( not $self->mandatory_attributes_complete() ) {
my $exit_status = $self->add_attributes_mandatory();
$self->set_mandatory_attributes_complete( 1 );
}
if ( not $self->optional_attributes_complete() ) {
if ( $exit_status ) { $self->add_attributes_optional(); }
$self->set_optional_attributes_complete( 1 );
}
return $exit_status;
}
=item
B<$el-E<gt>add_child();>
Adds a child to the current element.
Parameters: [ 0 = class ] , 1 = child element (object).
=cut
sub add_child { push( @{ $_[0]->{children}->{elements} } , $_[1] ); }
=item
B<$el-E<gt>_select_next_child_order();>
Helper method for method C<select_next_child>. Used when element has a modal content model. Help is provided where appropriate.
Returns two element list: 0 = message indicating whether selection was forced by the content model or chosen by user , 1 = element class name.
Note: If user makes no selection, and content model forces none, an C<undef> element class name is returned along with an informative message.
When content model is exhausted the content flag -- $self-E<gt>{children}-E<gt>{complete} -- is set to true.
The algorithm for this subroutine is the nastiest in the program. I include it here in full for future occasions when I may have to debug.
if no current child elements
set OUT_OF_CHILDREN = true
else
set OUT_OF_CHILDREN = false
endif
begin loop
if OUT_OF_CHILDREN == true
switch require
case +
if PREV != element
EXIT: mandatory element
else # ( PREV_CHILD == element )
ASK: repeat element
if yes
EXIT: chosen element
else # ( no )
if last element
set children_full flag = true
EXIT: END
else # ( not last element )
advance element
endif
endif
endif
endcase
case 1
if last element
set children_full flag = true
endif
EXIT: mandatory element
endcase
case ?
ASK: add element
if yes
EXIT: chosen element
else # ( no repeat )
if last element
set children_full flag = true
EXIT: END
else # ( not last element )
advance element
endif
endif
endcase
endswitch
else # ( OUT_OF_CHILDREN == false )
if child == element
switch require
case ? | 1
if last child
if last element
set children_full flag = true
EXIT: END
else # ( not last element )
advance element
set OUT_OF_CHILDREN = true
endif
else # ( not last child )
if last element
ERROR: exhausted content model but got $child
else # ( not last element )
advance element
set PREV_CHILD = null
advance child
endif
endif
endcase
case +
if last child
ASK: repeat element
if yes
EXIT: optional element
else # ( no repeat )
if last element
set children_full flag = true
EXIT: END
else # ( not last element )
advance element
set OUT_OF_CHILDREN = true
endif
endif
else # ( not last child )
set PREV_CHILD = child
advance child
endif
endcase
endswitch
else # ( child != element )
switch require
case +
if last element
ERROR: expecting $element, got $child
else # ( not last element )
if PREV_CHILD == element
set PREV_CHILD = null
advance element
else # ( PREV_CHILD != element )
ERROR: expecting $element, got $child
endif
endif
endcase
case ?
if last element
ERROR: content model exhausted, no match for $child
else # ( not last element )
advance element
endif
endcase
case 1
ERROR: expecting $element, got $child
endcase
endswitch
endif
endif
end loop
Warning: In a number of places in this subroutine the program can C<die>. This occurs when a mismatch between the child element model and the actual child elements is detected. If the mismatch truly exists it is a coding error since the algorithm should force child elements to match the content model. If the mismatch is not real the code has erred in analysing the data. Either way, it is an unrecoverable error and the algorithm/code must be corrected.
=cut
sub _select_next_child_order {
my ( $self , $msg_required , $msg_optional , $msg_add , $msg_repeat ) =
( shift , shift , shift , shift , shift );
my ( $out_of_children , @selected , $question ) = ( 0 );
my ( $element_index , $child_index , $previous_child ) = ( 0 , 0 , "" );
if ( $self->is_childless_model() ) {
return ( "Childless model content." , undef );
}
if ( $self->max_child_index() < 0 ) { $out_of_children = 1; }
while ( 1 ) {
my ( $element , $require ) = @{ $self->{model_order}[$element_index] };
my $child = ( $self->max_child_index() >= 0 )
? $self->{children}->{elements}[$child_index]->get_classname()
: '';
if ( $out_of_children ) {
# SWITCH: $require
# case: '+'
( $require eq '+' ) and do {
if ( $element ne $previous_child ) {
@selected = (
sprintf( $msg_required , $element->new()->get_name() ) ,
$element
);
last;
} else {
$question = sprintf(
$msg_repeat ,
$element->new()->get_name() ,
$element->new()->get_help() );
if ( $self->_input_confirm( $question ) ) {
@selected = (
sprintf( $msg_optional ,
$element->new()->get_name() ) ,
$element
);
last;
} else {
if ( $self->is_last_element( $element_index ) ) {
@selected = ( "Content model exhausted." , undef );
$self->set_complete( 1 );
last;
} else {
++$element_index;
}
}
}
};
# case: '1'
( $require eq '1' ) and do {
@selected = (
sprintf( $msg_required , $element->new()->get_name() ) ,
$element
);
if ( $self->is_last_element( $element_index ) ) {
$self->set_complete( 1 );
}
last;
};
# case: '?'
( $require eq '?' ) and do {
$question = sprintf( $msg_add ,
$element->new()->get_name() ,
$element->new()->get_help()
);
if ( $self->_input_confirm( $question ) ) {
@selected = (
sprintf( $msg_optional , $element->new()->get_name() ) ,
$element );
if ( $self->is_last_element( $element_index ) ) {
$self->set_complete( 1 );
}
last;
} else {
if ( $self->is_last_element( $element_index ) ) {
@selected = ( "Content model exhausted." , undef );
$self->set_complete( 1 );
last;
} else {
++$element_index;
}
}
};
# case: default
( not grep $require eq $_ , qw/ ? 1 + / ) && do {
die "Fatal error: No matching case block";
};
# ENDSWITCH
} else { # $out_of_children == false
if ( $child eq $element ) {
# SWITCH: $require
# case: '?' , '1'
( grep $require eq $_ , qw/ ? 1 / ) and do {
if ( $self->is_last_child( $child_index ) ) {
if ( $self->is_last_element( $element_index ) ) {
@selected = ( "Content model exhausted." , undef );
$self->set_complete( 1 );
last;
} else {
++$element_index;
$out_of_children = 1;
}
} else {
if ( $self->is_last_element( $element_index ) ) {
die "Fatal error: Exhausted content model, got $child";
} else {
++$element_index;
$previous_child = '';
++$child_index;
}
}
};
# case: '+'
( $require eq '+' ) and do {
if ( $self->is_last_child( $child_index ) ) {
$question = sprintf( $msg_repeat ,
$element->new()->get_name() ,
$element->new()->get_help()
);
if ( $self->_input_confirm( $question ) ) {
@selected = (
sprintf( $msg_optional ,
$element->new()->get_name() ) ,
$element );
last;
} else {
if ( $self->is_last_element( $element_index ) ) {
@selected = ( "Content model exhausted." , undef );
$self->set_complete( 1 );
last;
} else {
++$element_index;
$out_of_children = 1;
}
}
} else { # not last child
$previous_child = $child;
++$child_index;
}
};
# case: default
( not grep $require eq $_ , qw/ ? 1 + / ) && do {
die "Fatal error: No matching case block";
};
# ENDSWITCH
} else { # child != element
# SWITCH: $require
# case: '+'
( $require eq '+' ) and do {
if ( $self->is_last_element( $element_index ) ) {
die "Fatal error: Expecting $element, got $child";
} else {
if ( $previous_child eq $element ) {
++$element_index;
} else {
die "Fatal error: Expecting $element, got $child";
}
}
};
# case: '?'
( $require eq '?' ) and do {
if ( $self->is_last_element( $element_index ) ) {
die "Fatal error: Exhausted content model, no match for $child";
} else {
++$element_index;
}
};
# case: '1'
( $require eq '1' ) && do {
die "Fatal error: Expecting $element, got $child";
};
# case: default
( not grep $require eq $_ , qw/ ? 1 + / ) && do {
die "Fatal error: No matching case block";
};
# ENDSWITCH
}
}
}
return @selected;
}
=item
B<$el-E<gt>list_selectable_children_noorder();>
Used when selecting child elements when following the unordered model.
Returns a list of all optional elements available for selection. List consists of all elements attributes listed in 'optional' list I<minus> all attributes already selected.
=cut
sub list_selectable_children_noorder {
my ( $self , @children ) = ( shift );
foreach ( $self->get_noorder_list() ) {
if ( $_->is_creatable() ) { push( @children , $_ ); }
}
if ( $self->max_child_index() >= 0 ) {
if ( $self->{children}->{elements}[$self->max_child_index()]->get_classname() ne $self->get_noorder_separator() ) {
push( @children , $self->get_noorder_separator() );
}
}
return @children;
}
=item
B<$el-E<gt>_build_element_help();>
Helper method for method C<_select_next_child_noorder>. Takes as parameter a list of elements for which help screen is being built.
=cut
sub _build_element_help {
my ( $self , @elements , $help ) = ( shift , @_ );
foreach my $element ( @elements ) {
$help .= $element->new()->get_name() . "\n";
$help .= $element->new()->get_help() . "\n\n";
}
return $help;
}
=item
B<$el-E<gt>_select_next_child_noorder();>
The user selects optional child element to add.
Helper method for 'select_next_child'.
Returns two element list: 0 = message indicating whether selection was forced by the content model or chosen by user , 1 = element class name.
Note: If user chooses to finish child element selection, C<undef> element class name is returned along with an informative message.
When child element selection is finished the content flag -- $self-E<gt>{children}-E<gt>{complete} -- is set to true.
Help is available.
No option to exit until at least one element has been selected.
Cannot select two C<Separator> elements consecutively.
=cut
sub _select_next_child_noorder {
my ( $self , $msg_optional , $choice , @selected ) = ( shift , shift );
if ( $self->is_childless_model() ) {
return ( "Childless model content." , undef );
}
while ( 1 ) {
my @add_options = qw/ [DELETE] [DONE] /;
my @menu = $self->list_selectable_children_noorder();
push( @menu , "[HELP]" );
if ( $self->max_child_index() >= 0 ) { push( @menu , @add_options ); }
$choice = undef;
while ( 1 ) {
$choice = $self->_input_choice( "Select child element to add:" , @menu );
if ( defined( $choice ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
if ( $choice eq "[HELP]" ) {
$self->_view( "HELP SCREEN: SELECTABLE ELEMENTS" ,
$self->_build_element_help(
$self->list_selectable_children_noorder() ) );
next;
}
# SWITCH: $choice
# case: '[DELETE]'
( $choice eq '[DELETE]' ) and do {
@selected = ( "User wishes to delete." , "[DELETE]" );
last;
};
# case: '[DONE]'
( $choice eq '[DONE]' ) and do {
@selected = ( "User has finished optional element selection." , undef );
$self->set_complete( 1 );
last;
};
# case: default ( = <element> )
( not grep $choice eq $_ , @add_options ) and do {
@selected = (
sprintf( $msg_optional ,
$choice->new()->get_name() ) ,
$choice
);
last;
};
# ENDSWITCH
}
return @selected;
}
=item
B<$el-E<gt>select_next_child();>
The user selects a child element to add. Help is available.
Returns two element list: 0 = text indicating whether mandatory or user choice ,
1 = element class name.
Note: If user makes no selection, and content model forces none, an C<undef> element class name is returned along with an informative message.
The algorithm for this subroutine is the nastiest in the program. I include it here in full for future occasions when I may have to debug.
=cut
sub select_next_child {
my ( $self , @selected ) = ( shift );
my $msg_required = "Element %s is required here.\n";
my $msg_optional = "User selected optional element %s.\n";
my $msg_add = "Do you want to add child element %s ?\n\n%s";
my $msg_repeat = "Do you want to add another element %s ?\n\n%s";
if ( $self->is_ordered_child_model() ) {
@selected = $self->_select_next_child_order( $msg_required , $msg_optional , $msg_add , $msg_repeat );
}
if ( $self->is_unordered_child_model() ) {
@selected = $self->_select_next_child_noorder( $msg_optional );
}
return @selected;
}
=item
B<$el-E<gt>is_copyable();>
Returns boolean indicating whether element can be copied.
Based on value of $self-E<gt>{copyable}.
=cut
sub is_copyable { return $_[0]->{copyable}; }
=item
B<$el-E<gt>copy();>
Attempts to copy element. Returns either a reference to a copied element or an error message.
Can test for success using C<ref> function.
Does not copy attributes. Attributes requiring user input during creation are not copyable (this includes Type_PubType, Role_UserDef, Role_Misc and Role_Link).
Does not copy child elements. For that, use the C<duplicate> method.
=cut
sub copy { return $_[0]->get_classname()->new(); }
=item
B<$el-E<gt>has_attributes();>
Returns boolean indicating whether element has attributes.
=cut
sub has_attributes {
my ( $self , $result ) = ( shift , 0 );
if ( defined( $self->{attributes}->{selected} ) ) {
if ( $#{ $self->{attributes}->{selected} } >= 0 ) {
$result = 1;
}
}
return $result;
}
=item
B<$el-E<gt>has_children();>
Returns boolean indicating whether element has children.
=cut
sub has_children {
my ( $self , $result ) = ( shift , 0 );
if ( defined( $self->{children}->{elements} ) ) {
if ( $self->max_child_index() >= 0 ) {
$result = 1;
}
}
return $result;
}
=item
B<$el-E<gt>_push_attribute();>
Adds attribute to element.
Parameters: [ 0 = class ] , 1 = attribute object.
=cut
sub _push_attribute { push @{ $_[0]->{attributes}->{selected} } , $_[1]; }
=item
B<$el-E<gt>duplicate();>
Returns either a reference to a duplicate element or an error message.
Copies all attributes, child elements and element content.
=cut
sub is_duplicatable {
my ( $self , $result ) = ( shift , 0 );
{
if ( ref( $self->duplicate() ) ) { $result = 1; }
}
return $result;
}
=item
B<$el-E<gt>duplicate();>
Returns either a reference to a duplicate element or an error message.
Copies all attributes, child elements and element content.
=cut
sub duplicate {
my ( $self , $success , $message , $copy ) = ( shift , 1 );
if ( not $self->is_copyable() ) {
return sprintf(
"(Sub)Element %s is not copyable." ,
$self->get_name()
);
}
$copy = $self->copy();
# first, copy attributes
if ( $self->has_attributes() ) {
foreach my $at ( $self->get_attr_selected() ) {
my $attribute = $at->get_classname()->new();
if ( ref( $attribute ) ) {
if ( $attribute->get_value() ) {
# autogenerated - don't change
} else {
if ( $at->get_value() ) {
$attribute->_set_value( $at->get_value() );
}
}
} else {
return $attribute;
}
$copy->_push_attribute( $attribute );
}
}
# next, copy element value
if ( $self->is_content_allowed() ) {
if ( $self->get_value() ) {
$copy->_set_value( $self->get_value() );
}
}
# now, recurse for child elements
if ( $self->has_children() ) {
foreach my $ch ( $self->get_children() ) {
my $child = $ch->duplicate();
if ( ref( $child ) ) {
$copy->add_child( $child );
} else {
return $child;
}
}
}
return $copy;
}
=item
B<$el-E<gt>is_ordered_child_model();>
Returns boolean indicating nature of child element content model.
=cut
sub is_ordered_child_model { $_[0]->get_order(); }
=item
B<$el-E<gt>is_unordered_child_model();>
Returns boolean indicating nature of child element content model.
=cut
sub is_unordered_child_model { $_[0]->get_noorder_list(); }
=item
B<$el-E<gt>is_childless_model();>
Returns boolean indicating nature of child element content model.
=cut
sub is_childless_model {
my ( $self , $result ) = ( shift , 1 );
if ( $self->is_ordered_child_model() ) { $result = 0; }
if ( $self->is_unordered_child_model() ) { $result = 0; }
return $result;
}
=item
B<$el-E<gt>get_last_parent();>
Return reference to last parent element.
Parameters: [ 0 = class ] , 1 = originator flag (true if not originating element)
Recursive algorithm:
if child elements
recurse last child (returns 'retval')
if 'retval' is element
return 'retval'
else
return self
endif
else
if recursed element
return undef
else
return self
endif
endif
=cut
sub get_last_parent {
my ( $self , $recursed , $result ) = ( shift , shift );
if ( $self->has_children() ) {
my $return = $self->get_last_child()->get_last_parent( 1 );
return defined( $return ) ? $return : $self;
} else {
return $recursed ? undef : $self;
}
}
=item
B<$el-E<gt>get_last_element();>
Return reference to last element.
Recursive algorithm:
if child elements
recurse last child (returns 'retval')
return 'retval'
else
return self
endif
=cut
sub get_last_element { $_[0]->has_children() ?
$_[0]->get_last_child()->get_last_element() : $_[0]; }
=item
B<$el-E<gt>delete_last_child();>
Delete last child of this element.
Returns element.
=cut
sub delete_last_child {
my $self = shift;
return pop @{ $self->{children}->{elements} };
}
=item
B<$el-E<gt>delete_last_element();>
Delete last element.
Return deleted element.
=cut
sub delete_last_element {
my $self = shift;
return $self->get_last_parent()->delete_last_child();
}
=item
B<$el-E<gt>has_incomplete_descendent();>
Returns boolean indicating whether any descendent of element is incomplete.
=cut
sub has_incomplete_descendent {
my ( $self , $result ) = ( shift , shift );
return 1 if not $self->children_are_complete();
if ( $self->has_children() ) {
foreach ( $self->get_children() ) {
return 1 if $_->has_incomplete_descendent();
}
}
}
=item
B<$el-E<gt>get_last_incomplete();>
Return reference to last element in tree that is incomplete.
Returns C<undef> if all elements complete.
Recursive algorithm:
if child elements
recurse last child (returns 'retval')
if 'retval' is element
return 'retval'
endif
else
if not complete
return self
else
return undef
endif
endif
=cut
sub get_last_incomplete {
my ( $self , $recursed ) = ( shift , shift );
if ( $self->has_children() ) {
my $return = $self->get_last_child()->get_last_incomplete( 1 );
return ref( $return ) ? $return : $self->children_are_complete() ? undef : $self;
} else {
return $self->children_are_complete() ? undef : $self;
}
}
=item
B<$el-E<gt>is_named();>
Returns boolean indicating whether element has display data member set to "name".
=cut
sub is_named { defined $_[0]->{display} && $_[0]->{display} eq "name" ? 1 : 0; }
=item
B<$el-E<gt>get_last_named();>
Return reference to last element in tree with display data member set to 'name'.
=cut
sub get_last_named {
my ( $self , $recursed ) = ( shift , shift );
if ( $self->has_children() ) {
my $return = $self->get_last_child()->get_last_named( 1 );
return ref( $return ) ? $return : $self->is_named() ? $self : undef;
} else {
return $self->is_named() ? $self : undef ;
}
}
=item
B<$el-E<gt>get_style_name();>
Finds StyleName element and returns element content.
If unsuccessful, return C<undef>.
=cut
sub get_style_name {
my $self = shift;
return $self->get_value() if $self->get_classname() eq "StyleName";
if ( $self->has_children() ) {
foreach ( $self->get_children() ) { return $_->get_style_name(); }
} else { return undef; }
}
=item
B<$el-E<gt>get_most_recent();>
Return reference to last element in tree of supplied element class.
If no element found, return C<undef>.
=cut
sub get_most_recent {
my ( $self , $class , $most_recent , $just_found , $return) =
( shift , shift , shift );
if ( $self->has_children() ) {
foreach ( $self->get_children() ) {
$return = $_->get_most_recent( $class , $most_recent );
$just_found = $return if ref( $return );
}
}
return $most_recent if ref( $most_recent );
return $just_found if ref( $just_found );
return ( $self->get_classname() eq $class ) ? $self : undef;
}
=item
B<$el-E<gt>reset_all_counters();>
Resets all role level counters
Called by PubType, AuthorOnly, YearOnly and InTextDef during element creation.
=cut
sub reset_all_counters {
foreach ( qw/ Role_AuthorList Role_PubDate Role_Title Role_UserDef Role_Misc Role_Link / ) {
$_->reset_counter();
}
}
=item
B<$el-E<gt>named_in_summary();>
Boolean indicating whether to include element in summary.
=cut
sub named_in_summary {
if ( $_[0]->get_summary() ) { ( $_[0]->get_summary() eq "name" ) ? 1 : 0; }
}
=item
B<$el-E<gt>content_in_summary();>
Boolean indicating whether to include raw element content in summary. Currently only applies to SEPARATOR.
=cut
sub content_in_summary {
if ( $_[0]->get_summary() ) { ( $_[0]->get_summary() eq "content" ) ? 1 : 0; }
}
=item
B<$el-E<gt>has_bracketing_child();>
Boolean indicating whether element has any child elements whose content will "bracket" this element's content in output. Currently only applies to PRECEEDING and FOLLOWING.
=cut
sub has_bracketing_child {
my ( $self , $return ) = ( shift , 0 );
if ( $self->has_children() ) {
foreach ( $self->get_children() ) {
my $class = $_->get_classname();
$return = 1 if grep /\b$class\b/ , qw/ Preceeding Following /;
}
}
return $return;
}
=item
B<$el-E<gt>generate_summary();>
Generates substantial portion of style summary. Called by UI method 'write_summary'.
Parameters: [ 0 = class ] , 1 = previous output.
Returns: 0 = current output.
Since this method is only called on a complete style, we can make assumptions based on the style following the DTD.
Recursive algorithm.
switch <element class>
case 'StyleName'
add to output: style name
endcase
case 'RefStyle'
add to output: header = "Bibliography Style"
endcase
case 'PubStyle'
add to output: header giving publication type
endcase
case 'CitStyle'
add to output: header = "Citation Style"
endcase
case 'InTextDef'
add to output: header = Author and Year
endcase
case 'AuthorOnly'
add to output: header = Author
endcase
case 'YearOnly'
add to output: header = Year
endcase
endswitch
if summary flag == name
if bracketing child element(s)
set bracket flag = true
endif
if bracket flag == true
add to output: opening brackets
endif
if bracket flag == true
if left bracketing element present
print left bracketing element contents
endif
endif
add to output: left marker
add to output: element name
repeat for all attributes
if attribute summary flag == true
add to output: attribute value (italicised)
endif
endrepeat
add to output: right marker
endif
if have children
repeat for all children
** recurse (send output, receive output as 'retval')
endrepeat
endif
return output
=back
=cut
sub generate_summary {
my ( $self , $output , $div , $recurse ) =
( shift , shift , shift , shift );
my ( $left_bracket , $right_bracket ) = ( "{" , "}" );
my ( $left_marker , $right_marker ) = ( "<i>" , "</i>" );
my @left = qw/ Preceeding /;
my @right = qw/ Following /;
# Headings
my $class = $self->get_classname();
# SWITCH: class
# case: 'StyleName'
( $class eq 'StyleName' ) and do {
my $stylename = sprintf( "RefDB Style: %s" , $self->get_value() );
$output .= sprintf( "<html>\n<head>\n<title>%s</title>\n</head>\n<body>\n<h1>%s</h1>\n<table cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n<tr>\n<td><i>ELEMENT</i></td>\n<td> </td>\n<td>A major component of the bibliography/citation.</td>\n</tr>\n<tr>\n<td><u>ATTRIBUTE</u></td>\n<td> </td>\n<td>An element attribute.</td>\n</tr>\n<tr>\n<td>{}</td>\n<td> </td>\n<td>Encloses text/punctuation that appears only if associated element is present.</td>\n</tr>\n<tr>\n<td><b>bolded</b></td>\n<td> </td>\n<td>Text/punctuation that always appears, regardless of which elements are present.</td>\n</tr>\n</table>\n" , $stylename , $stylename );
};
# case: 'RefStyle'
( $class eq 'RefStyle' ) and do {
$output .= "<hr>\n<h2>Reference Style</h2>\n";
};
# case: 'PubType'
( $class eq 'PubType' ) and do {
if ( $div ) { $output .= "</div>\n"; }
my @pubtype = $self->get_publication_type();
$output .= sprintf( "<h3>Publication type %s: %s</h3>\n<div>" , $pubtype[1] , $pubtype[0] );
$div = 1;
};
# case: 'CitStyle'
( $class eq 'CitStyle' ) and do {
$output .= "</div>\n<hr>\n<h2>Citation Style</h2>\n<div>";
};
# case: 'InTextDef'
( $class eq 'InTextDef' ) and do {
$output .= "</div>\n<h3>Citation Style: Author/Year</h3>\n<div>";
};
# case: 'AuthorOnly'
( $class eq 'AuthorOnly' ) and do {
$output .= "</div>\n<h3>Citation Style: Author only</h3>\n<div>";
};
# case: 'YearOnly'
( $class eq 'YearOnly' ) and do {
$output .= "</div>\n<h3>Citation Style: Year only</h3>\n<div>";
};
# case: 'BibStyle'
( $class eq 'BibStyle' ) and do {
$output .= "</div>\n<hr>\n<h2>Bibliography Style</h2>\n<div>";
if ( $self->has_attributes() ) {
for ( 0 .. $self->max_attribute_index() ) {
$output .= sprintf(
"%s: '%s'</div>\n<div>" ,
$self->{attributes}->{selected}[$_]->get_name() ,
$self->{attributes}->{selected}[$_]->get_value()
);
}
} else {
$output .= "<i>No styling changes specified</i></div>\n<div>";
}
};
# case: 'BiblioTitle'
( $class eq 'BiblioTitle' ) and do {
$output .= sprintf(
"%s: '%s'</div>\n<div>" ,
$self->get_name() ,
$self->get_value()
);
};
# ENDSWITCH
# Major element - include name/attributes/bracketing punctuation
if ( $self->named_in_summary() ) {
my $bracketed = 1 if $self->has_bracketing_child();
# left bracket
if ( $bracketed ) { $output .= $left_bracket; }
# preceeding punctuation
if ( $self->has_children() ) {
foreach ( $self->get_children() ) {
my $child = $_->get_classname();
$output .= $_->get_value() if grep /\b$child\b/ , @left;
}
}
# element name
$output .= $left_marker;
$output .= $self->get_name();
$output .= $right_marker;
# element attributes
foreach ( $self->get_attr_selected() ) {
if ( $_->get_summary() ) {
$output .= sprintf( " <u>%s</u>" , $_->get_value() );
}
}
# following punctuation
if ( $self->has_children() ) {
foreach ( $self->get_children() ) {
my $child = $_->get_classname();
$output .= $_->get_value() if grep /\b$child\b/ , @right;
}
}
# right bracket
if ( $bracketed ) { $output .= $right_bracket; }
}
# Separator element - include raw content
if ( $self->content_in_summary() && $self->get_value() ) {
$output .= sprintf( "<b>%s</b>" , $self->get_value() );
}
# Recurse
if ( $self->has_children() ) {
foreach ( $self->get_children() ) {
$output = $_->generate_summary( $output , $div , 1 );
}
}
# If original/final element then complete html
$output .= "\n</div>\n<hr>\n</body>\n</html>" if not $recurse;
# All done
return $output;
}
=head2 Elements: List of Classes
To see a list of attribute classes use the C<document-dtd-entities> utility that shipped with this program. It extracts attribute and element properties from this script, assembles and formats them into a single html document.
All elements descend from one of three ancestor classes depending on their content model:
=over
=item
B<_Model_Childless>
Elements descended from this class have a content model specifying no children elements.
=cut
package _Model_Childless;
use base qw/ _Element /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_order( undef );
$self->set_noorder( undef );
$self->set_complete( 1 );
return $self;
}
=item
B<_Model_Order>
Elements descended from this class have a content model of the general form:
( element_A[?|+] , element_B[?|+] , ... )
=cut
package _Model_Order;
use base qw/ _Element /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_order( undef );
$self->set_noorder( undef );
return $self;
}
=item
B<_Model_Noorder>
Elements descended from this class have a content model of the general form:
( element_A | element_B , ... ) , element_X? )+
=back
=cut
package _Model_Noorder;
use base qw/ _Element /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_order( undef );
$self->set_noorder( {
element_list => [ "RefNumber" , "AuthorList" , "PubDate" , "Title" , "JournalName" , "Volume" , "Issue" , "Pages" , "Publisher" , "PubPlace" ] ,
separator => "Separator" ,
} );
return $self;
}
package StyleSet;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "STYLESET" );
$self->set_prompt( "Top-level element. Enables multiple bibliography styles to be stored in one document. Not needed if single style stored in document/file." );
$self->set_help( "Top-level element. Enables multiple bibliography styles to be stored in one document. Not needed if single style stored in document/file." );
$self->set_display( "name" );
$self->set_order( [
[ "CiteStyle" , "+" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
package CiteStyle;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "CITESTYLE" );
$self->set_prompt( "Encloses a bibliography style for a particular journal or publisher." );
$self->set_help( "Encloses a bibliography style for a particular journal or publisher." );
$self->set_display( "name" );
$self->set_order( [
[ "StyleName" , "1" ] ,
[ "RefStyle" , "1" ] ,
[ "CitStyle" , "1" ] ,
[ "BibStyle" , "1" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
package StyleName;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "STYLENAME" );
$self->set_prompt( "Determines the name of the style" );
$self->set_help( "This value is the name of the style. It is case-sensitive, i.e., RefDB can have two different styles called \"Style\" and \"style\". The style name will be the root of the names given to the style and summary files generated by this utility." );
$self->set_display( "name" );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package RefStyle;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "REFSTYLE" );
$self->set_prompt( "Encloses all elements responsible for the style of the bibliography." );
$self->set_help( "Encloses all elements responsible for the style of the bibliography." );
$self->set_display( "name" );
$self->set_order( [
[ "PubType" , "+" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
package PubType;
use base qw/ _Model_Noorder /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "PUBTYPE" );
$self->set_prompt( "Refdb allows for 35 different publication types (including BOOK and JOUR) and each can have a different style. This element encloses all elements responsible for the styling of a single publication type." );
$self->set_help( "Refdb allows for 35 different publication types (including BOOK and JOUR) and each can have a different style. This element encloses all elements responsible for the styling of a single publication type." );
$self->set_display( "name" );
$self->set_attributes( {
mandatory => [ "Type_PubType" ] ,
optional => undef ,
} );
$self->set_noorder( {
element_list => [ "RefNumber" , "AuthorList" , "PubDate" , "Title" , "JournalName" , "Volume" , "Issue" , "Pages" , "Publisher" , "PubPlace" , "Serial" , "Address" , "UserDef" , "Misc" , "Notes" , "Abstract" , "Link" ] ,
separator => "Separator" ,
} );
$self->reset_all_counters();
return $self;
}
# Class methods
sub default_copyable { undef; }
sub get_publication_type {
my ( $self , @type ) = ( shift );
my %_lookup = ( "GEN" => "default" ,
"ABST" => "abstract" ,
"ADVS" => "audiovisual material" ,
"ART" => "art work" ,
"BILL" => "resolution/bill" ,
"BOOK" => "whole book" ,
"CASE" => "case" ,
"CHAP" => "book chapter" ,
"COMP" => "computer program" ,
"CONF" => "conference proceeding" ,
"CTLG" => "catalog" ,
"DATA" => "data file" ,
"ELEC" => "electronic citation" ,
"HEAR" => "hearing" ,
"ICOMM" => "internet communication" ,
"INPR" => "in press" ,
"JFULL" => "entire journal/periodical" ,
"JOUR" => "journal/periodical article" ,
"MAP" => "map" ,
"MGZN" => "magazine" ,
"MPCT" => "motion picture" ,
"MUSIC" => "music score" ,
"NEWS" => "newspaper" ,
"PAMP" => "pamphlet" ,
"PAT" => "patent" ,
"PCOMM" => "personal communication" ,
"RPRT" => "report" ,
"SER" => "serial--book monograph" ,
"SLIDE" => "slide" ,
"SOUND" => "sound recording" ,
"STAT" => "statute" ,
"THES" => "thesis/dissertation" ,
"UNBILL" => "unenacted bill/resolution" ,
"UNPB" => "unpublished" ,
"VIDEO" => "video recording" ,
);
foreach ( $self->get_attr_selected() ) {
if ( $_->get_classname() eq "Type_PubType" ) {
unshift @type , $_->get_value();
unshift @type , $_lookup{$type[0]};
last;
}
}
return @type;
}
package RefNumber;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "REFNUMBER" );
$self->set_prompt( "Specifies location of reference number (in styles that use numbered bibliography references. Determines formatting of the number." );
$self->set_help( "Specifies location of reference number (in styles that use numbered bibliography references. Determines formatting of the number." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Preceeding;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "PRECEEDING" );
$self->set_prompt( "Defines character(s) which precede the parent element, eg. 'vol. ' to precede journal volume." );
$self->set_help( "Defines character(s) which precede the parent element, eg. 'vol. ' to precede journal volume." );
$self->set_display( "content" );
$self->set_summary( "left" );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
# Class-specific
sub _is_valid_value {
if ( defined( $_[1] ) && ( $_[1] ne "" ) ) {
1;
} else {
print "Invalid value. Sorry, please try again.\n";
0;
}
}
package Following;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "FOLLOWING" );
$self->set_prompt( "Define character(s) which follow the parent element, eg. follow publisher with '.' to end reference." );
$self->set_help( "Define character(s) which follow the parent element, eg. follow publisher with '.' to end reference." );
$self->set_display( "content" );
$self->set_summary( "right" );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
# Class-specific
sub _is_valid_value {
if ( defined( $_[1] ) && ( $_[1] ne "" ) ) {
1;
} else {
print "Invalid value. Sorry, please try again.\n";
0;
}
}
package AuthorList;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "AUTHORLIST" );
$self->set_prompt( "Specifies location of an author list [can be any of ris elements: AU|A1, A2, A3] in citation/reference. Contains elements and attributes determining the formatting of the list of authors." );
$self->set_help( "Specifies location of an author list [can be any of ris elements: AU|A1, A2, A3] in citation/reference. Contains elements and attributes determining the formatting of the list of authors." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => [ "Role_AuthorList" ] ,
optional => [ "AlternateStyle" , "AlternateText_AuthorList" , "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
[ "AbbreviateFirst" , "?" ] ,
[ "AbbreviateSubseq" , "?" ] ,
[ "Aempty" , "?" ] ,
[ "Asame" , "?" ] ,
[ "AuthorSeps" , "1" ] ,
[ "AuthorNames" , "1" ] ,
[ "Text" , "?" ] ,
] );
return $self;
}
package AbbreviateFirst;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "ABBREVIATEFIRST" );
$self->set_prompt( "Determines how many authors will be listed in the first citation or reference of a unique list of authors. Also specifies what text to use in place of excess authors, eg. 'et al.'." );
$self->set_help( "Determines how many authors will be listed in the first citation or reference of a unique list of authors. Also specifies what text to use in place of excess authors, eg. 'et al.'." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "DisplayAuthor" , "MaxAuthor" ] ,
optional => [ "Style" ] ,
} );
$self->set_content( {
allowed => 1 ,
suggestion => "et al." ,
value => undef ,
} );
return $self;
}
package AbbreviateSubseq;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "ABBREVIATESUBSEQ" );
$self->set_prompt( "Determines how many authors will be listed in subsequent citations or references of a unique list of authors. Also specifies what text to use in place of excess authors, eg. 'et al.'." );
$self->set_help( "Determines how many authors will be listed in subsequent citations or references of a unique list of authors. Also specifies what text to use in place of excess authors, eg. 'et al.'." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "DisplayAuthor" , "MaxAuthor" ] ,
optional => [ "Style" ] ,
} );
$self->set_content( {
allowed => 1 ,
suggestion => "et al." ,
value => undef ,
} );
return $self;
}
package Aempty;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "AEMPTY" );
$self->set_prompt( "Determines what text is used as author name when none is supplied by the reference, eg. 'Anonymous'." );
$self->set_help( "Determines what text is used as author name when none is supplied by the reference, eg. 'Anonymous'." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => "Anonymous" ,
value => undef ,
} );
return $self;
}
package Asame;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "ASAME" );
$self->set_prompt( "Determines what text is used instead of the author list when multiple publications have the same authors, eg. an 'mdash'." );
$self->set_help( "Determines what text is used instead of the author list when multiple publications have the same authors, eg. an 'mdash'." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
package AuthorSeps;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "AUTHORSEPS" );
$self->set_prompt( "Container for elements which determine what punctuation occurs between authors." );
$self->set_help( "Container for elements which determine what punctuation occurs between authors." );
$self->set_display( undef );
$self->set_order( [
[ "TwoSeps" , "1" ] ,
[ "ThreeSeps" , "1" ] ,
] );
return $self;
}
package TwoSeps;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "TWOSEPS" );
$self->set_prompt( "Determines what character(s) to insert between authors when there are only two authors for a publication." );
$self->set_help( "Determines what character(s) to insert between authors when there are only two authors for a publication." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
package ThreeSeps;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "THREESEPS" );
$self->set_prompt( "Contains elements that determine what characters to insert between authors when there are more than two authors." );
$self->set_help( "Contains elements that determine what characters to insert between authors when there are more than two authors." );
$self->set_display( undef );
$self->set_order( [
[ "ThreeSepsEach" , "1" ] ,
[ "ThreeSepsLast" , "1" ] ,
] );
return $self;
}
package ThreeSepsEach;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "THREESEPSEACH" );
$self->set_prompt( "When there are three or more authors, this element determines what character(s) to insert between all but the last pair of authors." );
$self->set_help( "When there are three or more authors, this element determines what character(s) to insert between all but the last pair of authors." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
package ThreeSepsLast;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "THREESEPSLAST" );
$self->set_prompt( "When there are three or more authors, this element determines what character(s) to insert between the last pair of authors." );
$self->set_help( "When there are three or more authors, this element determines what character(s) to insert between the last pair of authors." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
package AuthorNames;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "AUTHORNAMES" );
$self->set_prompt( "Contains elements which determine the formatting of author names." );
$self->set_help( "Contains elements which determine the formatting of author names." );
$self->set_display( undef );
$self->set_order( [
[ "NameFirst" , "1" ] ,
[ "NameOther" , "1" ] ,
] );
return $self;
}
package NameFirst;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "NAMEFIRST" );
$self->set_prompt( "Determines the formatting of the first author's name, including the ordering of sur- and forenames, punctuation of initials and whether any part of the name is in upper case." );
$self->set_help( "Determines the formatting of the first author's name, including the ordering of sur- and forenames, punctuation of initials and whether any part of the name is in upper case." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => undef ,
optional => [ "InitialStyle" , "NameOrder" , "UpperCase" ] ,
} );
return $self;
}
package NameOther;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "NAMEOTHER" );
$self->set_prompt( "Contains elements which determine the formatting of second and subsequent authors' names, including such things as ordering of surn- and forenames, punctuation of initials and whether any part of the name is in upper case." );
$self->set_help( "Contains elements which determine the formatting of second and subsequent authors' names, including such things as ordering of surn- and forenames, punctuation of initials and whether any part of the name is in upper case." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => undef ,
optional => [ "InitialStyle" , "NameOrder" , "UpperCase" ] ,
} );
return $self;
}
package Text;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "TEXT" );
$self->set_prompt( "Contains elements which determine what text, if any, precedes and follows the author list." );
$self->set_help( "Contains elements which determine what text, if any, precedes and follows the author list." );
$self->set_display( undef );
$self->set_order( [
[ "TextSingle" , "?" ] ,
[ "TextMultiple" , "?" ] ,
] );
return $self;
}
package TextSingle;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "TEXTSINGLE" );
$self->set_prompt( "Determines what text, if any, precedes and follows the author in a single author work." );
$self->set_help( "Determines what text, if any, precedes and follows the author in a single author work." );
$self->set_display( undef );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package TextMultiple;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "TEXTMULTIPLE" );
$self->set_prompt( "Determines what text, if any, precedes and follows the author list in a multiple author work." );
$self->set_help( "Determines what text, if any, precedes and follows the author list in a multiple author work." );
$self->set_display( undef );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package PubDate;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "PUBDATE" );
$self->set_prompt( "Specifies the location of a publication date [can be any of ris elements: PY|Y1, Y2] in the citation/reference. Contains elements and attributes which determine how the publication date is formatted." );
$self->set_help( "Specifies the location of a publication date [can be any of ris elements: PY|Y1, Y2] in the citation/reference. Contains elements and attributes which determine how the publication date is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => [ "Role_PubDate" ] ,
optional => [ "Sequence" , "Format" , "YearFormat" , "MonthFormat" , "PadLeadingZero" , "Style" , "DayFormat" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
[ "FirstSep" , "?" ] ,
[ "SecondSep" , "?" ] ,
] );
return $self;
}
package FirstSep;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "FIRSTSEP" );
$self->set_prompt( "Determines what character(s) appear between the first and second parts of the publication date, eg. '/' between day and month." );
$self->set_help( "Determines what character(s) appear between the first and second parts of the publication date, eg. '/' between day and month." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
package SecondSep;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "SECONDSEP" );
$self->set_prompt( "Determines what character(s) appear between the second and third parts of the publication date, eg. '/' between month and year." );
$self->set_help( "Determines what character(s) appear between the second and third parts of the publication date, eg. '/' between month and year." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
package Title;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "TITLE" );
$self->set_prompt( "Specifies the location of a title [can be any of ris elements: BT|TI, T2, T3] in the citation/reference. Determines how the title is formatted." );
$self->set_help( "Specifies the location of a title [can be any of ris elements: BT|TI, T2, T3] in the citation/reference. Determines how the title is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => [ "Role_Title" ] ,
optional => [ "Case" , "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package JournalName;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "JOURNALNAME" );
$self->set_prompt( "Specifies the location of journal name [can be any of ris elements: JO, JF, J1, J2] in the citation/reference. Determines how the journal name is formatted." );
$self->set_help( "Specifies the location of journal name [can be any of ris elements: JO, JF, J1, J2] in the citation/reference. Determines how the journal name is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "AlternateText_JournalName" , "DefaultText" , "DefaultText" , "Punctuation" , "Case" , "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Volume;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "VOLUME" );
$self->set_prompt( "Specifies the location of volume [ris element: VL] in the citation/reference. Determines how the volume is formatted." );
$self->set_help( "Specifies the location of volume [ris element: VL] in the citation/reference. Determines how the volume is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Issue;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "ISSUE" );
$self->set_prompt( "Specifies the location of issue [ris element: IS] in the citation/reference. Determines how the issue is formatted." );
$self->set_help( "Specifies the location of issue [ris element: IS] in the citation/reference. Determines how the issue is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Pages;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "PAGES" );
$self->set_prompt( "Specifies the location of the page reference [ris element(s): SP +/- EP] in the citation/reference. Contains elements and attributes which determine how the page reference is formatted." );
$self->set_help( "Specifies the location of the page reference [ris element(s): SP +/- EP] in the citation/reference. Contains elements and attributes which determine how the page reference is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
[ "SinglePage" , "?" ] ,
[ "PageRange" , "?" ] ,
] );
return $self;
}
package SinglePage;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "SINGLEPAGE" );
$self->set_prompt( "Determines how a single-page page reference is formatted." );
$self->set_help( "Determines how a single-page page reference is formatted." );
$self->set_display( undef );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package PageRange;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "PAGERANGE" );
$self->set_prompt( "Determines how a multiple-page page reference is formatted." );
$self->set_help( "Determines how a multiple-page page reference is formatted." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Type_PageRange" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "RangeSeparator" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package RangeSeparator;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "RANGESEPARATOR" );
$self->set_prompt( "Determines what character(s) to use to separate start and end page numbers in a mult-page page reference, eg. a '-'." );
$self->set_help( "Determines what character(s) to use to separate start and end page numbers in a mult-page page reference, eg. a '-'." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => "-" ,
value => undef ,
} );
return $self;
}
package Publisher;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "PUBLISHER" );
$self->set_prompt( "Specifies the location of the publisher [ris element: PB] in the citation/reference. Determines how the publisher is formatted." );
$self->set_help( "Specifies the location of the publisher [ris element: PB] in the citation/reference. Determines how the publisher is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package PubPlace;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "PUBPLACE" );
$self->set_prompt( "Specifies the location of the city of publication [ris element: CY] in the citation/reference. Determines how the city of publication is formatted." );
$self->set_help( "Specifies the location of the city of publication [ris element: CY] in the citation/reference. Determines how the city of publication is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Serial;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "SERIAL" );
$self->set_prompt( "Specifies the location of serial number (usually ISSN or ISBN number) [ris element: SN] in the reference. Determines how the serial number is formatted." );
$self->set_help( "Specifies the location of serial number (usually ISSN or ISBN number) [ris element: SN] in the reference. Determines how the serial number is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Address;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "ADDRESS" );
$self->set_prompt( "Specifies the location of the corresponding author's contact details [ris element: AD] in the citation/reference. Determines how the contact details are formatted." );
$self->set_help( "Specifies the location of the corresponding author's contact details [ris element: AD] in the citation/reference. Determines how the contact details are formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package UserDef;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "USERDEF" );
$self->set_prompt( "Specifies the location of a user-defined field [can be any of ris elements: U1, U2, U3, U4, U5] in the citation/reference. Determines how the field's contents are formatted." );
$self->set_help( "Specifies the location of a user-defined field [can be any of ris elements: U1, U2, U3, U4, U5] in the citation/reference. Determines how the field's contents are formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => [ "Role_UserDef" ] ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
sub _test_attributes_mandatory { # override to prevent Role_UserDef dialog
return Role_UserDef->get_enumeration();
}
package Misc;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "MISC" );
$self->set_prompt( "Specifies the location of a miscellaneous field [can be any of ris elements: M1, M2, M3] in the citation/reference. Determines how the field's contents are formatted." );
$self->set_help( "Specifies the location of a miscellaneous field [can be any of ris elements: M1, M2, M3] in the citation/reference. Determines how the field's contents are formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => [ "Role_Misc" ] ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
sub _test_attributes_mandatory { # override to prevent Role_Misc dialog
return Role_Misc->get_enumeration();
}
package Notes;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "NOTES" );
$self->set_prompt( "Specifies the location of notes [ris element: N1] in the citation/reference. Determines how the notes are formatted." );
$self->set_help( "Specifies the location of notes [ris element: N1] in the citation/reference. Determines how the notes are formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Abstract;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "ABSTRACT" );
$self->set_prompt( "Specifies the location of the abstract [ris element: AB|N2] in the citation/reference. Determines how the abstract is formatted." );
$self->set_help( "Specifies the location of the abstract [ris element: AB|N2] in the citation/reference. Determines how the abstract is formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
package Link;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "LINK" );
$self->set_prompt( "Specifies the location of a UR field or a link field [L1 - L4]. Determines how the field's contents are formatted." );
$self->set_help( "Specifies the location of a link field [can be any of UR, L1, L2, L3, L4] in the citation reference. Determines how the field's contents are formatted." );
$self->set_display( "name" );
$self->set_summary( "name" );
$self->set_attributes( {
mandatory => [ "Role_Link" ] ,
optional => [ "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
sub _test_attributes_mandatory { # override to prevent Role_Link dialog
return Role_Link->get_enumeration();
}
package Separator;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "SEPARATOR" );
$self->set_prompt( "Specifies the location of a pre-defined character sequence in the citation/reference. Determines what this character sequence is, eg. '. '." );
$self->set_help( "Specifies the location of a pre-defined character sequence in the citation/reference. Determines what this character sequence is, eg. '. '." );
$self->set_display( "content" );
$self->set_summary( "content" );
$self->set_content( {
allowed => 1 ,
suggestion => undef ,
value => undef ,
} );
return $self;
}
package CitStyle;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "CITSTYLE" );
$self->set_prompt( "Contains elements and attributes which determine the formatting of citations." );
$self->set_help( "Contains elements and attributes which determine the formatting of citations." );
$self->set_display( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "InTextSequence" , "Style" ] ,
} );
$self->set_order( [
[ "Preceeding" , "?" ] ,
[ "Following" , "?" ] ,
[ "CitSeparator" , "1" ] ,
[ "RangeSeparator" , "?" ] ,
[ "InTextDef" , "?" ] ,
[ "AuthorOnly" , "?" ] ,
[ "YearOnly" , "?" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
package CitSeparator;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "CITSEPARATOR" );
$self->set_prompt( "Determines what character(s) separates individual references in a multi-reference citation." );
$self->set_help( "Determines what character(s) separates individual references in a multi-reference citation." );
$self->set_display( undef );
$self->set_content( {
allowed => 1 ,
suggestion => ", " ,
value => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package BibStyle;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "BIBSTYLE" );
$self->set_prompt( "Contains elements and attributes which determine the formatting of bibliographies/reference lists." );
$self->set_help( "Contains elements and attributes which determine the formatting of bibliographies/reference lists." );
$self->set_display( "name" );
$self->set_attributes( {
mandatory => undef ,
optional => [ "BiblioSequence" , "BiblioFirstIndent" , "BiblioBlockIndent" , "FontSize" ] ,
} );
$self->set_order( [
[ "BiblioTitle" , "?" ] ,
[ "Months" , "?" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
package BiblioTitle;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "BIBLIOTITLE" );
$self->set_prompt( "Specifies the heading of the bibliography. Examples include 'Bibliography' and 'Reference List'." );
$self->set_help( "Specifies the heading of the bibliography. Examples include 'Bibliography' and 'Reference List'." );
$self->set_display( "name" );
$self->set_content( {
allowed => 1 ,
suggestion => "Bibliography" ,
value => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package InTextDef;
use base qw/ _Model_Noorder /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "INTEXTDEF" );
$self->set_prompt( "Contains elements which determine the formatting of 'regular', ie. author-year, citations (generated by <citation role=\"REFDB\">citekey</citation>)." );
$self->set_help( "Contains elements which determine the formatting of 'regular', ie. author-year, citations (generated by <citation role=\"REFDB\">citekey</citation>)." );
$self->set_display( "name" );
#$self->set_summary( "name" );
$self->reset_all_counters();
return $self;
}
# Class methods
sub default_copyable { undef; }
package AuthorOnly;
use base qw/ _Model_Noorder /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "AUTHORONLY" );
$self->set_prompt( "Contains elements which determine the formatting of author-only citations (generated by <citation role=\"REFDB\">A:citekey</citation>)." );
$self->set_help( "Contains elements which determine the formatting of author-only citations (generated by <citation role=\"REFDB\">A:citekey</citation>)." );
$self->set_display( "name" );
#$self->set_summary( "name" );
$self->reset_all_counters();
return $self;
}
# Class methods
sub default_copyable { undef; }
package YearOnly;
use base qw/ _Model_Noorder /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "YEARONLY" );
$self->set_prompt( "Contains elements which determine the formatting of year-only citations (generated by <citation role=\"REFDB\">Y:citekey</citation>)." );
$self->set_help( "Contains elements which determine the formatting of year-only citations (generated by <citation role=\"REFDB\">Y:citekey</citation>)." );
$self->set_display( "name" );
#$self->set_summary( "name" );
$self->reset_all_counters();
return $self;
}
# Class methods
sub default_copyable { undef; }
package Months;
use base qw/ _Model_Order /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "MONTHS" );
$self->set_prompt( "Contains elements determining the naming and abbreviation of months." );
$self->set_help( "Contains elements determining the naming and abbreviation of months." );
$self->set_display( "name" );
$self->set_order( [
[ "Jan" , "1" ] ,
[ "Feb" , "1" ] ,
[ "Mar" , "1" ] ,
[ "Apr" , "1" ] ,
[ "May" , "1" ] ,
[ "Jun" , "1" ] ,
[ "Jul" , "1" ] ,
[ "Aug" , "1" ] ,
[ "Sep" , "1" ] ,
[ "Oct" , "1" ] ,
[ "Nov" , "1" ] ,
[ "Dec" , "1" ] ,
] );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Jan;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "JAN" );
$self->set_prompt( "Determines the name and abbreviation of the first calendar month." );
$self->set_help( "Determines the name and abbreviation of the first calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Jan" , "Abbrev_Jan" , "Full_Jan" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Feb;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "FEB" );
$self->set_prompt( "Determines the name and abbreviation of the second calendar month." );
$self->set_help( "Determines the name and abbreviation of the second calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Feb" , "Abbrev_Feb" , "Full_Feb" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Mar;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "MAR" );
$self->set_prompt( "Determines the name and abbreviation of the third calendar month." );
$self->set_help( "Determines the name and abbreviation of the third calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Mar" , "Abbrev_Mar" , "Full_Mar" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Apr;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "APR" );
$self->set_prompt( "Determines the name and abbreviation of the fourth calendar month." );
$self->set_help( "Determines the name and abbreviation of the fourth calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Apr" , "Abbrev_Apr" , "Full_Apr" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package May;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "MAY" );
$self->set_prompt( "Determines the name and abbreviation of the fifth calendar month." );
$self->set_help( "Determines the name and abbreviation of the fifth calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_May" , "Abbrev_May" , "Full_May" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Jun;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "JUN" );
$self->set_prompt( "Determines the name and abbreviation of the sixth calendar month." );
$self->set_help( "Determines the name and abbreviation of the sixth calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Jun" , "Abbrev_Jun" , "Full_Jun" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Jul;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "JUL" );
$self->set_prompt( "Determines the name and abbreviation of the seventh calendar month." );
$self->set_help( "Determines the name and abbreviation of the seventh calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Jul" , "Abbrev_Jul" , "Full_Jul" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Aug;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "AUG" );
$self->set_prompt( "Determines the name and abbreviation of the eighth calendar month." );
$self->set_help( "Determines the name and abbreviation of the eighth calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Aug" , "Abbrev_Aug" , "Full_Aug" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Sep;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "SEP" );
$self->set_prompt( "Determines the name and abbreviation of the ninth calendar month." );
$self->set_help( "Determines the name and abbreviation of the ninth calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Sep" , "Abbrev_Sep" , "Full_Sep" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Oct;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "OCT" );
$self->set_prompt( "Determines the name and abbreviation of the tenth calendar month." );
$self->set_help( "Determines the name and abbreviation of the tenth calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Oct" , "Abbrev_Oct" , "Full_Oct" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Nov;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "NOV" );
$self->set_prompt( "Determines the name and abbreviation of the eleventh calendar month." );
$self->set_help( "Determines the name and abbreviation of the eleventh calendar month." );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Nov" , "Abbrev_Nov" , "Full_Nov" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
package Dec;
use base qw/ _Model_Childless /;
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->set_name( "DEC" );
$self->set_prompt( "Determines the name and abbreviation of the twelfth calendar month" );
$self->set_help( "Determines the name and abbreviation of the twelfth calendar month" );
$self->set_display( undef );
$self->set_attributes( {
mandatory => [ "Threelet_Dec" , "Abbrev_Dec" , "Full_Dec" ] ,
optional => undef ,
} );
return $self;
}
# Class methods
sub default_copyable { undef; }
=head1 USER-INTERFACE CLASS
This class holds the user-built bibliography style.
=cut
package UI;
use base qw/ _Base /;
=head2 UI: Public Interface
=head3 UI: Data members
%self = (
help => {
<help topic> => <help text> ,
...
} ,
cache => {
"element_class_A" => element_A ,
"element_class_B" => element_B ,
...
} ,
root => "undef" | element ,
filename => undef | <filename>,
)
=over
=cut
# Constructor
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
=item
B<help>
Introductory help system.
Is a hash consisting of E<lt>"help topic" : "help text"E<gt> pairs.
=cut
$self->{help} = $self->default_help();
=item
B<cache>
Cache for frequently used elements.
First hash key ("cachable") points to list of cachable elements.
Second has key points to subsidiary hash which holds key:value pairs of element class names and the corresponding element.
=cut
$self->{cache} = $self->default_cache();
=item
B<root>
Location of style's root element.
=cut
$self->{root} = $self->default_root();
=item
B<style_file>
Name of style file. Set after successful output.
=cut
$self->{style_file} = $self->default_style_file();
=item
B<summary_file>
Name of summary file. Set after successful output.
=back
=cut
$self->{summary_file} = $self->default_summary_file();
=head3 UI: Constructors
my $ui = UI->new();
=cut
return $self;
}
# Default values
sub default_help {
my $self = shift;
my $cache = {};
$cache->{"0. README"} =
"HELP TOPIC: README\n\nThis help consists of five topics (including this one):\n\n[RefDB]\nWhat RefDB is.\n\n[XML]\nThe format in which styles are specified. A (very) brief introduction to XML.\n\n[Styles]\nA brief summary of style structure and hints on how to write styles. You really should read this help topic.\n\n[Using this utility]\nSome notes on how to use this utility.\n\nThe help topics are designed to be read in the order they are listed above. The last two, in particular, should be read by first-time users of this utility.\n\nThis utility has a number of limitations regarding style file generation. Chief among them is that it cannot be used to edit an existing style. This tool is designed for the initial \"heavy lifting\" of generating the bulk of the style definition. Unless and until someone designs a utility to edit existing styles, any further refinement must be done \"by hand\". Remember, a style file is an xml file following the citestylex DTD. There are a number of tools which simplify the task of editing xml documents.\n\nIf you discover any bugs in this utility, please spend a few minutes to notify the refdb-users newsgroup (subscribe at <lists.sourceforge.net/lists/listinfo/refdb-users>). Session transcripts (use the 'script' utility, try 'man script' for details) and any xml output will greatly aid in troubleshooting problems.\n\nThis utility is released under the same copyright and use conditions as the RefDB project <refdb.sourceforge.net>.";
$cache->{"1. RefDB"} =
"HELP TOPIC: RefDB\n\nRefDB is a bibliography tool.\n\nRefDB's homepage (<http://refdb.sourceforge.net>) provides this summary:\n\n\"RefDB is a reference database and bibliography tool for SGML, XML, and LaTeX/BibTeX documents. It allows users to share databases over a network. It is lightweight and portable to basically all platforms with a decent C compiler. And it's released under the GNU General Public License.\"\n\nOne use for RefDB is formatting document bibliographies and citations. Such formatting includes:\n - which bibliographic elements -- such as volume, issue and title -- to include,\n - the order of bibliographic elements\n - appearance of bibliographic elements (eg. italicised, bolded, uppercase, etc.), and\n - punctuation between bibliographic elements.\n\nThe rules RefDB uses to format bibliographies and citations are specified in style files (see help topic <Styles>).\n\nThese style files are valid xml documents (see help topic <XML>).";
$cache->{"2. XML"} =
"HELP TOPIC: XML\n\nRefDB style files are well-formed XML files which conform to the \"citestylex\" dtd. While this utility makes generating style files easier than writing them \"by hand\", you should still have some understanding of xml before using it. This is the briefest of introductions to the topic. Several concepts are greatly simplified.\n\nXML is the \"eXtensible Markup Language\". For the purposes of RefDB stylesheets, the central feature of XML is \"elements\". An element is a unit of information. It has the following features: a name, opening and closing tags, attributes and content. Here is an example element:\n\n<ABBREVIATEFIRST DISPLAYAUTHOR=\"255\" MAXAUTHOR=\"256\" STYLE=\"ITALIC\">et al.</ABBREVIATEFIRST>\n\nName:\nThe element's name is ABBREVIATEFIRST.\n\nTags:\nThe element is bounded by opening and closing tags which consist primarily of the element name enclosed in angle brackets. The opening tag has the form '<ELEMENT>'. The closing tag has the form '</ELEMENT>' -- note the slash preceding the element name.\n\nAttributes:\nAn element can have associated attributes. Attributes have names and values. In the example element above there are three attributes: DISPLAYAUTHOR, MAXAUTHOR and STYLE. Attributes are placed inside an element's opening tag after the element name. They are separated by spaces. Most attributes have a list of possible legal values (an \"enumeration\"). Some can accept any value.\n\nContent:\nAn element's content appears between the opening and closing tags. There are few restrictions on element content.\n\n\nFinally, a note about DTDs. In order for XML documents to be useful there must be agreement about the meanings elements and attributes have. One means of specifying these meanings is a Document Type Definition (DTD). A DTD is a set of rules about what element names are legal and in what sequence they can occur, what attributes are associated with each element and what attribute values are legal. The \"citestylex\" DTD determines the structure of RefDB styles. This DTD is included with the RefDB installation.";
$cache->{"3. Styles"} =
"HELP TOPIC: Styles\n\nAs mentioned in help topic <RefDB> \"styles\" provide rules for RefDB to follow when formatting bibliographies and citations. Each style is defined in an XML document that conforms to the \"citestylex\" DTD (see help topic <XML> for the briefest of introductions to XML). It will be most advantageous to have some understanding of XML before attempting to use this utility.\n\nEach style file can be divided broadly into four sections.\n\nFIRST SECTION (STYLENAME element)\nThe first section specifies the xml version, the controlling DTD and the style name. It includes the STYLENAME element.\n\nSECOND SECTION (REFSTYLE and PUBSTYLE elements)\nThe second section contains formatting rules for bibliography references. The REFSTYLE element includes a number of PUBSTYLE elements. Each PUBSTYLE element contains a number of subsidiary elements. Each PUBSTYLE element and its children specify formatting rules for a particular type of publication. There are 35 possible publication types, including book, journal and electronic citation. The publication type each PUBTYPE applies to is determined by PUBTYPE's TYPE attribute.\n\nThere are two kinds of elements in each PUBTYPE. One type specifies a component of the reference, for example, the TITLE element signifies the title of each reference work and the AUTHORLIST signifies the list of authors of a given work. These elements have a one-to-one correspondence with reference record ris fields. For example, the VOLUME element corresponds to the ris VL field. (See help topic <Using this utility> for how to access this information while creating your style.) Their presence in the PUBTYPE signifies the presence of the associated component in the bibliography reference. Also, their location in the PUBTYPE signifies the location of the associated component in the bibliography reference. For example, if you put AUTHORLIST first in a PUBTYPE, then the authors will appear first in the reference. If you put REFNUMBER first, the reference will begin with a reference number.\n\nSome elements are simple -- VOLUME, for example, has only one attribute and two possible child elements. Other elements are complex -- AUTHORLIST, for example, has numerous possible child elements with many associated attributes. See help topic <Using this utility> for notes on the help available while using this utility.\n\nThe second type of element specifies formatting and punctuation. These elements include FOLLOWING, PRECEDING and SEPARATOR. FOLLOWING and PRECEDING are associated with parent elements. They appear in a reference only if their parent element does. For example, you may specify the VOLUME element with a PRECEDING element containing 'Vol. '. If a particular reference of that type contains a volume, for example '10', it will appear in the bibliography as 'Vol. 10'. If a particular reference of that type does not contain a volume, the text 'Vol. ' will not appear in the bibliography reference. SEPARATOR, on the other hand, is not associated with any parent elements and will always appear in the reference. It should be used carefully, especially if nearby reference components may be missing from some references.\n\nSome elements can occur an unlimited number of times in each PUBTYPE, for example, PRECEDING, FOLLOWING and even VOLUME and ISSUE. Others can occur a limited number of times: AUTHORLIST, for example, can occur no more than three times in a publication type, PUBDATE (publication date) no more than twice and TITLE no more than three times.\n\nAlthough there are 35 possible publication types you do not have to create a PUBTYPE for all of them. As mentioned above, if a publication type contains an element not found in a particular reference, that element (and associated elements) are simply \"dropped\" from the bibliography for that particular reference. PUBTYPE 'GEN' is the default publication type. You should create it first and then create PUBTYPES for any publication types whose requirements are not met by the 'GEN' PUBTYPE. For example, the 'GEN' PUBTYPE can be designed to meet the needs of an edited work -- it could contain two AUTHORLISTs and TITLEs, the first for the primary work and its authors and the second for the collection details and editors. It will then also serve the needs of books -- the secondary title and author/editor list will simply be left blank.\n\nWarning: Be careful assigning PRECEDING and FOLLOWING child elements to adjacent elements or you may end up with double punctuation in your references.\n\nTHIRD SECTION (CITSTYLE, INTEXTDEF, AUTHORONLY and YEARONLY elements)\nThese elements determine the formatting of in-text citations. RefDB provides for three types of citations: default (i.e., author-year), author-only and year only. The formatting of these citation types are handled, respectively, by the INTEXTDEF, AUTHORONLY and YEARONLY elements (and associated attributes and children elements). These elements follow a similar schema to that outlined for PUBTYPES: some elements specify the presence and order of citation components while other elements (and attributes) determine citation style.\n\nFOURTH SECTION (BIBSTYLE and BIBLIOTITLE elements)\nThe attributes associated with the BIBSTYLE element determine styling that affects the bibliography as a whole. The BIBLIOTITLE element determines the title of the bibliography/reference list.\n\n\nA final note:\nThe STYLESET element is not available for selection using this utility. Trust me, you won't need it.";
$cache->{"4. Using this utility"} =
"HELP TOPIC: Using this utility\n\nIn short, this utility consists of a loop in which you are asked to:\n\n - select an element from a list of elements allowed in that part of the style,\n - enter or select appropriate values for mandatory attributes,\n - select optional attributes for that element and enter their values,\n - select an element from a list of elements ...\n\nThis process ends when you have exhausted the DTD (see section <XML>).\n\nEvery time you are presented with a list of elements you have the option of selecting help. Doing so will present a screen with a summary of each element on the list. The same thing happens when you are presented with a list of attributes.\n\nWhen an attribute or element is required by the DTD this utility will select it automatically. For some objects you will not need to provide input and so this utility will create the object(s) automatically. This can be disconcerting at first. Please read the console feedback carefully.\n\nWhenever you are asked to enter or select a value for an attribute or element, you are given a brief prompt explaining the purpose of the element or attribute.\n\nAfter each element is added to the style you are presented with a \"progress report\" showing the (major) elements. It may take a little while to understand this feedback. As you add elements they will be appended to the report. When you complete a major element, such as a PUBTYPE or AUTHORLIST, however, its subsidiary elements are no longer displayed -- they are \"folded\". This saves space and makes it easier to quickly understand where in the style you are at that point in time. As you become more familiar with the structure of the style DTD this display will become increasingly useful.\n\nAt certain times within PUBTYPE, AUTHORONLY, YEARONLY and INTEXTDEF elements you are able to delete the previous \"major\" element. \"Major\" elements are those corresponding to ris fields. These elements may contain other elements. For example, deleting an AUTHORLIST element will delete all the children elements of that author list style. You can view the complete element before deletion occurs.\n\nWhen you select some elements (in general, those corresponding to ris fields) you will be given an opportunity to copy the most recently entered element of that type. If you choose to copy, all attributes and sub-elements will be copied. This can save you a lot of time if, for example, your author lists will always have the same formatting.\n\nAfter you have created your style this utility will save it to a disk file. It will also generate a brief summary of it in html format. This summary can be of great help when entering references in your reference database.\n\nDepending on the version of this utility and the configuration of your system, this utility may offer to upload the style to RefDB. There is no foreseeable way in which this operation could damage your reference data, but you use it at your own risk...";
return $cache;
}
sub default_cache {
my $self = shift;
my @cachable_elements = (
"RefNumber" ,
"AuthorList" ,
"PubDate" ,
"Title" ,
"JournalName" ,
"Volume" ,
"Issue" ,
"Pages" ,
"Publisher" ,
"PubPlace" ,
"Serial" ,
"Address" ,
"UserDef" ,
"Abstract" ,
);
my $cache = {};
foreach ( @cachable_elements ) {
$cache->{$_} = undef;
}
return $cache;
}
sub default_root { undef; }
sub default_style_file { undef; }
sub default_summary_file { undef; }
=head3 UI: Setters
$ui->set_root( <element> );
$ui->set_style_file( "<filename>" );
$ui->set_summary_file( "<filename>" );
=cut
sub set_root { $_[0]->{root} = $_[1]; }
sub set_style_file { $_[0]->{style_file} = $_[1]; }
sub set_summary_file { $_[0]->{summary_file} = $_[1]; }
=head3 UI: Getters
$ui->get_help_topics(); # list: keys ( $self->{help} )
$ui->get_help( "<topic>" ); # scalar: value ( $self->{help}->{<topic>} )
# takes parameter: help topic
$ui->get_cachable(); # list: $self->{cache}->{cachable}
$ui->get_cached(); # list: defined( $self->{cache}->{elements} )
$ui->get_cached_element( "<class>" );
# object: cached element
$ui->get_root(); # object: root element
$ui->get_style_file(); # scalar: style file filename
$ui->get_summary_file(); # scalar: summary file filename
=cut
sub get_help_topics { return keys %{ $_[0]->{help} }; }
sub get_help { return $_[0]->{help}->{$_[1]}; }
sub get_cachable { return @{ $_[0]->{cache}->{cachable} }; }
sub get_cached { return keys %{ $_[0]->{cache} }; }
sub get_cached_element { return $_[0]->{cache}->{$_[1]}; }
sub get_root { return $_[0]->{root}; }
sub get_style_file { return $_[0]->{style_file}; }
sub get_summary_file { return $_[0]->{summary_file}; }
=head3 UI: Other methods
=over
=item
B<$ui-E<gt>help_system();>
Runs help system -- a menu allowing the selection of a series of
=cut
sub help_system {
my ( $self , $choice ) = ( shift , undef );
my @topics = sort $self->get_help_topics();
print "This is the help system.\n";
push @topics , "[EXIT]";
while ( 1 ) {
while ( 1 ) {
$choice = $self->_input_choice( "Select help topic:" , @topics );
if ( defined( $choice ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
if ( $choice eq "[EXIT]" ) { last; }
$self->_view( "" , $self->get_help( $choice ) );
}
print "Exiting help system.\n";
}
=item
B<$ui-E<gt>get_last_parent();>
Returns reference to last parent element.
=cut
sub get_last_parent {
my ( $self , $choice ) = ( shift , undef );
my @topics = sort $self->get_help_topics();
print "This is the help system.\n";
push @topics , "[EXIT]";
while ( 1 ) {
while ( 1 ) {
$choice = $self->_input_choice( "Select help topic:" , @topics );
if ( defined( $choice ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
if ( $choice eq "[EXIT]" ) { last; }
$self->_view( "" , $self->get_help( $choice ) );
}
print "Exiting help system.\n";
}
=item
B<$ui-E<gt>can_copy_recent();>
Returns booelan indicating whether element can copy recent version of itself.
Parameters: [ 0 = class ] , 1 = element class | object
=cut
sub can_copy_recent {
my ( $self , $element ) = ( shift , shift );
$element = ref( $element ) ? $element->get_classname() : $element;
my @allowable = (
"RefNumber" ,
"AuthorList" ,
"PubDate" ,
"Title" ,
"JournalName" ,
"Volume" ,
"Issue" ,
"Pages" ,
"Publisher" ,
"PubPlace" ,
"Serial" ,
"Address" ,
"UserDef" ,
"Abstract" ,
);
return grep /\b$element\b/ , @allowable;
}
=item
B<$el-E<gt>delete_selected_element();>
Gives the user the option of deleting element(s).
Depending on the state of the element tree, the user can delete the last element or the last major ("named") element. A "named" element has its 'display' data member set to 'name' -- in general they are the elements corresponding to ris fields.
A "complete" element has had all children added and its 'children-E<gt>complete' data member is set to true ("1").
Algorithm is:
get last named element
if element is complete
repeat until last named element is deleted
delete last element
endrepeat
else
delete last element only
endif
=cut
sub delete_selected_element {
my ( $self , $xml ) = ( shift );
my $last_named = $self->get_root()->get_last_named();
my @xml = $last_named->generate_full_xml();
my $prompt = sprintf( "\nDelete back to (and including) %s?" ,
$last_named->get_name() );
my @options = qw/ Yes No View /;
my $choice = undef;
while ( 1 ) {
$choice = $self->_input_choice( $prompt , @options );
# switch: $choice
# case: 'View'
( $choice eq 'View' ) and do {
$self->_view( "Element " . $last_named->get_name() , $xml[1] );
next;
};
# case: 'Yes'
( $choice eq 'Yes' ) and do {
my ( $report , @names ) = ( "\nDeleted: " , () );
while ( 1 ) {
my $deleted = $self->get_root()->delete_last_element();
push @names , $deleted->get_name();
last if $deleted->get_classname() eq $last_named->get_classname();
}
$report .= shift @names;
$report .= sprintf( ", %s" , shift @names ) while @names;
$report .= ".\n";
$self->_display( $report );
return;
};
# case: 'No'
( $choice eq 'No' ) and do {
return;
};
# case: default
( not grep $choice eq $_ , @options ) and do {
die "No matching case block for \"$choice\"";
};
# endswitch
}
}
=item
B<$ui-E<gt>create_element();>
Creates element. If element of class already exists, user can duplicate most recent.
=cut
sub create_element {
my ( $self , $class , $element ) = ( shift , shift );
$element = $self->get_root()->get_most_recent( $class );
if ( $element &&
$self->can_copy_recent( $element ) &&
$element->is_duplicatable() ) {
my @xml = $element->generate_full_xml();
my $prompt = sprintf "\nElement %s previously used. Copy most recent?" , $element->get_name();
my @options = qw/ Yes No View /;
my $choice = undef;
while ( 1 ) {
$choice = $self->_input_choice( $prompt , @options );
# switch: $choice
# case: 'View'
( $choice eq 'View' ) and do {
$self->_view( "Most recent " . $element->get_name() , $xml[1] );
next;
};
# case: 'Yes'
( $choice eq 'Yes' ) and do {
my $duplicate = $element->duplicate();
$duplicate->set_complete( 1 );
return $duplicate;
};
# case: 'No'
( $choice eq 'No' ) and do {
last;
};
# case: default
( not grep $choice eq $_ , @options ) and do {
die "No matching case block for \"$choice\"";
};
# endswitch
}
}
$element = $class->new();
$element->add_attributes();
$element->enter_value();
return $element;
}
=item
B<$ui-E<gt>startup_checks();>
Currently checks for: write access to current directory.
=cut
sub startup_checks {
my ( $self , $return ) = ( shift , 1 );
# Check for local disk read/write access
# Failure = Fatal error
eval {
my ($fh, $filename) = File::Temp::tempfile( TEMPLATE => 'XXXXXXXX' ,
DIR => './' ,
UNLINK => 1 ,
);
};
if ($@) {
print "Unable to create a file in the current directory.\n";
$return = 0;
}
return $return;
}
=item
B<$ui-E<gt>get_output_filename();>
Returns filename for output file. Uses File::Temp module.
If filename does not exist in current directory, simply return default.
If it does, then user must select new filename. File::Temp is used to provide a suggestion based on the default filename.
Requires the following parameters: [ 0 = class ] , 1 = default filename , 2 = filename template pattern , 3 = filename template suffix , 4 = prompt.
Parameters 2 and 3 are in the format required by File::Temp. Parameter 2 must end in at leat 4 'X's -- these will be replaced with random digits. The suffix is the part of the filename following the part specified by parameter 2. It is not restricted to a DOS-style three letter extension.
Example: Default filename (parameter 1) = 'experimental-style.xml'. Filename template pattern (parameter 2) = 'experimental-XXXX'. Filename template suffix (parameter 3) = '-style.xml'. Prompt (parameter 4) = 'Enter name for style file:'.
=cut
sub get_output_filename {
my ( $self , $default , $template , $suffix , $prompt ) =
( shift , shift , shift , shift , shift );
my $filename = $default;
if ( -e $filename ) {
printf "\nWarning: Default filename <%s> already exists.\n", $filename;
( undef , $filename) = File::Temp::tempfile( $template ,
SUFFIX => $suffix ,
UNLINK => 1 ,
);
while ( 1 ) {
$filename = $self->_input_ask( $prompt , $filename );
last if ( ( $filename )
&& ( not -e $filename )
&& ( $filename =~ /^(\w|\.|\-)+$/ ) ); # no spaces
print "Invalid filename. Please try again.\n\n";
}
}
return $filename;
}
=item
B<$ui-E<gt>write_style();>
Writes style to file. Checks filename doesn't already exist. If so, proposes alternative.
=cut
sub write_style {
my ( $self , $return ) = ( shift , 0 );
print "\nOutputting style to file.\n";
my $stylename = $self->get_root()->get_style_name();
my $filename = $self->get_output_filename(
sprintf( "%s-style.xml" , $stylename ) ,
sprintf( "%s-style-XXXX" , $stylename ) ,
".xml" ,
"Enter filename for style file:" );
my @xml = $self->get_root()->generate_full_xml();
open FH , "> $filename" or die "Cannot create stylefile: $!";
print FH "<?xml version=\"1.0\"?>\n<!DOCTYPE CITESTYLE PUBLIC \n\t\"-//Markus Hoenicka//DTD CiteStyle V1.4//EN\" \n\t\"http://refdb.sourceforge.net/dtd/citestylex-1.4/citestylex.dtd\">\n";
print FH $xml[1];
close FH;
$self->set_style_file( $filename );
printf "Style file successfully written to <%s>.\n" , $filename;
return $filename;
}
=item
B<$ui-E<gt>write_summary();>
Writes style summary to file. Checks filename doesn't already exist. If so, proposes alternative.
=cut
sub write_summary {
my $self = shift;
print "\nOutputting style summary to file.\n";
my $stylename = $self->get_root()->get_style_name();
my $filename = $self->get_output_filename(
sprintf( "%s-summary.html" , $stylename ) ,
sprintf( "%s-summary-XXXX" , $stylename ) ,
".html" ,
"Enter filename for summary file:" );
open FH , "> $filename" or die "Cannot create summary file: $!";
print FH $self->get_root()->generate_summary();
close FH;
$self->set_summary_file( $filename );
printf "Summary successfully written to <%s>.\n" , $filename;
return $filename;
}
=item
B<$ui-E<gt>get_command_base();>
Gets base for refdba commands. Involves checking for access to refdba. Also determines whether username and password required.
If succeeds, returns base command of the form:
refdba [-u <username> -w <password>] -C
If fails, returns C<undef>.
=cut
sub get_command_base {
my ( $self ) = ( shift );
my ( $command_base , %_ACCESS );
print "\n";
$self->_display( "The RefDB administrative client (refdba) needs the user's username and password whenever it is invoked. To save typing them every time refdba is run some users put this information in refdba's configuration file.\n" );
while ( 1 ) {
my $choice;
print "\n";
while ( 1 ) {
$choice = $self->_input_choice( "\nHas refdba been configured to know your username and password? ('No' if unsure)" , ( "Yes" , "No" , "Abort" ) );
if ( defined( $choice ) ) { last; }
print "Invalid choice. Sorry, please try again.\n";
}
# SWITCH: $choice
# case: 'No'
( grep /\b$choice\b/ , ( "No" ) ) and do {
my ( $username , $password );
print "\n";
while ( 1 ) {
$username = $self->_input_ask( "Enter RefDB username:" , $_ACCESS{username} );
last if $username;
}
$_ACCESS{username} = $username;
while ( 1 ) {
$password = $self->_input_ask( "Enter RefDB password:" , $_ACCESS{password} );
last if $password;
}
$_ACCESS{password} = $password;
};
# case: 'Yes' | 'No'
( grep /\b$choice\b/ , ( "Yes" , "No" ) ) and do {
$command_base = "refdba";
$command_base .= sprintf( " -u %s" , $_ACCESS{username} ) if $_ACCESS{username};
$command_base .= sprintf( " -w %s" , $_ACCESS{password} ) if $_ACCESS{password};
$command_base .= " -C";
my $command = sprintf "%s liststyle" , $command_base;
print "\nLet's test access to refdba by getting a list of current styles...\n--------------------\n";
if ( !system $command ) {
print "--------------------\nIt appears I have access to refdba.\n";
last;
} else {
print "--------------------\nIt appears I am currently unable to access refdba.\n\nPossible causes include:\n - incorrect username or password,\n - you do not have access to, or permission to run, refdba,\n - the RefDB server (refdbd) is not running or is unreachable, and\n - RefDB is not installed on this system.\n\nLet's try again.\n";
next;
}
};
# case: 'Abort upload'
( grep /\b$choice\b/ , ( "Abort" ) ) and do {
$command_base = undef;
last;
};
# case: default
( not grep /\b$choice\b/ , ( "Yes" , "No" , "Abort" ) ) and do {
die "No matching case block for \"$choice\"";
};
}
return $command_base;
}
=item
B<$ui-E<gt>upload_style();>
Uploads style to refdb. If style of same name already exists, attempt to save it to disk.
=cut
sub upload_style {
my ( $self , $command_base , $command , $exit_status ) = ( shift );
my $stylefile = $self->get_style_file();
my $stylename = $self->get_root()->get_style_name();
print "\n";
return if not $self->_input_confirm( "Do you want to upload the style to RefDB now?\n\nYou will be asked before any styles are overwritten.\n\nThis process requires a running RefDB server (refdbd) and access to a RefDB administrative client (refdba). If you don't understand the last sentence you should probably answer 'No' here and consult the RefDB manual and/or contact your system administrator." );
$command_base = $self->get_command_base();
if ( not $command_base ) {
printf "\nUpload of style \"%s\" was cancelled.\n";
return 0;
}
$command = sprintf "%s liststyle" , $command_base;
my @stylelist = `$command`;
if ( grep /\b$stylename\b/ , @stylelist ) {
printf "\nThere is already a style named \"%s\". I will back it up to a file.\n" , $stylename;
my $filename = $self->get_output_filename(
sprintf( "old-%s-style.xml" , $stylename ) ,
sprintf( "old-%s-XXXX" , $stylename ) ,
"-style.xml" ,
"Enter filename for style backup file:" );
$command = sprintf "%s getstyle -c stdout -o %s %s" , $command_base , $filename , $stylename;
print "Backing up ...\n--------------------\n";
$exit_status = !system $command;
print "--------------------\n";
if ( $exit_status && -f $filename && -s $filename ) {
printf "Pre-existing style \"%s\" was backed up to <%s>.\n" , $stylename , $filename;
} else {
printf "The backup of pre-existing style \"%s\" was unsuccessful.\n" , $stylename;
my $prompt = sprintf "Do you still want to upload style \"%s\"?\n\nThe pre-existing style of that name will be over-written." , $stylename;
if ( not $self->_input_confirm( $prompt ) ) { return 0; }
}
}
$command = sprintf "%s addstyle -c stdout %s" , $command_base , $stylefile;
printf "Uploading style \"%s\"...\n--------------------\n" , $stylename;
$exit_status = !system $command;
print "--------------------\n";
if ( $exit_status ) {
printf "\nStyle \"%s\" successfully uploaded to refdb.\n" , $stylename;
} else {
print "\nUpload of style \"%s\" was unsuccessful.\n" , $stylename;
}
return;
}
=back
=cut
1;
__END__
=head1 AUTHOR
David Nebauer, david E<lt>atE<gt> nebauer E<lt>dotE<gt> org
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2004 by David Nebauer
This library is distributed under the same license and conditions as the C<RefDB> project E<lt>L<http://refdb.sourceforge.net/>E<gt>.
=cut
|