Yeah, I think it is doable (revision number) without much of a hassle. Not sure what others think though? I'll wait for some feedback from the community perhaps?
On Sun, Mar 18, 2018 at 7:43 PM, Michael Brohl <[email protected]> wrote: > Hi Taher, > > thank you :-) > > The release number is just meant as an example in the course of playing with > the documentation framework. I know it's wrong and should be adjusted. > > I think it might be helpful to have the exact release version (if in a > release branch) so we can provide generated pdf files for every release. If > we have significant content in there and move the documentation from wiki to > asciidoc, I hope that we have less trouble with outdated documentation or > users using the wrong documentation for their release. > > So for releases, I am in favor of (manually?) adjusting the release number > in the doc or including the VERSION file (there's an open proposal in [1]). > I am not sure if this is possible in the configuration section of asciidoc. > > For the trunk, we could render just trunk or the build revision (if > possible). > > Thanks, > > Michael Brohl > ecomify GmbH > www.ecomify.de > > [1] https://issues.apache.org/jira/browse/OFBIZ-10141 > > > Am 18.03.18 um 17:31 schrieb Taher Alkhateeb: > >> Now that I think about it, maybe we can actually even go as far as >> publishing the subversion revision number on each call to >> generateOfbizDocumentation if you folks think this is useful? >> >> On Sun, Mar 18, 2018 at 7:29 PM, Taher Alkhateeb >> <[email protected]> wrote: >>> >>> Beautiful :) I love it >>> >>> Release 17.12 though? Shouldn't we call it trunk / snapshot for now >>> and then rename it for each release? >>> >>> On Sun, Mar 18, 2018 at 7:24 PM, <[email protected]> wrote: >>>> >>>> Author: mbrohl >>>> Date: Sun Mar 18 16:24:31 2018 >>>> New Revision: 1827146 >>>> >>>> URL: http://svn.apache.org/viewvc?rev=1827146&view=rev >>>> Log: >>>> Improved: Added title page image in vector format, some basic author >>>> and version information and table of contents configuration. >>>> >>>> Added: >>>> ofbiz/ofbiz-framework/trunk/docs/asciidoc/images/OFBiz-Logo.svg >>>> (with props) >>>> Modified: >>>> ofbiz/ofbiz-framework/trunk/docs/asciidoc/developer-manual.adoc >>>> ofbiz/ofbiz-framework/trunk/docs/asciidoc/user-manual.adoc >>>> >>>> Modified: >>>> ofbiz/ofbiz-framework/trunk/docs/asciidoc/developer-manual.adoc >>>> URL: >>>> http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/docs/asciidoc/developer-manual.adoc?rev=1827146&r1=1827145&r2=1827146&view=diff >>>> >>>> ============================================================================== >>>> --- ofbiz/ofbiz-framework/trunk/docs/asciidoc/developer-manual.adoc >>>> (original) >>>> +++ ofbiz/ofbiz-framework/trunk/docs/asciidoc/developer-manual.adoc Sun >>>> Mar 18 16:24:31 2018 >>>> @@ -17,9 +17,17 @@ specific language governing permissions >>>> under the License. >>>> //// >>>> = Apache OFBiz Developer Manual >>>> +The Apache OFBiz Project >>>> +Release 17.12: >>>> +:doctype: book >>>> :sectnums: >>>> +:toc: >>>> +:toclevels: 5 >>>> :imagesdir: ./images >>>> +ifdef::backend-pdf[] >>>> +:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, >>>> pdfwidth=4.25in, align=center] >>>> +endif::[] >>>> >>>> -image::OFBiz-Logo-250w.png[Apache OFBiz Logo, align="center"] >>>> +== Intro >>>> >>>> content goes here >>>> >>>> Added: ofbiz/ofbiz-framework/trunk/docs/asciidoc/images/OFBiz-Logo.svg >>>> URL: >>>> http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/docs/asciidoc/images/OFBiz-Logo.svg?rev=1827146&view=auto >>>> >>>> ============================================================================== >>>> --- ofbiz/ofbiz-framework/trunk/docs/asciidoc/images/OFBiz-Logo.svg >>>> (added) >>>> +++ ofbiz/ofbiz-framework/trunk/docs/asciidoc/images/OFBiz-Logo.svg Sun >>>> Mar 18 16:24:31 2018 >>>> @@ -0,0 +1,23 @@ >>>> +<?xml version="1.0" encoding="UTF-8" standalone="no"?> >>>> +<svg width="1600px" height="750px" viewBox="0 0 1600 750" version="1.1" >>>> xmlns="http://www.w3.org/2000/svg"; >>>> xmlns:xlink="http://www.w3.org/1999/xlink";> >>>> + <!-- Generator: Sketch 39.1 (31720) - >>>> http://www.bohemiancoding.com/sketch --> >>>> + <title>OFBiz-Logo</title> >>>> + <desc>Created with Sketch.</desc> >>>> + <defs> >>>> + <linearGradient x1="43.0920252%" y1="100%" x2="51.9198469%" >>>> y2="0%" id="linearGradient-1"> >>>> + <stop stop-color="#282662" offset="0%"></stop> >>>> + <stop stop-color="#792B81" offset="25%"></stop> >>>> + <stop stop-color="#CB2039" offset="50%"></stop> >>>> + <stop stop-color="#DB4F32" offset="75%"></stop> >>>> + <stop stop-color="#F69A25" offset="100%"></stop> >>>> + </linearGradient> >>>> + </defs> >>>> + <g id="Page-1" stroke="none" stroke-width="1" fill="none" >>>> fill-rule="evenodd"> >>>> + <g id="OFBiz-Logo"> >>>> + <path d="M1254,366.596541 C1254,356.513539 >>>> 1257.06832,348.893454 1263.20506,343.736057 C1269.3418,338.57866 >>>> 1278.03,336 >>>> 1289.26992,336 C1298.70112,336 1305.8713,337.79637 1310.78069,341.389163 >>>> C1315.69008,344.981957 1318.14474,350.139277 1318.14474,356.861278 >>>> C1318.14474,366.133003 1315.30251,373.637193 1309.61795,379.374073 >>>> C1303.93339,385.110953 1295.1483,387.97935 1283.26241,387.97935 >>>> C1263.75404,387.97935 1254,380.851818 1254,366.596541 L1254,366.596541 >>>> L1254,366.596541 Z M1261.92919,586.89927 C1259.38969,597.645793 >>>> 1248.37649,606.357571 1237.3384,606.357571 L1199,606.357571 >>>> L1240.33024,431.458302 C1242.86974,420.711778 1253.88295,412 1264.92103,412 >>>> L1303.25943,412 L1261.92919,586.89927 L1261.92919,586.89927 Z >>>> M802.67211,443.092658 C802.67211,475.891386 796.277078,505.241752 >>>> 783.486824,531.144634 C770.69657,557.047517 753.190979,576.604769 >>>> 730.969527,589.816978 C708.748075,603.029187 683.16795,609.635192 >>>> 654.228385,609.635192 C621.154596,609.635192 595.348384,601.087 >>>> 948 576.808975,583.993205 C558.269566,566.898461 549,543.168995 >>>> 549,512.804094 C549,482.091504 555.395031,453.84214 568.185286,428.055153 >>>> C580.97554,402.268167 598.610323,382.479125 621.090164,368.687434 >>>> C643.570005,354.895742 669.537708,348 698.994051,348 C731.938646,348 >>>> 757.454174,356.344428 775.541403,373.033533 C793.628631,389.722639 >>>> 802.67211,413.075447 802.67211,443.092658 L802.67211,443.092658 >>>> L802.67211,443.092658 Z M694.149282,392.851747 C678.516749,392.851747 >>>> 664.176376,398.153936 651.127732,408.758471 C638.079089,419.363007 >>>> 627.84058,433.936782 620.411896,452.480233 C612.983213,471.023684 >>>> 609.268928,491.131436 609.268928,512.804094 C609.268928,529.84089 >>>> 613.56458,542.705216 622.156013,551.397458 C630.747447,560.089701 >>>> 642.859248,564.435757 658.491782,564.435757 C674.124315,564.435757 >>>> 688.367793,559.394332 701.222645,549.31133 C714.077497,539.228329 >>>> 724.122217,524.973265 731.357109,506.545711 C738.592,488.118157 >>>> 742.209391,467.43093 742.209391,444.48341 C742.209391,428.026 >>>> 097 738.010634,415.30664 729.612992,406.324656 C721.21535,397.342672 >>>> 709.394232,392.851747 694.149282,392.851747 L694.149282,392.851747 >>>> L694.149282,392.851747 Z M858.803488,586.68017 C856.293096,597.437651 >>>> 845.31317,606.158312 834.267971,606.158312 L795.151838,606.158312 >>>> L850.446191,371.46741 C852.979517,360.714979 863.99484,351.998412 >>>> 875.031785,351.998412 L1012.77887,351.998412 L1006.92698,376.690762 >>>> C1004.37939,387.440444 993.360505,396.154783 982.318072,396.154783 >>>> L903.868457,396.154783 L888.558986,461.693964 L980.222018,461.693964 >>>> L974.161294,486.257086 C971.514989,496.982127 960.413802,505.676491 >>>> 949.367162,505.676491 L877.706704,505.676491 L858.803488,586.68017 >>>> L858.803488,586.68017 Z M1120.43621,352 C1150.02175,352 >>>> 1172.37206,356.722714 1187.48782,366.168284 C1202.60357,375.613855 >>>> 1210.16133,389.72405 1210.16133,408.499294 C1210.16133,425.883779 >>>> 1204.79984,440.225764 1194.0767,451.525679 C1183.35356,462.825595 >>>> 1168.10884,470.329785 1148.34208,474.038475 L1148.34208,475.08153 >>>> 9 C1161.26153,478.09485 1171.56464,483.686775 1179.25171,491.857483 >>>> C1186.93878,500.028191 1190.78226,510.487699 1190.78226,523.236322 >>>> C1190.78226,549.776636 1180.89903,570.232073 1161.13227,584.603247 >>>> C1141.36552,598.974421 1114.04129,606.159901 1079.15878,606.159901 >>>> L978,606.159901 L1033.29435,371.468998 C1035.82768,360.716567 >>>> 1046.83392,352 >>>> 1057.87874,352 L1120.43621,352 L1120.43621,352 Z M1073,452.499294 >>>> L1101.87482,452.499294 C1117.50736,452.499294 1129.23158,449.688844 >>>> 1137.04785,444.067861 C1144.86411,438.446877 1148.77219,430.363213 >>>> 1148.77219,419.816625 C1148.77219,403.938796 1137.79082,396 1115.82776,396 >>>> L1086.37156,396 L1073,452.499294 L1073,452.499294 Z M1047,561.234557 >>>> L1081.88234,561.234557 C1096.99809,561.234557 1108.85151,557.873607 >>>> 1117.44294,551.151606 C1126.03438,544.429605 1130.33003,535.100071 >>>> 1130.33003,523.162725 C1130.33003,504.387481 1118.50891,495 1094.86632,495 >>>> L1062.89084,495 L1047,561.234557 L1047,561.234557 Z M1441.63074,586.875929 >>>> C1439.10841,597.63534 >>>> 3 1428.11462,606.357571 1417.06075,606.357571 L1283,606.357571 >>>> L1289.78268,575.065655 L1401.21237,452.505648 L1324.27743,452.505648 >>>> L1329.42173,431.422349 C1332.03903,420.695682 1343.11561,412 1354.16039,412 >>>> L1479.50383,412 L1471.17083,446.768796 L1361.48526,565.851924 >>>> L1446.5594,565.851924 L1441.63074,586.875929 L1441.63074,586.875929 Z" >>>> id="OFBiz" fill="#E05D30"></path> >>>> + <path d="M497.643967,164.64682 C650.145968,122.220991 >>>> 772.408371,153.533209 780.378034,242.933073 C782.714022,269.174369 >>>> 774.96919,297.784584 759.071547,326.874947 L834.599576,326.870159 >>>> C852.802343,295.102316 863.89684,258.359488 861.527095,229.422426 >>>> C852.813704,123.34646 694.945422,90.6127419 498.320856,147.915732 >>>> L498.854439,134.726798 C499.367546,121.057066 478.324364,116.837941 >>>> 451.798072,125.241481 C425.311324,133.70287 403.357666,151.602332 >>>> 402.792477,165.250853 L402.119194,182.139637 C201.372455,266.531777 >>>> 51.4738766,412.981291 60.3767536,521.298877 C69.9078162,637.015309 >>>> 256.945999,665.501149 478.170432,584.880775 C493.670466,579.234905 >>>> 508.92668,573.202885 523.893942,566.827195 L523.889654,521.158149 >>>> C509.604745,527.781023 494.628751,533.952243 479.339391,539.602318 >>>> C304.263742,604.411581 155.169451,576.648854 146.345357,477.602592 >>>> C138.297652,387.444238 249.309274,269.246192 401.410676,199.912235 >>>> L399.586521,245.669719 C399.052196,259.344272 420.084768,263.57 >>>> 4966 446.607202,255.163713 C473.09395,246.743783 495.052431,228.808647 >>>> 495.602188,215.114811 L497.643967,164.64682 L497.643967,164.64682 Z >>>> M541.142188,320.379172 C542.947708,349.315271 499.253544,392.598899 >>>> 443.553443,417.013129 C387.823442,441.458212 341.228101,437.797331 >>>> 339.401362,408.870874 C337.609345,379.943454 381.330515,336.660789 >>>> 437.040261,312.225348 C492.742291,287.765803 539.376212,291.432469 >>>> 541.142188,320.379172 L541.142188,320.379172 Z" id="Bug" >>>> fill="url(#linearGradient-1)"></path> >>>> + <path d="M1520.01325,412 C1523.3709,412 >>>> 1526.64898,412.861489 1529.84758,414.584493 C1533.04618,416.307497 >>>> 1535.53787,418.772681 1537.32273,421.980119 C1539.10759,425.187557 >>>> 1540,428.531902 1540,432.013254 C1540,435.459262 1539.12084,438.772681 >>>> 1537.36249,441.953612 C1535.60414,445.134542 1533.13896,447.604144 >>>> 1529.96687,449.362492 C1526.79477,451.120839 1523.47693,452 1520.01325,452 >>>> C1516.54957,452 1513.23174,451.120839 1510.05964,449.362492 >>>> C1506.88755,447.604144 1504.41795,445.134542 1502.65076,441.953612 >>>> C1500.88358,438.772681 1500,435.459262 1500,432.013254 C1500,428.531902 >>>> 1500.89683,425.187557 1502.69052,421.980119 C1504.48421,418.772681 >>>> 1506.98032,416.307497 1510.17893,414.584493 C1513.37753,412.861489 >>>> 1516.65561,412 1520.01325,412 L1520.01325,412 L1520.01325,412 Z >>>> M1520.01325,415.313453 C1517.20343,415.313453 1514.46876,416.033569 >>>> 1511.80915,417.473824 C1509.14953,418.914078 1507.06871,420.972816 >>>> 1505.5666,423.650099 C1504.06449,426.327383 1503.31345,429.115073 >>>> 1503.31345,432.013254 C1503.31345,434.893763 1504.05124,437.654946 >>>> 1505.52684,440.296885 C1507.00244,442.938825 1509.06559,444.997563 >>>> 1511.71637,446.473161 C1514.36714,447.948759 1517.13274,448.686547 >>>> 1520.01325,448.686547 C1522.89376,448.686547 1525.65936,447.948759 >>>> 1528.31014,446.473161 C1530.96091,444.997563 1533.01965,442.938825 >>>> 1534.48641,440.296885 C1535.95318,437.654946 1536.68655,434.893763 >>>> 1536.68655,432.013254 C1536.68655,429.115073 1535.93992,426.327383 >>>> 1534.44665,423.650099 C1532.95338,420.972816 1530.87256,418.914078 >>>> 1528.20411,417.473824 C1525.53566,416.033569 1522.8054,415.313453 >>>> 1520.01325,415.313453 L1520.01325,415.313453 L1520.01325,415.313453 Z >>>> M1511.23923,443.066932 L1511.23923,421.542744 L1518.63486,421.542744 >>>> C1521.16193,421.542744 1522.99094,421.741549 1524.12194,422.139165 >>>> C1525.25293,422.536781 1526.15418,423.23039 1526.82571,424.220013 >>>> C1527.49724,425.209636 1527.833,426.261094 1527.833,427.37442 >>>> C1527.833,428.947214 1527.27193,430.31676 1526.14977,431.4831 >>>> 01 C1525.02761,432.649443 1523.53878,433.303291 1521.68323,433.444665 >>>> C1522.44312,433.762758 1523.05279,434.142697 1523.51226,434.584493 >>>> C1524.37818,435.432741 1525.43847,436.855303 1526.69317,438.85222 >>>> L1529.31743,443.066932 L1525.07621,443.066932 L1523.16766,439.673956 >>>> C1521.66555,437.005509 1520.45505,435.335546 1519.53612,434.664016 >>>> C1518.89993,434.169205 1517.97217,433.921803 1516.75282,433.921803 >>>> L1514.71173,433.921803 L1514.71173,443.066932 L1511.23923,443.066932 >>>> L1511.23923,443.066932 Z M1514.71173,430.952949 L1518.92644,430.952949 >>>> C1520.94103,430.952949 1522.315,430.652532 1523.04838,430.05169 >>>> C1523.78176,429.450847 1524.14844,428.655627 1524.14844,427.666004 >>>> C1524.14844,427.029818 1523.97173,426.45991 1523.61829,425.956262 >>>> C1523.26485,425.452615 1522.77447,425.077094 1522.14712,424.829689 >>>> C1521.51977,424.582283 1520.35786,424.458582 1518.66137,424.458582 >>>> L1514.71173,424.458582 L1514.71173,430.952949 L1514.71173,430.952949 Z" >>>> id="®" fill="#E05D30"></path> >>>> + <path d="M887.325646,300.366454 L875.672642,326.731376 >>>> L863,326.731376 L909.830511,222.291325 L922.211828,222.291325 >>>> L968.896676,326.731376 L955.932709,326.731376 L944.279705,300.366454 >>>> L887.325646,300.366454 Z M915.657013,235.910774 L892.423836,288.859112 >>>> L939.254347,288.859112 L915.657013,235.910774 Z M1054.58267,231.468066 >>>> C1061.6959,237.585924 1065.25246,246.228482 1065.25246,257.396 >>>> C1065.25246,268.951954 1061.6959,277.897973 1054.58267,284.234326 >>>> C1047.46945,290.570679 1037.45525,293.738807 1024.53977,293.738807 >>>> L997.228043,293.738807 L997.228043,326.731376 L985.283713,326.731376 >>>> L985.283713,222.291325 L1024.53977,222.291325 C1037.45525,222.291325 >>>> 1047.46945,225.350208 1054.58267,231.468066 L1054.58267,231.468066 Z >>>> M997.228043,282.304297 L1024.10278,282.304297 C1033.66801,282.304297 >>>> 1040.99961,280.216488 1046.09783,276.040807 C1051.19604,271.865126 >>>> 1053.74511,265.74736 1053.74511,257.687326 C1053.74511,249.821508 >>>> 1051.18391,243.87368 1046.06141,239.843663 C1040.938 >>>> 92,235.813645 1033.61945,233.798667 1024.10278,233.798667 >>>> L997.228043,233.798667 L997.228043,282.304297 Z M1088.33997,300.366454 >>>> L1076.68697,326.731376 L1064.01432,326.731376 L1110.84483,222.291325 >>>> L1123.22615,222.291325 L1169.911,326.731376 L1156.94703,326.731376 >>>> L1145.29403,300.366454 L1088.33997,300.366454 Z M1116.67134,235.910774 >>>> L1093.43816,288.859112 L1140.26867,288.859112 L1116.67134,235.910774 Z >>>> M1248.93293,226.042136 C1255.58489,228.736907 1261.45989,232.463403 >>>> 1266.5581,237.221737 L1259.34781,246.325646 C1255.26924,242.247074 >>>> 1250.52311,239.04253 1245.10929,236.711918 C1239.69547,234.381305 >>>> 1234.14821,233.216017 1228.46735,233.216017 C1220.69864,233.216017 >>>> 1213.56124,235.048919 1207.05495,238.714778 C1200.54866,242.380637 >>>> 1195.4141,247.357391 1191.65114,253.64519 C1187.88817,259.932988 >>>> 1186.00671,266.839752 1186.00671,274.365688 C1186.00671,281.84307 >>>> 1187.88817,288.737695 1191.65114,295.04977 C1195.4141,301.361846 >>>> 1200.5608,306.350739 1207.09137,310.016598 C1213.62194,313. >>>> 682457 1220.74719,315.515359 1228.46735,315.515359 >>>> C1234.14821,315.515359 1239.6712,314.422901 1245.03646,312.237952 >>>> C1250.40173,310.053002 1255.17213,306.969843 1259.34781,302.98838 >>>> L1266.70377,311.218314 C1261.41133,316.170865 1255.39067,320.091577 >>>> 1248.64161,322.980565 C1241.89254,325.869553 1234.97364,327.314026 >>>> 1227.8847,327.314026 C1218.02815,327.314026 1208.98502,324.959172 >>>> 1200.75505,320.249392 C1192.52507,315.539613 1185.9946,309.130524 >>>> 1181.16343,301.021935 C1176.33227,292.913346 1173.91672,284.028019 >>>> 1173.91672,274.365688 C1173.91672,264.800466 1176.35654,256.024385 >>>> 1181.23626,248.037181 C1186.11598,240.049978 1192.70715,233.71372 >>>> 1201.00995,229.028218 C1209.31276,224.342716 1218.41658,222 1228.32168,222 >>>> C1235.41063,222 1242.28098,223.347365 1248.93293,226.042136 >>>> L1248.93293,226.042136 Z M1362.98671,326.731376 L1362.98671,280.77484 >>>> L1300.06049,280.77484 L1300.06049,326.731376 L1288.11616,326.731376 >>>> L1288.11616,222.291325 L1300.06049,222.291325 L1300.06049,269.485992 L1362 >>>> .98671,269.485992 L1362.98671,222.291325 L1374.93104,222.291325 >>>> L1374.93104,326.731376 L1362.98671,326.731376 Z M1418.48415,233.798667 >>>> L1418.48415,268.102198 L1471.14116,268.102198 L1471.14116,279.60954 >>>> L1418.48415,279.60954 L1418.48415,315.369697 L1479.37109,315.369697 >>>> L1479.37109,326.731376 L1406.53982,326.731376 L1406.53982,222.291325 >>>> L1477.40465,222.291325 L1477.40465,233.798667 L1418.48415,233.798667 Z" >>>> id="APACHE" fill="#282662"></path> >>>> + </g> >>>> + </g> >>>> +</svg> >>>> \ No newline at end of file >>>> >>>> Propchange: >>>> ofbiz/ofbiz-framework/trunk/docs/asciidoc/images/OFBiz-Logo.svg >>>> >>>> ------------------------------------------------------------------------------ >>>> svn:executable = * >>>> >>>> Modified: ofbiz/ofbiz-framework/trunk/docs/asciidoc/user-manual.adoc >>>> URL: >>>> http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/docs/asciidoc/user-manual.adoc?rev=1827146&r1=1827145&r2=1827146&view=diff >>>> >>>> ============================================================================== >>>> --- ofbiz/ofbiz-framework/trunk/docs/asciidoc/user-manual.adoc >>>> (original) >>>> +++ ofbiz/ofbiz-framework/trunk/docs/asciidoc/user-manual.adoc Sun Mar >>>> 18 16:24:31 2018 >>>> @@ -17,10 +17,16 @@ specific language governing permissions >>>> under the License. >>>> //// >>>> = Apache OFBiz User Manual >>>> +The Apache OFBiz Project >>>> +Release 17.12: >>>> +:doctype: book >>>> :sectnums: >>>> +:toc: >>>> +:toclevels: 5 >>>> :imagesdir: ./images >>>> - >>>> -image::OFBiz-Logo-250w.png[Apache OFBiz Logo, align="center"] >>>> +ifdef::backend-pdf[] >>>> +:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, >>>> pdfwidth=4.25in, align=center] >>>> +endif::[] >>>> >>>> == Introduction to OFBiz >>>> >>>> >>>> > >
