From 8368a9982a68c4dc23d9601221752eb3be725519 Mon Sep 17 00:00:00 2001 From: Domizio Demichelis Date: Tue, 20 Nov 2018 12:20:42 +0700 Subject: [PATCH] Synopsys > Synopsis --- docs/api/backend.md | 2 +- docs/api/frontend.md | 2 +- docs/api/pagy.md | 2 +- docs/extras.md | 2 +- docs/extras/array.md | 2 +- docs/extras/bootstrap.md | 2 +- docs/extras/bulma.md | 2 +- docs/extras/countless.md | 2 +- docs/extras/elasticsearch_rails.md | 2 +- docs/extras/foundation.md | 2 +- docs/extras/i18n.md | 2 +- docs/extras/items.md | 2 +- docs/extras/materialize.md | 2 +- docs/extras/navs.md | 6 +++--- docs/extras/overflow.md | 2 +- docs/extras/searchkick.md | 2 +- docs/extras/semantic.md | 2 +- docs/extras/trim.md | 2 +- 18 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/api/backend.md b/docs/api/backend.md index 74601227f..0efe62ecb 100644 --- a/docs/api/backend.md +++ b/docs/api/backend.md @@ -11,7 +11,7 @@ For overriding convenience, the `pagy` method calls two sub-methods that you may Check also the [array extra](../extras/array.md) and [searchkick extra](../extras/searchkick.md) for specific backend customizations. -## Synopsys +## Synopsis ```ruby # in some controller diff --git a/docs/api/frontend.md b/docs/api/frontend.md index e325f877a..57a133cd9 100644 --- a/docs/api/frontend.md +++ b/docs/api/frontend.md @@ -7,7 +7,7 @@ This module provides a few methods to deal with the navigation aspect of the pag You can extend this module with a few more `nav_*` helpers _(see the [extras](../extras.md) doc for more details)_ -## Synopsys +## Synopsis ```ruby # typically in some helper diff --git a/docs/api/pagy.md b/docs/api/pagy.md index aab656abc..9a1b95196 100644 --- a/docs/api/pagy.md +++ b/docs/api/pagy.md @@ -5,7 +5,7 @@ title: Pagy The scope of the `Pagy` class is keeping track of the all integers and variables involved in the pagination. It basically takes a few integers (such as the count of the collection, the page number, the items per page, ...), does some simple aritmetic and creates a very small object that allocates less than 3k of memory. _([source](https://github.com/ddnexus/pagy/blob/master/lib/pagy.rb))_ -## Synopsys +## Synopsis ```ruby # set global defaults and extra variables typically in the pagy.rb initializer diff --git a/docs/extras.md b/docs/extras.md index a151c2523..0515f431b 100644 --- a/docs/extras.md +++ b/docs/extras.md @@ -22,7 +22,7 @@ Pagy comes with a few optional extensions/extras: | `semantic` | Nav helpers for the Semantic UI CSS [pagination component](https://semantic-ui.com/collections/menu.html) | [semantic.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/semantic.rb), [documentation](extras/semantic.md) | | `trim` | Remove the `page=1` param from links | [trim.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/trim.rb), [documentation](extras/trim.md) | -## Synopsys +## Synopsis Extras are not loaded by default, so you should require them explicitly in your `pagy.rb` initializer _(see [Configuration](how-to.md#global-configuration))_: diff --git a/docs/extras/array.md b/docs/extras/array.md index 4ee209ecc..440f23f4d 100644 --- a/docs/extras/array.md +++ b/docs/extras/array.md @@ -7,7 +7,7 @@ This extra adds a specialized pagination for arrays without the need to override That means that you can paginate the array independently from any other kind of collections you may need to paginate even in the same action. -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/bootstrap.md b/docs/extras/bootstrap.md index a1f4fcc2d..5d3ae7cd2 100644 --- a/docs/extras/bootstrap.md +++ b/docs/extras/bootstrap.md @@ -5,7 +5,7 @@ title: Bootstrap This extra adds nav helpers and templates for the Bootstrap [pagination component](https://getbootstrap.com/docs/4.1/components/pagination). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/bulma.md b/docs/extras/bulma.md index 2f38899e7..219f5e627 100644 --- a/docs/extras/bulma.md +++ b/docs/extras/bulma.md @@ -5,7 +5,7 @@ title: Bulma This extra adds nav helper and templates for the Bulma CSS [pagination component](https://bulma.io/documentation/components/pagination). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/countless.md b/docs/extras/countless.md index be407fc8d..b9a2dde28 100644 --- a/docs/extras/countless.md +++ b/docs/extras/countless.md @@ -9,7 +9,7 @@ Its usage is practically the same as the regular `Pagy::Backend` module (see the The pagination resulting from this extra has some limitation as documented in the [Pagy::Countless Caveats doc](../api/countless.md#caveats). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/elasticsearch_rails.md b/docs/extras/elasticsearch_rails.md index c95120a1b..3fe12ce11 100644 --- a/docs/extras/elasticsearch_rails.md +++ b/docs/extras/elasticsearch_rails.md @@ -5,7 +5,7 @@ title: Elasticsearch Rails Paginate `ElasticsearchRails::Results` objects efficiently avoiding expensive object-wrapping and without overriding. -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/foundation.md b/docs/extras/foundation.md index 4076a8a4c..8f2a689a4 100644 --- a/docs/extras/foundation.md +++ b/docs/extras/foundation.md @@ -5,7 +5,7 @@ title: Foundation This extra adds nav helper and templates for the Foundation [pagination component](https://foundation.zurb.com/sites/docs/pagination.html). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/i18n.md b/docs/extras/i18n.md index 12279e133..5ef11970e 100644 --- a/docs/extras/i18n.md +++ b/docs/extras/i18n.md @@ -7,7 +7,7 @@ The `i18n` extra overrides the `pagy_t` method so it uses `I18n.t`. Use this ext See also [I18n](../api/frontend.md#i18n). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/items.md b/docs/extras/items.md index 2c3b1f6e7..43abacd73 100644 --- a/docs/extras/items.md +++ b/docs/extras/items.md @@ -7,7 +7,7 @@ Allow the client to request a custom number of items per page with an optional s It works also with the [countless extra](countless.md). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/materialize.md b/docs/extras/materialize.md index 34cf6610c..241faf6a9 100644 --- a/docs/extras/materialize.md +++ b/docs/extras/materialize.md @@ -5,7 +5,7 @@ title: Materialize This extra adds nav helpers for the Materialize CSS [pagination component](https://materializecss.com/pagination.html). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/navs.md b/docs/extras/navs.md index c6c452410..0e91440ee 100644 --- a/docs/extras/navs.md +++ b/docs/extras/navs.md @@ -7,7 +7,7 @@ This extra adds a couple of nav helpers to the `Pagy::Frontend` module: `pagy_na Other extras (e.g. [bootstrap](bootstrap.md), [bulma](bulma.md), [foundation](foundation.md), [materialize](materialize.md)) provide framework-styled versions of the same `responsive` and `compact` helpers, so you may not need this extra if you use one of those. -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. @@ -29,7 +29,7 @@ The `compact` navs (implemented by this extra or by other frontend extras) add a It is especially useful for small size screens, but it is used also with wide layouts since it is __even faster__ than the classic nav of links, because it needs to render just a minimal HTML string. -## Synopsys +## Synopsis Use the responsive helper(s) in any view: @@ -63,7 +63,7 @@ Here is a screenshot (from the `bootstrap`extra) of how the same pagination nav ![pagy-responsive](../assets/images/pagy-responsive-g.png) -## Synopsys +## Synopsis ```ruby # set your default custom breakpoints (width/size pairs) globally (it can be overridden per Pagy instance) diff --git a/docs/extras/overflow.md b/docs/extras/overflow.md index 3e1bb811e..043af2f8f 100644 --- a/docs/extras/overflow.md +++ b/docs/extras/overflow.md @@ -5,7 +5,7 @@ title: Overflow This extra allows for easy handling of overflowing pages. It internally rescues from the `Pagy::OverflowError` offering a few different ready to use modes, quite useful for UIs and/or APIs. It works with `Pagy` or `Pagy::Countless` instances. -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/searchkick.md b/docs/extras/searchkick.md index 978560a0f..b089eb776 100644 --- a/docs/extras/searchkick.md +++ b/docs/extras/searchkick.md @@ -7,7 +7,7 @@ Paginate `Searchkick::Results` objects efficiently avoiding expensive oject-wrap The `Searchkick::Results` object has already done pagination calculations, we just need to tell Pagy how to read page and total values. It is expected that you let Searchkick handle the `page` and `per_page` variables instead of providing those values as options to Pagy. -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/semantic.md b/docs/extras/semantic.md index 84b6948f2..eb78d78db 100644 --- a/docs/extras/semantic.md +++ b/docs/extras/semantic.md @@ -5,7 +5,7 @@ title: Semantic UI This extra adds nav helper and templates for Semantic UI CSS [pagination component](https://semantic-ui.com/collections/menu.html#pagination). -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info. diff --git a/docs/extras/trim.md b/docs/extras/trim.md index 040e8642d..545039d75 100644 --- a/docs/extras/trim.md +++ b/docs/extras/trim.md @@ -7,7 +7,7 @@ This extra removes the `page=1` param from the link of the first page. You need This extra is needed only for very specific scenarios, for example if you need to avoid frontend cache duplicates. -## Synopsys +## Synopsis See [extras](../extras.md) for general usage info.