Atom Packages Directory

a package directory for a text editor of the 21st Century

Lorem

Install with:
    apm install lorem
  

Lorem package

A simple and powerful lorem ipsum generator for Atom editor. Fully configurable from the package settings.

Ported with love from the Lorem Ipsum brackets plugin by lkcampbell

Lorem Overview


How to Use

Important: For basic lorem ipsum text using the default settings just use the keybind alt+l.

Important: This README states that you need to use _ to seperate the arguments however you can any characters you want by adding them to the config on the package settings page.

You can also add options to the lorem command with an underscore character followed by the option name. For example: lorem_wrap40. Multiple options can also be chained together. For example, typing lorem_html_wrap40 and then pressing the alt+l will give you html formatted Lorem Ipsum text and a word wrap width of 40 characters. Using an unrecognized option will insert an error message into the document. Using more than one underscore character in a row (e.g. lorem__html___p3) will insert an error message into the document.

Note: Options to the far right of the chain always have the highest priority. If two options in the chain conflict with each other, the option on the right will have precedence. For example, the command lorem_nowrap_wrap40 will insert Lorem Ipsum text with a word wrap width of 40 characters and the command lorem_wrap40_nowrap will insert Lorem Ipsum text with no word wrapping.


List of Current Options

alt+l: Simply using the keybind alt+l will insert lorem ipsum text based on your personal configuration. The configuration can be changed in the package settings from the package menu.

Basic Example

_p[count]: Inserts a certain number of random Lorem Ipsum paragraphs into the current document. The count option indicates how many paragraphs to insert. For example, lorem_p3 will insert three paragraphs into the document. If the count option is not provided, one paragraph will be inserted. If the type of Lorem Ipsum text is not specified, the extension will generate paragraphs by default.

Paragraph Example

_s[count]: Inserts a certain number of random Lorem Ipsum sentences into the current document. The count option indicates how many sentences to insert. For example, lorem_s3 will insert three sentences into the document. If the count option is not provided, one sentence will be inserted.

Sentence Example

_w[count]: Inserts a certain number of random Lorem Ipsum words into the current document. The count option indicates how many words to insert. For example, lorem_w40 will insert 40 random words into the document. If the count option is not provided, one word will be inserted.

Word Example

_short: Makes all sentences or paragraphs short length.

_medium: Makes all sentences or paragraphs medium length. If no size options are provided, the extension will use _medium as the default option.

_long: Makes all sentences or paragraphs long length.

_vlong: Makes all sentences or paragraphs very long length.

Sizes Example

_nowrap: Inserts Lorem Ipsum text without any word wrapping.

_wrap[width]: Word wraps Lorem Ipsum text using the specified width. For example, lorem_wrap40 will wrap the text at 40 characters. If a word wrap option is not provided, the extension will use _wrap80 as the default option. If you want to turn word wrap off, use the _nowrap option. This option has no effect on the _link, _ol, or _ul options.

Wrapping Example

_link[count]: Inserts a certain number of random Lorem Ipsum HTML links into the current document. The HTML link will always point to https://atom.io/. The count option indicates how many links to insert. For example, lorem_link3 will insert three links, separated by page breaks, into the document. If the count option is not provided, one link will be inserted. To avoid badly formatted HTML, the _link option ignores any _wrap options and is always set to _nowrap.

Links Example

_ol[count], _ul[count]: Inserts a random Lorem Ipsum HTML list into the current document. Use _ol for an ordered list and _ul for an unordered list. The count option indicates how many list items to insert. For example, lorem_ol3 will insert an ordered list with three list items into the document. If the count option is not provided, a list with one item will be inserted. To avoid badly formatted HTML, both of these options ignore any _wrap options and are always set to _nowrap.

Lists Example

_html: Wraps Lorem Ipsum text in <p></p> tags so it displays correctly in HTML. For options _p and _seach individual paragraph or sentence is wrapped. For options _w and _link, the entire collection of words or links is wrapped. This option is not available for lists since lists are not inline elements.

HTML Example

_?, _help: Displays help for the Lorem Ipsum extension. If this option is used, all other options will be ignored and no Lorem Ipsum text will be generated.

Note: Any option that has a number associated with it (e.g. _p3, _wrap40) can also be entered with the number portion in front of the option (i.e. _3p, _40wrap) and it will work the same way.


Other Features

Comment Support: The package allows for text to be inserted as a comment. Just use the keybind or type your command as a comment and it will add commented lorem text. Note: Block comments are not supported.

Comment Example

Multi Cursor Support: Support for multiple cursors has been added. If the cursors are next to valid commands then it will parse all of your lorem text. Woo many lorems.

Multi Cursor Example


Contributing

This is my first atom package and I welcome all the help/support/feedback I can get so if you have any or would like to make a pull-request please feel free. If you do want to contribute I am using the prettier package to format the code. Many thanks.


License

MIT License: See LICENSE for more details.

Keywords: lorem, lorem-ipsum, ipsum, text, generator Suggest keywords
Fork me on GitHub