From f5a3152bbba69c7be1a6f84af11645c1bb022669 Mon Sep 17 00:00:00 2001 From: Cimbali Date: Thu, 23 May 2019 23:48:41 +0200 Subject: [PATCH] Add gnuplot documentation as source MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Documentation is part of the gnuplot source code, available at: - https://sourceforge.net/p/gnuplot/gnuplot-main/ci/master/tree/docs/ This can be redistributed, according the the Copyright (emphasis mine): > * Copyright 1986 - 1993, 1998, 2004 Thomas Williams, Colin Kelley > * > * Permission to use, copy, and distribute this software **and its** > * **documentation** for any purpose with or without fee is hereby granted, > * provided that the above copyright notice appear in all copies and > * that both that copyright notice and this permission notice appear > * in supporting documentation. Full copyright notice here: https://sourceforge.net/p/gnuplot/gnuplot-main/ci/master/tree/Copyright The term “gnuplot license” is not very widespread but brings satisfying results on search engines (including on wikipedia), so I took the liberty to add a link to the copyright file, taken from the “Gnuplot's copyright” link on the gnuplot home page, http://gnuplot.info. Here is how to build the gnuplot docs to parse them: mkdir gnuplot-src gnuplot-conf $DEVDOCS_ROOT/docs/gnuplot git clone -b 5.2.7 --depth 1 https://git.code.sf.net/p/gnuplot/gnuplot-main ./gnuplot-src cd gnuplot-src/ ./prepare cd ../gnuplot-conf ../gnuplot-src/configure make -C docs nofigures.tex latex2html -html 5.0,math -split 4 -link 8 -long_titles 5 -dir $DEVDOCS_ROOT/docs/gnuplot -ascii_mode docs/nofigures.tex --- .../templates/pages/about_tmpl.coffee | 5 ++ assets/stylesheets/application.css.scss | 1 + assets/stylesheets/pages/_gnuplot.scss | 6 ++ lib/docs/filters/gnuplot/clean_html.rb | 61 +++++++++++++++ lib/docs/filters/gnuplot/entries.rb | 73 ++++++++++++++++++ lib/docs/scrapers/gnuplot.rb | 41 ++++++++++ public/icons/docs/gnuplot/16.png | Bin 0 -> 2954 bytes public/icons/docs/gnuplot/16@2x.png | Bin 0 -> 2163 bytes public/icons/docs/gnuplot/SOURCE | 1 + 9 files changed, 188 insertions(+) create mode 100644 assets/stylesheets/pages/_gnuplot.scss create mode 100644 lib/docs/filters/gnuplot/clean_html.rb create mode 100644 lib/docs/filters/gnuplot/entries.rb create mode 100644 lib/docs/scrapers/gnuplot.rb create mode 100644 public/icons/docs/gnuplot/16.png create mode 100644 public/icons/docs/gnuplot/16@2x.png create mode 100644 public/icons/docs/gnuplot/SOURCE diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 0165ade2..60c74210 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -311,6 +311,11 @@ credits = [ 'Free Software Foundation', 'GFDL', 'https://www.gnu.org/licenses/fdl-1.3.en.html' + ], [ + 'Gnuplot', + 'Copyright 1986 - 1993, 1998, 2004 Thomas Williams, Colin Kelley', + 'gnuplot license', + 'https://sourceforge.net/p/gnuplot/gnuplot-main/ci/master/tree/Copyright' ], [ 'Go', 'Google, Inc.', diff --git a/assets/stylesheets/application.css.scss b/assets/stylesheets/application.css.scss index 0072d511..1b1c3ad0 100644 --- a/assets/stylesheets/application.css.scss +++ b/assets/stylesheets/application.css.scss @@ -60,6 +60,7 @@ 'pages/github', 'pages/go', 'pages/graphite', + 'pages/gnuplot', 'pages/haskell', 'pages/jekyll', 'pages/jquery', diff --git a/assets/stylesheets/pages/_gnuplot.scss b/assets/stylesheets/pages/_gnuplot.scss new file mode 100644 index 00000000..b7d584e7 --- /dev/null +++ b/assets/stylesheets/pages/_gnuplot.scss @@ -0,0 +1,6 @@ +._gnuplot { + .CENTER { + text-align: center; + } + @extend %simple; +} diff --git a/lib/docs/filters/gnuplot/clean_html.rb b/lib/docs/filters/gnuplot/clean_html.rb new file mode 100644 index 00000000..e612982b --- /dev/null +++ b/lib/docs/filters/gnuplot/clean_html.rb @@ -0,0 +1,61 @@ +module Docs + class Gnuplot + class CleanHtmlFilter < Filter + def call + # remove some anchors nested inside headers: ... + css('h1, h2, h3, h4, h5').each do |heading| + anchor = heading.css('a')[0] + heading['id'] = anchor['id'] || anchor['name'] + heading.content = anchor.content.strip + end + + # make the title on the front page which is in some weird tags + if root_page? + title = css('.HUGE')[0] + title.name = 'h1' + + subtitle = css('.XLARGE')[0] + title.content = title.content + ' − ' + subtitle.content + + css('> *:first-child')[0].before(title) + subtitle.remove + + css('p:contains("TableOfContents")').remove + end + + # remove nav, empty items, and any useless horizontal rules as well + # as the subsection table of contents (.ChildLinks) + css('.navigation').remove + css('#CHILD_LINKS, ul.ChildLinks').remove + css('hr').remove + # Anchors that use only names are some numerical IDs that latex2html distributes through the document + css('a[name]:not([href]):not([id])').remove + + # spacing + css('> div, p').each do |node| + node.remove if node.content.strip.empty? + end + + # links generated are of the form (NB: some might have been removed): + # {text} (p. [*]) + # transform to nil, 'Linetypes, colors, and styles' => nil, 'Fit' => nil, 'Format' => nil, + 'Plot' => nil, 'Splot' => nil, 'Style' => 'Plot appearance', + 'Set-show' => 'Set / Show', 'Datafile' => nil, 'Key' => 'Legend'} + NOREPEAT = ['String constants, string variables, and string functions', 'Substitution and Command line macros'] + + class EntriesFilter < Docs::EntriesFilter + def initialize(*) + super + end + + def get_name + return 'Stats' if slug.downcase == 'stats_statistical_summary' + return css('h1')[0].content.strip + end + + def get_type + return (PROMOTE[name] || name) if PROMOTE.include? name + + parent = at_css('.navigation > b:contains("Up:")').next_element.content + return 'Using Gnuplot' if parent == 'Gnuplot' + return parent + end + + def include_default_entry? + !root_page? and slug.downcase != 'complete_list_terminals' #and !PROMOTE.include? name + end + + def additional_entries + return [] if root_page? + entries = [] + + if slug.downcase == 'complete_list_terminals' + list_stack = [[css('ul.ChildLinks'), '', nil]] + else + list_stack = [[css('ul.ChildLinks'), name, nil]] + end + + while !list_stack.empty? + list, name_, type_ = list_stack.pop + list.css('> li').each do |item| + + sublists = item.css('> ul') + link = item.css('> a, span') + + if link.empty? + item_name = name_ + else + item_name = link[0].text.strip + item_name = "#{name_} #{item_name}".strip unless PROMOTE.include? name_ or NOREPEAT.include? name_ + item_name = item_name.sub /^(\w+) \1/, '\1' + item_name = 'set style boxplot' if slug.downcase == 'set_show' and item_name == 'Boxplot' + + if PROMOTE.include? name_ + type_ = PROMOTE[name_] || name_ + end + + entries << [item_name, link[0]['href'].split('#')[1], type_] + end + + list_stack.push([sublists, item_name, type_]) unless sublists.empty? + end + end + + return entries + end + + private + + end + end +end diff --git a/lib/docs/scrapers/gnuplot.rb b/lib/docs/scrapers/gnuplot.rb new file mode 100644 index 00000000..dc55edb7 --- /dev/null +++ b/lib/docs/scrapers/gnuplot.rb @@ -0,0 +1,41 @@ +module Docs + class Gnuplot < FileScraper + self.name = 'Gnuplot' + self.slug = 'gnuplot' + self.type = 'gnuplot' + self.links = { + home: 'http://gnuplot.sourceforge.net/' + } + + self.root_path = 'index.html' + + html_filters.push 'gnuplot/entries', 'gnuplot/clean_html' + + options[:skip_links] = false + + options[:skip] = %w( + Copyright.html + External_libraries.html + Known_limitations.html + Introduction.html + About_this_document.html + New_features.html + Differences_from_version_4.html + Seeking_assistance.html + Gnuplot.html + Deprecated_syntax.html + Demos_Online_Examples.html + Terminal_types.html + Plotting_styles.html + Commands.html + Contents.html + Bugs.html + ) + + options[:attribution] = <<-HTML + Copyright 1986 - 1993, 1998, 2004 Thomas Williams, Colin Kelley
+ Distributed under the gnuplot license (rights to distribute modified versions are withheld). + HTML + + end +end diff --git a/public/icons/docs/gnuplot/16.png b/public/icons/docs/gnuplot/16.png new file mode 100644 index 0000000000000000000000000000000000000000..3db00280f941d049356226dc91b7aac54aa23f05 GIT binary patch literal 2954 zcmV;53w88~P) zaB^>EX>4U6ba`-PAZ2)IW&i+q+O1bxk|Ze({O1&V1dw>?I6Tev26Oy%KtyI`)%0w) zO-5A)C%`u{7rA*J5JZeS zpJ^PrzCa#cFC?$>`c-aHQ$1M~UCpYH*Up4NS0hys(~&!!8=*5O@y#9muln-d*?yn< z1TcDlJ|;th9ozj)XD5agEL`yI&NnTI$C&YSegA-;vF{ju0QihP@Uu`d<#QF;R58-8>4Jm)yx6(0@Yit5yLWsk710#4qqMO+F00pqkU z!If>X4XkyzT8*ukh$A3Aop;?8H{ICx<{C`&G$`Rt)QGn%b0VR}hXPz~QZnGDa|Rm? z%rV6D*y8rSvi8Gf89R4}mE@od9Dlvcr{GVoFN)?|VeXvG4_2^?R(!#X#oYSFDiGqP zVj4ES&YYY5{48P_42BJJhJ(e{qoM})iY?wevkeAIy*>HjQdb3l2zv(@gSht2M#sTL zXA@C!4mf7;Q(!rPCkVcQ%X5WDw(s-A;+9@&XS9eFv?gk5+z9% zky5Z}@ddgH))xpWRj$5<8f&V#N-YiH(|ijpw$yTyRyuX=C;_I&o_g-m%WwmsH2er7 zjx_R+Q6^$-^7J#zIMd8iW_egsR==|L$=t75bIKZRqSm_fVh!Syt_ruxNm!hLG4c+K zr^NsQnigj^JMU>Rw>YyxY?uSV%CN}kZZQT1{csefd$@Zs_qV(mp!>VL(ND~oMcu!_ zoLSVpG54LfA6V;Ums{QhttHFq{3EOG%G$Mhx_-TykyL8_5em0g29XA%WXVEmL#BwU=}fCn-3*tGd809C zz1zFTB%i*UIpoUvHPg)3-UyTr>Tz7$h5fo?4`_nyld@%D@ec{X%;^~@x%*KVjZgo>4> z!8jv=Y7Bh{M|(`Z8pQ!8+VGks)#6NZtXi^zt97Un9LE8bNyB}WfZX;Y6J{7FSTOax zIB@JmdF4nLH%DYr3y0Sl!C{*$>T7^&Y=?p~@(K{GZFN+Xk+FJRWvHVW?n7r8zf3a5 z8d$kolg}d$*Mb&Ok^#iCIulAFcS8ZyZF12=Cp5J0K_M_LyN*DqijROKFSj;yR)IX)7z zx=ZyYp3@GDXLO)JHF)WR^nswc4`|!6Zklm?$Fr$f$Q02BL1tQEb5sQUZj)9|JawPY zQ(QCb*sc}S02H9zjR2^!1EKXxOP(1?qoooL##?dg@eb`hNLT5w%_z>j4djm~h6ljO z;gw6XX@gT%{naBMQ|+u!YQaglx_5+VgMc=qd}{?xrXx4jG1RQiMyk;y{KR~ndGF~_ zPe?`lmTI@S;&<@yuhT;;k{lJcXoXxgQ8Rfb?|e(%uJ|^z=n5Nh#b&LcsO@d@zkA5u zKD(^jy7-j69@5DB;$+-{SK3bF8~R@u|A2cx}DK3tJYr(;v#j1mgv#t)Vf*|+<;^OM0=prS4mlRsWc*k)M?|tvb-Ftx0 zs4~s!8Ur-lHZ!TDn9Hw-p;z?Mj6y_MW|lE4Non|wuX_aeewX0A{OkT4QMF((ARrRY zFvGNo*NLY#ZG-bZag3E^mH3=^)T9d%KXP61_>FVPWr6pMnc2)7ag10jb+FRGtZZt; zlf-dV)2Y9Z^H}A)#aXM?SnHnrg^_~3yu@`{Lr7r(i;yTI1vOMqg^dL5Iw=-1be{C_ z54wJdTnf1=VC0y`1~ka7AN&t~XKNKF#=TCFB+&ihI3L46XcuVK9q0SlahfMU@EN$$ z+y0FPF#Sn-y{*NMfWB?u;<~LVd%)!mFz{r^rtC^VT0*f1yr0oG<$?ZNAiV13);h=O z1CXVx(l@}tAuv*+-fKSZ?&-|!-2t%m4rY24YJ`L;(K){{a7>y{D4^ z000SaNLh0L01m_e01m_fl`9S#00007bV*G`2jdG14Im&|=i;RR00NdtL_t(I%bk*2 zNYr^8#XoHim2|naQP*6d)huxwFmu@7s5Cld9yFCO^bkWj8qNoIO_|#mqw<#X%IhgsqQ6JR7&SCB$hK{H09spH@%elJ zgu`I~{CCt*(TUXF_Wgc(n=1fN=59$gyb{O*Wf#DIBeYnqxk^AiYZG^g8u=&@v zu?P*R=hWoYv#RkURc%WsyXR-)`u|uke_{H~s*?mdJJ~U(haJhgP;r!p&&=05D4dj| z-K$=ywsthL14W|Jwh}#k^hipjq>2+#&8f@|EXQ$V+cuVEkv(}YtMgW}X6O$}B4NA} zCU7Tz5tlnVseS(rkH>>g;@^ToN;=wkoan}K97oY;lvul;0|$q=ammlr>O;KlH)Q*L z`fuEw{g4 zuInlo45m5Pm1~R=zidcH2m}He_{NmK2ivy!1lhxqU99uTY5)KL07*qoM6N<$g5z48 AIRF3v literal 0 HcmV?d00001 diff --git a/public/icons/docs/gnuplot/16@2x.png b/public/icons/docs/gnuplot/16@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..5985b7aa54132155b9e712e460720b4b955df8e7 GIT binary patch literal 2163 zcmV-(2#oiMP)EX>4Tx04R}tkv&MmKp2MKrbdj$A?7w5hF>;4=OwO}zIAQI0o!?cOliKjMg zgY!Odl$B+b_?&pmqze*1a$WKGjdRImf%lA>*~}bqlvpfvu+qV-Y-+@l#4%OVslSl( zSmnIMS*zAq>z@3D;ex)r#C2N3NMQkskSHSsHB?ZAjX3Q(DHbwxp7ik#xqgXU3b`s^ zG{~+W{11L-YZVg{UZ-#p=zejWj}aiW3pDGF^L^|%%@ZK_3|#4L|3(9t{v^HL z)?!CM|2A-O-PV*n;Bp5Td@^KHcBLRKp;!do&*+=-z`!lgyXxiEI>+e)kfp5BH^9Lm zFj}JCYd-Jp>CEllnpS>4jzn^@9KQ;q00006VoOIv0RI600RN!9r;`8x010qNS#tmY zE+YT{E+YYWr9XB6000McNliru;|mK7As&LA&QAaU25?D4K~z}7#g}_fl-C)?f8Vzk zcF|o#*j zP^2PtGHHsTos5ZDk_@I86N_BrsuI|xab;ch#-9GM!h*YKw3+dp+1c+q=X>AxIq!MS zbIy@6Gc$$VZs$&zPNxH-(I|jB^3&_}LOF)!%$YM742E%Z$;rt8^!N8qLfzEV1VDCn zcGOWdH8pWA_7WSd)hLkpQ2h#bNy(G?-EKF_moEok9DvDW!e}%`1WZawn)IHKkPx+f z%%&US*q2d*(5iVxQNn}DtO$RNMl=4doQNzwK0YE~V`F2~L{qiznSGp2?I5Y1MDknG zX$&^rkO%U2Nvh*Bzu=gm33X7(j?NNdf~uQ4jgfF*U_eZ?F``^=Hk(b@Y_^E@Q^8iD z^*k={EEXGEUlUWA&1Mq~4GrTY{7x!xQ8;+gU&aVto^;Ho&@t~@`~KemhH+Ei-@--V zV4-|J&-Uiul7AS$S7&cIxsL$F{&G%>^Q21_>Xh413dL;#c(D@N+P}49kRU(xzeq#y zb4*e^^{SoBl=Qbeh%f-3A1Yr4pYNtl0{B&64>iFP#4(L})lSl+q}!UpFo48F=<9>p zx|=%fHNVfk(Z8c5hIdruWJ%WB=Fqqh@ynmXOS|DnEj;${4_1uNedak*oajl&o-z1&f@KN+=Mahtd@w%dAc@V>V2uz`up6;J?tJ^TTfvWFw z*$Fw>Q2Be9F(W)6l`2R;lf3ze;?NT8XOKShQyJ`DX1O&DD+@4L*4@V zQY17db7%;j!X(A>f%;|Uxw3fs;2egB)%-9Ec9cO(OynHjmFDD$$HD7`&D&tr>JY!} z4oIDSg;gtCB1!mcU?0Py0Se_G@$qUC&uIc&(MsGaeUEol6<9`-*suc}Lt17fU!`LE zG}P+rGTR-b*VZwk<2<>t5|dQG2f9K$(`I5e!=i;SE%q!UZhs^IKLIuc_OproaP3&I z?4-3uv^+JaU)|9W=8`VAxu42}zRDMu)!9$qMijPz@(N<={*`v-ZiK2+|ND_YR$qNwHTZ^FPJ!{!uDt@{nU z{b$H|0EUNQ^H#WU;l@h1M4rb{)izqx`}s`0m%c+iRP|q^HIT;MnovpBuY+01S0kge zwZlgzL8GCyWGOzq4opTU+X@do2rd^??2Ib&H{6cPyX{nn=kcSWXvqkRAD-gF>cgS` z!YA^g_tH4K1O8xpGd`Zx~GOvD`skk{Rb-S3;!4`3Y~<()JuvQo)Ux;trc4b#`xhhDD_ zldz+sV-m6y^BN4Mr33;_ioKheCAnFzRI#$RcT6!*%Q98jxgZ34dwcl&d`Hv*wE}-q zYxsrP!kQQjMJ@k{tbomC8$WXQ^uo?v7Gy;%&#b*dZc-b@-|Ygon=ca+X!~&<_obx~ zTYVVIrG79P>Djaqk1W&N+zdcg*5u=Otk;WW>vn|4Lv7weEZeeWas{kbD@LOczaMu0 z0b~XAUphcx!D?WBh)~;ikm(pAv+mf$`xTUJCDnR207FAV0HmjI4IgZtsNKl0!7dkAPWkdOe6E`c}pz_sKzwW1<|N+mNoyCQ|i z>2%U}A%=t1AOy6WUB&3A3#Zc=4iKm3R6*#_nUj+fZlCat%jFu67hwt+yY+5jPJa=( p8{V-FA|>$zU9=YR6E67gP7ZQTF>002ovPDHLkV1gY3Bnbcj literal 0 HcmV?d00001 diff --git a/public/icons/docs/gnuplot/SOURCE b/public/icons/docs/gnuplot/SOURCE new file mode 100644 index 00000000..8acb1e8c --- /dev/null +++ b/public/icons/docs/gnuplot/SOURCE @@ -0,0 +1 @@ +https://sourceforge.net/p/gnuplot/gnuplot-main/ci/master/tree/demo/html/favicon.ico