Типографика — это круто!
\n\ntxt = tp.format(\"Типографика - это круто!\", {\n 'Text.paragraphs': false\n}); // Типографика — это круто!\n```\n\nYou can also pass a callback to the method `format`:\n\n```javascript\nMdash.format(\"Типографика - это круто!\", {'Text.paragraphs': true}, function(err, text) {\n console.log(text); //Типографика — это круто!
\n});\n\nMdash.format(\"Типографика - это круто!\", function(err, text) {\n console.log(text); // Типографика — это круто!\n});\n```\n\nAlso you can get the list of trets (in order of appliance):\n\n```javascript\nvar typo = new Mdash();\nvar trets = typo.getTretNames();\n\n// [ 'Text',\n// 'Space',\n// 'Number',\n// 'Quote',\n// 'Punctmark',\n// 'Date',\n// 'Symbol',\n// 'Nobr',\n// 'Dash',\n// 'Abbr',\n// 'OptAlign',\n// 'Etc' ]\n```\n\nGet rules for all tret or specific one:\n\n```javascript\nvar typo = new Mdash();\nvar allRules = typo.getRuleNames(); // Get all rules\n\nvar dashRules = typo.getRuleNames('Dash'); // Specify a tret as argument\n\n// { Dash:\n// [ 'mdash_symbol_to_html_mdash',\n// 'mdash',\n// 'mdash_2',\n// 'mdash_3',\n// 'iz_za_pod',\n// 'to_libo_nibud',\n// 'koe_kak',\n// 'ka_de_kas' ] }\n```\n\nYou can get current settings of the typograph:\n\n```javascript\nvar typo = new Mdash();\nvar settings = typo.getSettings();\n\n// { Quote: { no_bdquotes: false, no_inches: false },\n// OptAlign: { disabled: true },\n// Text: { disabled: true },\n// 'Dash.ka_de_kas': { disabled: true },\n// 'Date.mdash_month_interval': { disabled: true },\n// 'Date.nbsp_and_dash_month_interval': { disabled: true },\n// 'Nobr.hyphen_nowrap_in_small_words': { disabled: true },\n// 'Nobr.hyphen_nowrap': { disabled: true },\n// 'Punctmark.dot_on_end': { disabled: true },\n// 'OptAlign.oa_obracket_coma': { disabled: true } }\n```\n\n### Module Settings\n\nBy default some rules (eg. rules for Optical Alignment) put additional HTML tags in your text with inline styles. If you would like to put styles in separate classes, use this:\n\n```javascript\nMdash.setLayout(Mdash.LAYOUT_CLASS);\n```\n\nOr you can set styles to go both inline and in class:\n\n```javascript\nMdash.setLayout(Mdash.LAYOUT_STYLE|Mdash.LAYOUT_CLASS);\n```\n\nAnd to set class prefix (by default it is `'mdash-'`):\n\n```javascript\nMdash.setLayoutClassPrefix('typo-');\n```\n\n### Rules Settings\nAll settings are usualy just the rule names with tret name as the namespace, so mainly you can enable or disable some of them. Also you can specify some options for the rule or specify some virtual settings for different rules. To disable some rule you can pass the arguments object where key is rulename (with namespace — tret name) and the value is `false`. For example, we want to disable rule `oa_obracket_coma` in namespace `OptAlign`:\n\n```javascript\n{\n 'OptAlign.oa_obracket_coma': false\n}\n```\n\nAlso we can disable all rules in the namespace:\n\n```javascript\n{\n 'OptAlign': false\n}\n```\n\nIn case we need to specify some options inside the rules or to apply some methods inside the different rules, we can use \"virtual\" rules. It is just a setting which name does not conflict with real rule name and selects specified rules:\n\n```javascript\n{\n 'Space.autospace_after': {\n selector: 'Space.autospace_after_*'\n },\n 'Etc.unicode': {\n selector: '*',\n dounicode: true,\n disabled: true\n }\n}\n```\n\nThere is no such rule as `Etc.unicode`, however if we will pass this as setting to the lib, the option `dounicode` will be applied to the rules specified in `selector` (to all rules in this case). Also switching `disabled` will either enable or disable it.\n\nFor example, to turn on convertion of the HTML entities in unicode characters we can put this in settings:\n\n```javascript\nvar typo = new Mdash({\n 'Etc.unicode': true\n});\n```\n\nOr if we would like to disable all rules which puts space after punctuation marks:\n\n```javascript\nvar typo = new Mdash({\n 'Space.autospace_after': false\n});\n```\n\nWhich is equal to this settings for the real rules:\n\n```javascript\nvar typo = new Mdash({\n 'Space.autospace_after_comma': false,\n 'Space.autospace_after_pmarks': false,\n 'Space.autospace_after_dot': false,\n 'Space.autospace_after_hellips': false\n});\n```\n\n\nThere are several presets and predefined \"virtual\" options:\n\n```javascript\nMdash.prototype.presets = {\n 'Quote': {\n no_bdquotes: false,\n no_inches: false\n },\n 'OptAlign': {\n disabled: true\n },\n 'Text': {\n disabled: true\n },\n 'Dash.ka_de_kas': {\n disabled: true\n },\n 'Date.mdash_month_interval': {\n disabled: true\n },\n 'Date.nbsp_and_dash_month_interval': {\n disabled: true\n },\n 'Nobr.hyphen_nowrap_in_small_words': {\n disabled: true\n },\n 'Nobr.hyphen_nowrap': {\n disabled: true\n },\n 'Punctmark.dot_on_end': {\n disabled: true\n },\n 'Space.clear_before_after_punct': {\n selector: 'Space.remove_space_before_punctuationmarks'\n },\n 'Space.autospace_after': {\n selector: 'Space.autospace_after_*'\n },\n 'Space.bracket_fix': {\n selector: ['Space.nbsp_before_open_quote', 'Punctmark.fix_brackets']\n },\n 'Etc.unicode': {\n selector: '*',\n dounicode: true,\n disabled: true\n }\n};\n```\n\n### .mdash\n\nYou can specify global settings by putting simple JSON file `.mdash` in the root of your project:\n\n```javascript\n{\n \"OptAlign.oa_obracket_coma\": false,\n \"Text.paragraphs\": false,\n \"Text.breakline\": false,\n \"Quote\": false\n}\n```\n\nThis settings will override the default, but will be overriden by options you'll pass to instance.\n\n\n## License\n\nThis package is licensed under the MIT license.\n","maintainers":[{"name":"semencov","email":"hello@semencov.com"}],"time":{"modified":"2022-06-19T17:16:09.599Z","created":"2014-11-04T15:10:56.812Z","0.2.0":"2014-11-04T15:10:56.812Z","0.2.1":"2014-11-04T15:18:54.972Z","0.2.2":"2014-11-04T16:08:44.173Z","0.2.3":"2014-11-19T09:58:08.165Z","0.2.4":"2014-11-26T13:18:42.343Z","0.2.5":"2014-11-26T13:23:16.383Z","0.2.6":"2014-12-17T13:24:53.549Z","0.2.7":"2014-12-17T14:05:03.292Z","0.2.8":"2015-02-10T15:31:08.631Z","0.2.9":"2015-02-10T16:00:26.295Z","0.2.10":"2015-02-16T17:47:03.490Z","0.2.11":"2015-02-16T21:15:40.256Z","0.2.12":"2015-02-16T21:19:30.771Z","0.2.13":"2015-02-16T21:26:27.087Z","1.0.0":"2015-03-03T17:32:34.782Z","1.0.1":"2015-04-27T14:33:56.901Z"},"homepage":"https://github.com/semencov/mdash-node","keywords":["mdash","mdash.ru","typography","typograf","typographer","EMT","emt"],"repository":{"type":"git","url":"https://github.com/semencov/mdash-node.git"},"author":{"name":"Yuri Sementsov","email":"hello@semencov.com","url":"http://semencov.com/"},"bugs":{"url":"https://github.com/semencov/mdash-node/issues"},"readmeFilename":"README.md","license":"MIT","users":{"vitstr":true}}