├── .babelrc ├── test ├── mock_image.jpg ├── index.js ├── imageDims.test.js └── templates.test.js ├── test.html ├── .travis.yml ├── .npmignore ├── .gitignore ├── src ├── templates.js ├── ampl.js └── imageDims.js ├── package.json ├── README.md └── LICENSE /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": ["es2015"] 3 | } 4 | -------------------------------------------------------------------------------- /test/mock_image.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dwyl/ampl/HEAD/test/mock_image.jpg -------------------------------------------------------------------------------- /test/index.js: -------------------------------------------------------------------------------- 1 | require('./templates.test.js'); 2 | require('./imageDims.test.js'); 3 | -------------------------------------------------------------------------------- /test.html: -------------------------------------------------------------------------------- 1 | hey 2 | 3 |

#h1

4 | 5 | 6 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - "4.2.4" 4 | before_install: 5 | - pip install --user codecov 6 | after_success: 7 | - codecov --file coverage/lcov.info --disable search 8 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # node-waf configuration 20 | .lock-wscript 21 | 22 | # Compiled binary addons (http://nodejs.org/api/addons.html) 23 | build/Release 24 | 25 | # Dependency directory 26 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git 27 | node_modules 28 | 29 | src 30 | example 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # node-waf configuration 20 | .lock-wscript 21 | 22 | # Compiled binary addons (http://nodejs.org/api/addons.html) 23 | build/Release 24 | 25 | # Dependency directory 26 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git 27 | node_modules 28 | 29 | lib 30 | .DS_Store 31 | package-lock.json -------------------------------------------------------------------------------- /src/templates.js: -------------------------------------------------------------------------------- 1 | const createAmpHeader = ({ 2 | headOverride, style, canonicalUrl, title, extraHeadHTML 3 | }) => ` 4 | 5 | ${typeof headOverride === 'string' ? headOverride : ` 6 | 7 | 8 | 9 | 12 | 13 | 14 | ${title || ""} 15 | ${extraHeadHTML || ""} 16 | `}`; 17 | 18 | export const createAmpPage = (contentHTML, opts) => ( 19 | `${createAmpHeader(opts)} 20 | 21 | ${contentHTML} 22 | 23 | ` 24 | ); 25 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ampl", 3 | "version": "1.1.1", 4 | "description": "ampl converts your markdown files into AMP-compliant html so they can be cached by google for the fastest possible page load", 5 | "main": "lib/ampl.js", 6 | "scripts": { 7 | "dev": "babel-node test", 8 | "test": "./node_modules/.bin/babel-node ./node_modules/.bin/babel-istanbul cover ./node_modules/tape/bin/tape ./test/", 9 | "watch-build": "babel src -d lib -w", 10 | "build": "babel src -d lib", 11 | "prepublish": "npm run build" 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "git+https://github.com/dwyl/ampl.git" 16 | }, 17 | "keywords": [ 18 | "AMP", 19 | "fast", 20 | "compile", 21 | "Accelerated", 22 | "Mobile", 23 | "Pages", 24 | "Google" 25 | ], 26 | "author": "dwyl", 27 | "license": "GPL-2.0", 28 | "bugs": { 29 | "url": "https://github.com/dwyl/ampl/issues" 30 | }, 31 | "homepage": "https://github.com/dwyl/ampl#readme", 32 | "devDependencies": { 33 | "babel-cli": "^6.26.0", 34 | "babel-istanbul": "^0.12.2", 35 | "babel-preset-es2015": "^6.24.1", 36 | "istanbul": "^0.4.5", 37 | "nock": "^9.4.4", 38 | "tape": "^4.9.1" 39 | }, 40 | "dependencies": { 41 | "htmlparser2": "^3.9.2", 42 | "image-size": "^0.6.3", 43 | "remarkable": "^1.7.1" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /test/imageDims.test.js: -------------------------------------------------------------------------------- 1 | import test from 'tape'; 2 | import nock from 'nock'; 3 | import { parse } from '../src/ampl.js'; 4 | 5 | test('image dimensions found', t=> { 6 | const testMd = 7 | ` 8 | # h1 9 | 10 | ![image](https://mock1.io/pic1.jpg) 11 | ![image](http://www.mock2.io/pic2.jpg) 12 | ![image](http://www.mock2.io/pic3.jpg) 13 | ![image](http://www.mock2.io/notAPic) 14 | ![image](http://notaurl.jpg)`; 15 | 16 | nock('https://mock1.io') 17 | .get('/pic1.jpg') 18 | .replyWithFile(200, __dirname + '/mock_image.jpg'); 19 | nock('http://www.mock2.io') 20 | .get('/pic2.jpg') 21 | .replyWithFile(200, __dirname + '/mock_image.jpg'); 22 | nock('http://www.mock2.io') 23 | .get('/notAPic') 24 | .reply(200, 'hi there'); 25 | nock('http://www.mock2.io') 26 | .get('/pic2.jpg') 27 | .reply(400); 28 | 29 | parse(testMd, '', ampHtml => { 30 | console.log('@@@@@@@@@@@@@@@'); 31 | console.log(ampHtml); 32 | t.ok(ampHtml.indexOf(`width="32"`) !== -1, 'image has correct width'); 33 | t.ok(ampHtml.indexOf(`height="32"`) !== -1, 'image has correct height'); 34 | t.end(); 35 | }); 36 | }); 37 | 38 | test('ampl does not fail when there are no images in the markdown', t=> { 39 | const testMd = 'hi there' 40 | parse(testMd, '', ampHtml => { 41 | t.ok(ampHtml.indexOf(`hi there`) !== -1, 'amp html created without error'); 42 | t.end(); 43 | }); 44 | }); 45 | -------------------------------------------------------------------------------- /test/templates.test.js: -------------------------------------------------------------------------------- 1 | import test from 'tape'; 2 | 3 | import { createAmpPage } from '../src/templates.js'; 4 | import { parse } from '../src/ampl.js'; 5 | 6 | const getFirstInner = (tag, html) => html 7 | .split(`<${tag}>`)[1] 8 | .split(``)[0]; 9 | 10 | test('headOverride', t => { 11 | const replacementHead = 'replace standard amp head with me'; 12 | const ampHtml = createAmpPage('soome html', {headOverride: replacementHead}); 13 | const expected = replacementHead; 14 | const actual = ampHtml.split('') 15 | t.equal(getFirstInner('head', ampHtml), replacementHead, 'head replaced'); 16 | t.end(); 17 | }); 18 | 19 | test("template.js", t => { 20 | const style = "here is some styling"; 21 | const html = ""; 22 | const ampHtml = createAmpPage(html, {style}); 23 | t.ok(ampHtml.indexOf(html) !== -1, "html inserted into amp template"); 24 | t.ok(ampHtml.indexOf(style) !== -1, "style inserted into amp template"); 25 | t.ok( 26 | ampHtml.split('\n')[1].split(' ')[1].indexOf('amp') === 0, 27 | 'html tag contains amp keyword' 28 | ); 29 | t.end(); 30 | }); 31 | 32 | test('custom props', t=> { 33 | let expected; 34 | const opts = { 35 | style: 'style', 36 | canonicalUrl: 'canonicalUrl', 37 | title: 'title', 38 | extraHeadHTML: 'extraHeadHTML' 39 | }; 40 | parse('markdown', opts, ampHtml => { 41 | console.log(ampHtml); 42 | 43 | expected = ``; 44 | t.ok(ampHtml.indexOf(expected) !== -1, 'canonicalUrl input correctly'); 45 | 46 | expected = ``; 49 | t.ok(ampHtml.indexOf(expected) !== -1, 'style input correctly'); 50 | 51 | expected = `title`; 52 | t.ok(ampHtml.indexOf(expected) !== -1, 'title input correctly'); 53 | 54 | expected = `extraHeadHTML 55 | `; 56 | t.ok(ampHtml.indexOf(expected) !== -1, 'extra head input correctly'); 57 | 58 | 59 | t.end(); 60 | }) 61 | }); 62 | -------------------------------------------------------------------------------- /src/ampl.js: -------------------------------------------------------------------------------- 1 | import Remarkable from 'remarkable'; 2 | import htmlparser from 'htmlparser2'; 3 | 4 | import { getDims, updateImgTags } from './imageDims.js'; 5 | import { createAmpPage } from './templates.js'; 6 | 7 | const remarkable = new Remarkable('full'); 8 | 9 | export const parse = (markdown, opts, callback) => { 10 | markdown2AmpHTML({ markdown }, HTML => 11 | callback(createAmpPage(HTML, opts)) 12 | ); 13 | }; 14 | 15 | export const markdown2AmpHTML = (opts, callback) => { 16 | const { markdown } = opts; 17 | const htmlRaw = remarkable.render(markdown); 18 | parseHtml(htmlRaw, (html, { imageUrls }) => 19 | getDims(imageUrls, (dimensions) => 20 | callback(updateImgTags(html, dimensions)) 21 | ) 22 | ); 23 | }; 24 | 25 | const attribStr = attribs => Object.keys(attribs).map(attribKey => 26 | ` ${attribKey}="${attribs[attribKey]}"` 27 | ).join(''); 28 | 29 | const createParseRules = () => [ 30 | (urls => ({ 31 | label: "imageUrls", 32 | target: "img", 33 | onOpenTag: attribs => urls.push(attribs.src), 34 | getResults: () => urls 35 | }))([]) 36 | ]; 37 | 38 | const parseHtml = (html, callback) => { 39 | const parseRules = createParseRules(); 40 | const tagStack = [{text: ""}]; 41 | const parser = new htmlparser.Parser({ 42 | onopentag: (name, attribs) => { 43 | tagStack.push({name, attribs, 44 | text: "" 45 | }); 46 | parseRules.forEach(rule => { 47 | if (rule.onOpenTag && !(rule.target && rule.target !== name)) { 48 | rule.onOpenTag(attribs); 49 | } 50 | }); 51 | }, 52 | ontext: text => { 53 | tagStack[tagStack.length-1].text += text; 54 | }, 55 | onclosetag: name => { 56 | const tag = tagStack.pop(); 57 | tagStack[tagStack.length-1].text += 58 | `<${tag.name} ${attribStr(tag.attribs)}>${tag.text}`; 59 | }, 60 | onend: () => { 61 | const ruleOutput = parseRules.reduce((data, rule) => { 62 | if (typeof rule.getResults === 'function') { 63 | data[rule.label] = rule.getResults(); 64 | } 65 | return data; 66 | }, {}); 67 | callback(tagStack[0].text, ruleOutput); 68 | } 69 | }); 70 | parser.write(html); 71 | parser.end(); 72 | }; 73 | 74 | export default parse; 75 | -------------------------------------------------------------------------------- /src/imageDims.js: -------------------------------------------------------------------------------- 1 | import assert from 'assert'; 2 | import sizeOf from 'image-size'; 3 | import http from 'http'; 4 | import https from 'https'; 5 | import url from 'url'; 6 | 7 | export const getDims = (imageUrls, callback) => { 8 | const totalLinks = imageUrls.length; 9 | if (totalLinks === 0) { 10 | setTimeout(() => callback([]), 0); 11 | } else { 12 | imageUrls.forEach((imageUrl, index) => { 13 | const options = url.parse(imageUrl); 14 | const proto = options.protocol === 'https:' ? https : http; 15 | const request = proto.request(options, response => 16 | getBody(response, body => { 17 | let dims; 18 | try { 19 | dims = sizeOf(body); 20 | } catch(e) { 21 | dims = { 22 | width: 0, 23 | height: 0 24 | } 25 | console.warn('failed to find size of image', imageUrl); 26 | } 27 | next(dims, index); 28 | }) 29 | ); 30 | request.on('error', (e) => { 31 | console.error(`problem with request: ${e.message}`); 32 | next({ 33 | width: 0, 34 | height: 0 35 | }, index); 36 | }); 37 | request.end(); 38 | }); 39 | } 40 | const next = asyncCaller(totalLinks, callback); 41 | }; 42 | 43 | const asyncCaller = (length, callback) => { 44 | const results = []; 45 | let counter = 0; 46 | return (result, i) => { 47 | counter += 1; 48 | results[i] = result; 49 | if (counter === length) { 50 | callback(results); 51 | } 52 | }; 53 | }; 54 | 55 | const imageTagRegex = /( imageTagRegex.test(html) 57 | ? updateImgTags(html.replace(imageTagRegex, ` { 65 | const chunks = []; 66 | response.on('data', chunk => { 67 | chunks.push(chunk); 68 | // how do we chunk with nock? 69 | // sending a big image seems like a waste of time.. 70 | /* istanbul ignore if */ 71 | if (chunks.length === 2) { 72 | callback(Buffer.concat(chunks)); 73 | } 74 | }); 75 | response.on('end', () => { 76 | /* istanbul ignore else */ 77 | if (chunks.length < 2) { 78 | callback(Buffer.concat(chunks)); 79 | } 80 | }); 81 | }; 82 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ampl 2 | 3 | Ampl transforms your Markdown into ***AMP-compliant html*** so it loads super-fast! 4 | 5 | [![Build Status](https://travis-ci.org/dwyl/ampl.svg?branch=master)](https://travis-ci.org/dwyl/ampl) 6 | [![codecov.io](https://codecov.io/github/dwyl/ampl/coverage.svg?branch=master)](https://codecov.io/github/dwyl/ampl?branch=master) 7 | [![Code Climate](https://codeclimate.com/github/dwyl/ampl/badges/gpa.svg)](https://codeclimate.com/github/dwyl/ampl) 8 | [![Dependency Status](https://david-dm.org/dwyl/ampl.svg)](https://david-dm.org/dwyl/ampl) 9 | [![devDependency Status](https://david-dm.org/dwyl/ampl/dev-status.svg)](https://david-dm.org/dwyl/ampl#info=devDependencies) 10 | [![HitCount](https://hitt.herokuapp.com/dwyl/ampl.svg)](https://github.com/dwyl/ampl) 11 | 12 | ## Why? 13 | 14 | Google is putting their clout behind the AMP 15 | (_**A**ccelerated **M**obile **P**ages_) Project 16 | to help speed up page load times on the Mobile Web: 17 | https://googleblog.blogspot.co.uk/2015/10/introducing-accelerated-mobile-pages.html 18 | 19 | This module lets you convert Markdown (`.md`) files to AMP-compliant `.html` 20 | so that you can serve them up to mobile clients *much* faster. 21 | 22 | ## What? 23 | 24 | For many, reading on the mobile web is a slow, clunky and frustrating experience - but it doesn’t have to be that way. 25 | The Accelerated Mobile Pages (AMP) Project is an open source initiative that embodies the vision that publishers 26 | can create mobile optimized content once and have it load instantly everywhere. 27 | 28 | > Read: https://www.ampproject.org/ 29 | 30 | ## How? 31 | 32 | The best place to understand how AMP works is on 33 | the official "*How it Works*" page: 34 | https://www.ampproject.org/how-it-works/ 35 | 36 | ### Usage Example 37 | 38 | #### install `ampl` from NPM 39 | 40 | First install the module from npm: 41 | 42 | ```sh 43 | npm install ampl --save 44 | ``` 45 | 46 | #### use `ampl.parse` in your code 47 | 48 | Then in your **ES5** code: 49 | 50 | ```js 51 | var ampl = require('ampl'); 52 | var markdownString = '# Hello World!'; // or read from a .md file 53 | var cssStyle = 'h1 { color: green; }'; // or load your style.css file 54 | ampl.parse(markdownString, {style: cssStyle}, function(ampHtml) { 55 | console.log(ampHtml); 56 | }); 57 | ``` 58 | 59 | *Alternatively*, if you are already using ***ES6*** in your project, write: 60 | ```js 61 | import { parse } from 'ampl'; 62 | const markdownString = '# Hello World!'; // or read from a .md file 63 | const cssStyle = 'h1 { color: green; }'; // or load your style.css file 64 | parse(markdownString, cssStyle, function(ampHtml) { 65 | console.log(ampHtml); 66 | }); 67 | ``` 68 | 69 | This simple example is in `example/simple.js` 70 | To *run* this example, execute the following command in your terminal: 71 | 72 | ```js 73 | ./node_modules/babel-cli/bin/babel-node.js example/simple.js 74 | ``` 75 | 76 | This will output the following AMP-Compliant `html`: 77 | ```js 78 | 79 | 80 | 81 | 82 | 83 | 86 | 87 | 88 | Index 89 | 90 | 91 |

