├── screenshot-1.png
├── readme.md
├── css
└── customize-controls.css
├── js
├── customize-controls.js
└── customize-preview.js
├── customize
└── control-typography.php
├── ctypo.php
└── license.md
/screenshot-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/justintadlock/customizer-typography/HEAD/screenshot-1.png
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 | # Customizer Typography
2 |
3 | This plugin is a proof-of-concept and testing tool primarily for two things:
4 |
5 | * Testing a customizer control class to handle typography.
6 | * Tying multiple customize settings to a single control.
7 |
8 | ## How to use
9 |
10 | This plugin creates a "Typography" panel in the customizer. It lets you set some stuff. It's plug-n-play, so give it a try.
11 |
12 | ## Notes
13 |
14 | This is a developer tool.
15 |
16 | I'll write more here later. :)
17 |
18 | ## Screenshots
19 |
20 | 
--------------------------------------------------------------------------------
/css/customize-controls.css:
--------------------------------------------------------------------------------
1 |
2 | .customize-control-typography ul {}
3 |
4 | .customize-control-typography li.typography-font-weight,
5 | .customize-control-typography li.typography-font-style,
6 | .customize-control-typography li.typography-font-size,
7 | .customize-control-typography li.typography-line-height {
8 | float: left;
9 | width: 50%;
10 | }
11 |
12 | .customize-control-typography li.typography-font-weight select,
13 | .customize-control-typography li.typography-font-style select {
14 | width: 90%;
15 | }
16 |
17 | .customize-control-typography li.typography-font-weight,
18 | .customize-control-typography li.typography-font-size {
19 | clear: both;
20 | }
21 | .customize-control-typography li.typography-font-size input,
22 | .customize-control-typography li.typography-line-height input {
23 | width: 75px;
24 | }
25 |
--------------------------------------------------------------------------------
/js/customize-controls.js:
--------------------------------------------------------------------------------
1 | ( function( api ) {
2 |
3 | api.controlConstructor['typography'] = api.Control.extend( {
4 | ready: function() {
5 | var control = this;
6 |
7 | control.container.on( 'change', '.typography-font-family select',
8 | function() {
9 | control.settings['family'].set( jQuery( this ).val() );
10 | }
11 | );
12 |
13 | control.container.on( 'change', '.typography-font-weight select',
14 | function() {
15 | control.settings['weight'].set( jQuery( this ).val() );
16 | }
17 | );
18 |
19 | control.container.on( 'change', '.typography-font-style select',
20 | function() {
21 | control.settings['style'].set( jQuery( this ).val() );
22 | }
23 | );
24 |
25 | control.container.on( 'change', '.typography-font-size input',
26 | function() {
27 | control.settings['size'].set( jQuery( this ).val() );
28 | }
29 | );
30 |
31 | control.container.on( 'change', '.typography-line-height input',
32 | function() {
33 | control.settings['line_height'].set( jQuery( this ).val() );
34 | }
35 | );
36 | }
37 | } );
38 |
39 | } )( wp.customize );
--------------------------------------------------------------------------------
/js/customize-preview.js:
--------------------------------------------------------------------------------
1 | jQuery( document ).ready( function() {
2 |
3 | /* ===
=== */
4 |
5 | wp.customize(
6 | 'p_font_family',
7 | function( value ) {
8 | value.bind(
9 | function( to ) {
10 | jQuery( 'body.ctypo p' ).css( 'font-family', to );
11 | }
12 | );
13 | }
14 | );
15 |
16 | wp.customize(
17 | 'p_font_weight',
18 | function( value ) {
19 | value.bind(
20 | function( to ) {
21 | jQuery( 'body.ctypo p' ).css( 'font-weight', to );
22 | }
23 | );
24 | }
25 | );
26 |
27 | wp.customize(
28 | 'p_font_style',
29 | function( value ) {
30 | value.bind(
31 | function( to ) {
32 | jQuery( 'body.ctypo p' ).css( 'font-style', to );
33 | }
34 | );
35 | }
36 | );
37 |
38 | wp.customize(
39 | 'p_font_size',
40 | function( value ) {
41 | value.bind(
42 | function( to ) {
43 | jQuery( 'body.ctypo p' ).css( 'font-size', to + 'px' );
44 | }
45 | );
46 | }
47 | );
48 |
49 | wp.customize(
50 | 'p_line_height',
51 | function( value ) {
52 | value.bind(
53 | function( to ) {
54 | jQuery( 'body.ctypo p' ).css( 'line-height', to + 'px' );
55 | }
56 | );
57 | }
58 | );
59 |
60 | /* ===
=== */
61 |
62 | wp.customize(
63 | 'h1_font_family',
64 | function( value ) {
65 | value.bind(
66 | function( to ) {
67 | jQuery( 'body.ctypo h1' ).css( 'font-family', to );
68 | }
69 | );
70 | }
71 | );
72 |
73 | wp.customize(
74 | 'h1_font_weight',
75 | function( value ) {
76 | value.bind(
77 | function( to ) {
78 | jQuery( 'body.ctypo h1' ).css( 'font-weight', to );
79 | }
80 | );
81 | }
82 | );
83 |
84 | wp.customize(
85 | 'h1_font_style',
86 | function( value ) {
87 | value.bind(
88 | function( to ) {
89 | jQuery( 'body.ctypo h1' ).css( 'font-style', to );
90 | }
91 | );
92 | }
93 | );
94 |
95 | wp.customize(
96 | 'h1_font_size',
97 | function( value ) {
98 | value.bind(
99 | function( to ) {
100 | jQuery( 'body.ctypo h1' ).css( 'font-size', to + 'px' );
101 | }
102 | );
103 | }
104 | );
105 |
106 | wp.customize(
107 | 'h1_line_height',
108 | function( value ) {
109 | value.bind(
110 | function( to ) {
111 | jQuery( 'body.ctypo h1' ).css( 'line-height', to + 'px' );
112 | }
113 | );
114 | }
115 | );
116 |
117 | /* === === */
118 |
119 | wp.customize(
120 | 'h2_font_family',
121 | function( value ) {
122 | value.bind(
123 | function( to ) {
124 | jQuery( 'body.ctypo h2' ).css( 'font-family', to );
125 | }
126 | );
127 | }
128 | );
129 |
130 | wp.customize(
131 | 'h2_font_weight',
132 | function( value ) {
133 | value.bind(
134 | function( to ) {
135 | jQuery( 'body.ctypo h2' ).css( 'font-weight', to );
136 | }
137 | );
138 | }
139 | );
140 |
141 | wp.customize(
142 | 'h2_font_style',
143 | function( value ) {
144 | value.bind(
145 | function( to ) {
146 | jQuery( 'body.ctypo h2' ).css( 'font-style', to );
147 | }
148 | );
149 | }
150 | );
151 |
152 | wp.customize(
153 | 'h2_font_size',
154 | function( value ) {
155 | value.bind(
156 | function( to ) {
157 | jQuery( 'body.ctypo h2' ).css( 'font-size', to + 'px' );
158 | }
159 | );
160 | }
161 | );
162 |
163 | wp.customize(
164 | 'h2_line_height',
165 | function( value ) {
166 | value.bind(
167 | function( to ) {
168 | jQuery( 'body.ctypo h2' ).css( 'line-height', to + 'px' );
169 | }
170 | );
171 | }
172 | );
173 |
174 | } ); // jQuery( document ).ready
--------------------------------------------------------------------------------
/customize/control-typography.php:
--------------------------------------------------------------------------------
1 | l10n = wp_parse_args(
45 | $this->l10n,
46 | array(
47 | 'family' => esc_html__( 'Font Family', 'ctypo' ),
48 | 'size' => esc_html__( 'Font Size', 'ctypo' ),
49 | 'weight' => esc_html__( 'Font Weight', 'ctypo' ),
50 | 'style' => esc_html__( 'Font Style', 'ctypo' ),
51 | 'line_height' => esc_html__( 'Line Height', 'ctypo' ),
52 | )
53 | );
54 | }
55 |
56 | /**
57 | * Enqueue scripts/styles.
58 | *
59 | * @since 1.0.0
60 | * @access public
61 | * @return void
62 | */
63 | public function enqueue() {
64 | wp_enqueue_script( 'ctypo-customize-controls' );
65 | wp_enqueue_style( 'ctypo-customize-controls' );
66 | }
67 |
68 | /**
69 | * Add custom parameters to pass to the JS via JSON.
70 | *
71 | * @since 1.0.0
72 | * @access public
73 | * @return void
74 | */
75 | public function to_json() {
76 | parent::to_json();
77 |
78 | // Loop through each of the settings and set up the data for it.
79 | foreach ( $this->settings as $setting_key => $setting_id ) {
80 |
81 | $this->json[ $setting_key ] = array(
82 | 'link' => $this->get_link( $setting_key ),
83 | 'value' => $this->value( $setting_key ),
84 | 'label' => isset( $this->l10n[ $setting_key ] ) ? $this->l10n[ $setting_key ] : ''
85 | );
86 |
87 | if ( 'family' === $setting_key )
88 | $this->json[ $setting_key ]['choices'] = $this->get_font_families();
89 |
90 | elseif ( 'weight' === $setting_key )
91 | $this->json[ $setting_key ]['choices'] = $this->get_font_weight_choices();
92 |
93 | elseif ( 'style' === $setting_key )
94 | $this->json[ $setting_key ]['choices'] = $this->get_font_style_choices();
95 | }
96 | }
97 |
98 | /**
99 | * Underscore JS template to handle the control's output.
100 | *
101 | * @since 1.0.0
102 | * @access public
103 | * @return void
104 | */
105 | public function content_template() { ?>
106 |
107 | <# if ( data.label ) { #>
108 | {{ data.label }}
109 | <# } #>
110 |
111 | <# if ( data.description ) { #>
112 | {{{ data.description }}}
113 | <# } #>
114 |
115 |
202 | 'Arial',
228 | 'Georgia' => 'Georgia',
229 | "돋움" => "돋움"
230 | );
231 | }
232 |
233 | /**
234 | * Returns the available font weights.
235 | *
236 | * @since 1.0.0
237 | * @access public
238 | * @return array
239 | */
240 | public function get_font_weight_choices() {
241 |
242 | return array(
243 | '100' => esc_html__( 'Thin', 'ctypo' ),
244 | '300' => esc_html__( 'Light', 'ctypo' ),
245 | '400' => esc_html__( 'Normal', 'ctypo' ),
246 | '500' => esc_html__( 'Medium', 'ctypo' ),
247 | '700' => esc_html__( 'Bold', 'ctypo' ),
248 | '900' => esc_html__( 'Ultra Bold', 'ctypo' ),
249 | );
250 | }
251 |
252 | /**
253 | * Returns the available font styles.
254 | *
255 | * @since 1.0.0
256 | * @access public
257 | * @return array
258 | */
259 | public function get_font_style_choices() {
260 |
261 | return array(
262 | 'normal' => esc_html__( 'Normal', 'ctypo' ),
263 | 'italic' => esc_html__( 'Italic', 'ctypo' ),
264 | 'oblique' => esc_html__( 'Oblique', 'ctypo' )
265 | );
266 | }
267 | }
268 |
--------------------------------------------------------------------------------
/ctypo.php:
--------------------------------------------------------------------------------
1 | `.
21 | add_action( 'wp_head', 'ctypo_print_styles' );
22 |
23 | /**
24 | * Register customizer panels, sections, settings, and controls.
25 | *
26 | * @since 1.0.0
27 | * @access public
28 | * @param object $wp_customize
29 | * @return void
30 | */
31 | function ctypo_customize_register( $wp_customize ) {
32 |
33 | // Load customizer typography control class.
34 | require_once( trailingslashit( plugin_dir_path( __FILE__ ) ) . 'customize/control-typography.php' );
35 |
36 | // Register typography control JS template.
37 | $wp_customize->register_control_type( 'Customizer_Typo_Control_Typography' );
38 |
39 | /* === Testing === */
40 |
41 | // Add the typography panel.
42 | $wp_customize->add_panel( 'typography', array( 'priority' => 5, 'title' => esc_html__( 'Typography', 'ctypo' ) ) );
43 |
44 | // Add the `
` typography section.
45 | $wp_customize->add_section( 'p_typography',
46 | array( 'panel' => 'typography', 'title' => esc_html__( 'Paragraphs', 'ctypo' ) )
47 | );
48 |
49 | // Add the headings typography section.
50 | $wp_customize->add_section( 'headings_typography',
51 | array( 'panel' => 'typography', 'title' => esc_html__( 'Headings', 'ctypo' ) )
52 | );
53 |
54 | // Add the `
` typography settings.
55 | // @todo Better sanitize_callback functions.
56 | $wp_customize->add_setting( 'p_font_family', array( 'default' => 'Arial', 'sanitize_callback' => 'sanitize_text_field', 'transport' => 'postMessage' ) );
57 | $wp_customize->add_setting( 'p_font_weight', array( 'default' => '400', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
58 | $wp_customize->add_setting( 'p_font_style', array( 'default' => 'normal', 'sanitize_callback' => 'sanitize_key', 'transport' => 'postMessage' ) );
59 | $wp_customize->add_setting( 'p_font_size', array( 'default' => '16', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
60 | $wp_customize->add_setting( 'p_line_height', array( 'default' => '32', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
61 |
62 | // Add the `
` typography settings.
63 | // @todo Better sanitize_callback functions.
64 | $wp_customize->add_setting( 'h1_font_family', array( 'default' => 'Georgia', 'sanitize_callback' => 'sanitize_text_field', 'transport' => 'postMessage' ) );
65 | $wp_customize->add_setting( 'h1_font_weight', array( 'default' => '400', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
66 | $wp_customize->add_setting( 'h1_font_style', array( 'default' => 'normal', 'sanitize_callback' => 'sanitize_key', 'transport' => 'postMessage' ) );
67 | //$wp_customize->add_setting( 'h1_font_size', array( 'default' => '28', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
68 | //$wp_customize->add_setting( 'h1_line_height', array( 'default' => '42', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
69 |
70 | // Add the `` typography settings.
71 | // @todo Better sanitize_callback functions.
72 | $wp_customize->add_setting( 'h2_font_family', array( 'default' => 'Georgia', 'sanitize_callback' => 'sanitize_text_field', 'transport' => 'postMessage' ) );
73 | $wp_customize->add_setting( 'h2_font_weight', array( 'default' => '400', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
74 | $wp_customize->add_setting( 'h2_font_style', array( 'default' => 'normal', 'sanitize_callback' => 'sanitize_key', 'transport' => 'postMessage' ) );
75 | //$wp_customize->add_setting( 'h2_font_size', array( 'default' => '24', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
76 | //$wp_customize->add_setting( 'h2_line_height', array( 'default' => '38', 'sanitize_callback' => 'absint', 'transport' => 'postMessage' ) );
77 |
78 | // Add the `
` typography control.
79 | $wp_customize->add_control(
80 | new Customizer_Typo_Control_Typography(
81 | $wp_customize,
82 | 'p_typography',
83 | array(
84 | 'label' => esc_html__( 'Paragraph Typography', 'ctypo' ),
85 | 'description' => __( 'Select how you want your paragraphs to appear.', 'ctypo' ),
86 | 'section' => 'p_typography',
87 |
88 | // Tie a setting (defined via `$wp_customize->add_setting()`) to the control.
89 | 'settings' => array(
90 | 'family' => 'p_font_family',
91 | 'weight' => 'p_font_weight',
92 | 'style' => 'p_font_style',
93 | 'size' => 'p_font_size',
94 | 'line_height' => 'p_line_height'
95 | ),
96 |
97 | // Pass custom labels. Use the setting key (above) for the specific label.
98 | 'l10n' => array(),
99 | )
100 | )
101 | );
102 |
103 | // Add the `
` typography control.
104 | $wp_customize->add_control(
105 | new Customizer_Typo_Control_Typography(
106 | $wp_customize,
107 | 'h1_typography',
108 | array(
109 | 'label' => esc_html__( 'Heading 1', 'ctypo' ),
110 | 'description' => __( 'Select how heading 1 should appear.', 'ctypo' ),
111 | 'section' => 'headings_typography',
112 |
113 | // Tie a setting (defined via `$wp_customize->add_setting()`) to the control.
114 | 'settings' => array(
115 | 'family' => 'h1_font_family',
116 | 'weight' => 'h1_font_weight',
117 | 'style' => 'h1_font_style',
118 | // 'size' => 'h1_font_size',
119 | // 'line_height' => 'h1_line_height'
120 | ),
121 |
122 | // Pass custom labels. Use the setting key (above) for the specific label.
123 | 'l10n' => array(),
124 | )
125 | )
126 | );
127 |
128 | // Add the `` typography control.
129 | $wp_customize->add_control(
130 | new Customizer_Typo_Control_Typography(
131 | $wp_customize,
132 | 'h2_typography',
133 | array(
134 | 'label' => esc_html__( 'Heading 2', 'ctypo' ),
135 | 'description' => __( 'Select how heading 2 should appear.', 'ctypo' ),
136 | 'section' => 'headings_typography',
137 |
138 | // Tie a setting (defined via `$wp_customize->add_setting()`) to the control.
139 | 'settings' => array(
140 | 'family' => 'h2_font_family',
141 | 'weight' => 'h2_font_weight',
142 | 'style' => 'h2_font_style',
143 | // 'size' => 'h2_font_size',
144 | // 'line_height' => 'h2_line_height'
145 | ),
146 |
147 | // Pass custom labels. Use the setting key (above) for the specific label.
148 | 'l10n' => array(),
149 | )
150 | )
151 | );
152 |
153 | /* === End Testing === */
154 | }
155 |
156 | /**
157 | * Register control scripts/styles.
158 | *
159 | * @since 1.0.0
160 | * @access public
161 | * @return void
162 | */
163 | function ctypo_customize_controls_register_scripts() {
164 |
165 | $uri = trailingslashit( plugin_dir_url( __FILE__ ) );
166 |
167 | wp_register_script( 'ctypo-customize-controls', esc_url( $uri . 'js/customize-controls.js' ), array( 'customize-controls' ) );
168 |
169 | wp_register_style( 'ctypo-customize-controls', esc_url( $uri . 'css/customize-controls.css' ) );
170 | }
171 |
172 | /**
173 | * Load preview scripts/styles.
174 | *
175 | * @since 1.0.0
176 | * @access public
177 | * @return void
178 | */
179 | function ctypo_customize_preview_enqueue_scripts() {
180 |
181 | $uri = trailingslashit( plugin_dir_url( __FILE__ ) );
182 |
183 | wp_enqueue_script( 'ctypo-customize-preview', esc_url( $uri . 'js/customize-preview.js' ), array( 'jquery' ) );
184 | }
185 |
186 | /**
187 | * Add custom body class to give some more weight to our styles.
188 | *
189 | * @since 1.0.0
190 | * @access public
191 | * @return void
192 | */
193 | function ctypo_print_styles() {
194 |
195 | $style = $_p_style = $_h1_style = $_h2_style = '';
196 |
197 | $allowed_weights = array( 100, 300, 400, 500, 700, 900 );
198 | $allowed_styles = array( 'normal', 'italic', 'oblique' );
199 |
200 | /* ===
=== */
201 |
202 | $p_family = get_theme_mod( 'p_font_family', '' );
203 | $p_weight = get_theme_mod( 'p_font_weight', '' );
204 | $p_style = get_theme_mod( 'p_font_style', '' );
205 | $p_size = get_theme_mod( 'p_font_size', '' );
206 | $p_line_h = get_theme_mod( 'p_line_height', '' );
207 |
208 | if ( $p_family )
209 | $_p_style .= sprintf( "font-family: '%s';", esc_attr( $p_family ) );
210 |
211 | if ( $p_weight )
212 | $_p_style .= sprintf( 'font-weight: %s;', in_array( absint( $p_weight ), $allowed_weights ) ? $p_weight : 400 );
213 |
214 | if ( $p_style )
215 | $_p_style .= sprintf( 'font-style: %s;', in_array( $p_style, $allowed_styles ) ? $p_style : 'normal' );
216 |
217 | if ( $p_size )
218 | $_p_style .= sprintf( 'font-size: %spx;', absint( $p_size ) );
219 |
220 | if ( $p_line_h )
221 | $_p_style .= sprintf( 'line-height: %spx;', absint( $p_line_h ) );
222 |
223 | if ( $_p_style )
224 | $_p_style = sprintf( 'body.ctypo p { %s }', $_p_style );
225 |
226 | /* ===
=== */
227 |
228 | $h1_family = get_theme_mod( 'h1_font_family', '' );
229 | $h1_weight = get_theme_mod( 'h1_font_weight', '' );
230 | $h1_style = get_theme_mod( 'h1_font_style', '' );
231 | $h1_size = get_theme_mod( 'h1_font_size', '' );
232 | $h1_line_h = get_theme_mod( 'h1_line_height', '' );
233 |
234 | if ( $h1_family )
235 | $_h1_style .= sprintf( "font-family: '%s';", esc_attr( $h1_family ) );
236 |
237 | if ( $h1_weight )
238 | $_h1_style .= sprintf( 'font-weight: %s;', in_array( absint( $h1_weight ), $allowed_weights ) ? $h1_weight : 400 );
239 |
240 | if ( $h1_style )
241 | $_h1_style .= sprintf( 'font-style: %s;', in_array( $h1_style, $allowed_styles ) ? $h1_style : 'normal' );
242 |
243 | if ( $h1_size )
244 | $_h1_style .= sprintf( 'font-size: %spx;', absint( $h1_size ) );
245 |
246 | if ( $h1_line_h )
247 | $_h1_style .= sprintf( 'line-height: %spx;', absint( $h1_line_h ) );
248 |
249 | if ( $_h1_style )
250 | $_h1_style = sprintf( 'body.ctypo h1 { %s }', $_h1_style );
251 |
252 | /* === === */
253 |
254 | $h2_family = get_theme_mod( 'h2_font_family', '' );
255 | $h2_weight = get_theme_mod( 'h2_font_weight', '' );
256 | $h2_style = get_theme_mod( 'h2_font_style', '' );
257 | $h2_size = get_theme_mod( 'h2_font_size', '' );
258 | $h2_line_h = get_theme_mod( 'h2_line_height', '' );
259 |
260 | if ( $h2_family )
261 | $_h2_style .= sprintf( "font-family: '%s';", esc_attr( $h2_family ) );
262 |
263 | if ( $h2_weight )
264 | $_h2_style .= sprintf( 'font-weight: %s;', in_array( absint( $h2_weight ), $allowed_weights ) ? $h2_weight : 400 );
265 |
266 | if ( $h2_style )
267 | $_h2_style .= sprintf( 'font-style: %s;', in_array( $h2_style, $allowed_styles ) ? $h2_style : 'normal' );
268 |
269 | if ( $h2_size )
270 | $_h2_style .= sprintf( 'font-size: %spx;', absint( $h2_size ) );
271 |
272 | if ( $h2_line_h )
273 | $_h2_style .= sprintf( 'line-height: %spx;', absint( $h2_line_h ) );
274 |
275 | if ( $_h2_style )
276 | $_h2_style = sprintf( 'body.ctypo h2 { %s }', $_h2_style );
277 |
278 | /* === Output === */
279 |
280 | // Join the styles.
281 | $style = join( '', array( $_p_style, $_h1_style, $_h2_style ) );
282 |
283 | // Output the styles.
284 | if ( $style ) {
285 | echo "\n" . '' . "\n";
286 |
287 | // Body class filter.
288 | add_filter( 'body_class', 'ctypo_body_class' );
289 | }
290 | }
291 |
292 | /**
293 | * Add custom body class to give some more weight to our styles.
294 | *
295 | * @since 1.0.0
296 | * @access public
297 | * @param array $classes
298 | * @return array
299 | */
300 | function ctypo_body_class( $classes ) {
301 | return array_merge( $classes, array( 'ctypo' ) );
302 | }
303 |
--------------------------------------------------------------------------------
/license.md:
--------------------------------------------------------------------------------
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 |
294 | Copyright (C)
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 | , 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.
--------------------------------------------------------------------------------