92 | 93 |

Hello World!

94 | 95 | 96 |

97 | 98 | ``` 99 | When viewed in a *Browser*: 100 | ![dwyl-ampl-simple-example-hello-world-screenshot](https://cloud.githubusercontent.com/assets/194400/12456755/1ff076fc-bf99-11e5-869a-339d134cb50f.png) 101 | 102 | > More elaborate example to follow... 103 | 104 | ## Documentation 105 | ### `ampl.parse` 106 | - `markdown` - (***required***) markdown string to be parsed 107 | - `options` - (***required***) 108 | - `headOverride` - (***optional***) custom html head to use if you do not want to use one generated by ampl. ***Using this option will mean other options will have no effect*** 109 | - `style` - (***optional***) css string to style the output html 110 | - `title` - (***optional***) sets the title property in the page 111 | - `canonicalUrl`- (***optional***) sets the canonicalUrl of the page 112 | - `extraHeadHTML`- (***optional***) extra html to be inserted into the bottom of the head 113 | - `callback(res)` - callback function with 114 | - `res` - a string constaining html string for ampl page 115 | 116 | ### `ampl.markdown2AmpHTML` 117 | - `options` - (***required***) 118 | - `markdown` - (***required***) markdown string to be parsed 119 | - `callback(res)` - callback function with 120 | - `res` - a string constaining html string for ampl page 121 | 122 | 123 | ## Background Reading 124 | 125 | + The AMP Spec: https://github.com/ampproject/amphtml 126 | 127 | ## Questions? 128 | 129 | > If you have any questions please ask: https://github.com/dwyl/ampl/issues 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | 341 | --------------------------------------------------------------------------------