Page not found
+ +Sorry, but the page you were trying to get to, does not exist. You +may want to try searching this site using the sidebar or using our +API Reference page to find what +you were looking for.
+ + +diff --git a/README.md b/README.md index 784e4e2..8391bd6 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,85 @@ ## Development To start development on #Larus, execute the following: #. Become some sort of privileged user: $ sudo su - #. Download the repository configuration: # cd /etc/yum.repos.d/ # wget https://obs.kolabsys.com/repositories/home:/vanmeeuwen:/erlang-18.3/Fedora_23/home:vanmeeuwen:erlang-18.3.repo # wget https://obs.kolabsys.com/repositories/home:/vanmeeuwen:/phoenix/Fedora_23/home:vanmeeuwen:phoenix.repo #. Install phoenix: # dnf -y install phoenix +#. Install and start a Postgres server: + + # dnf -y install postgresql-server + # systemctl enable postgresql + # postgresql-setup --initdb + # sed -i -e 's/ident/trust/g' /var/lib/pgsql/data/pg_hba.conf + # systemctl start postgresql + #. Don't forget to log out: # logout #. Provided your GIT checkout, initialize git flow: $ git flow init --default #. Download and install the required `.ez` files: $ mix local.hex $ mix archive.install https://github.com/phoenixframework/archives/raw/master/phoenix_new.ez #. Start a feature, support, hotfix, ...: $ git flow feature start trial-and-error $ cd larus $ mix deps.get $ npm install $ mix phoenix.server -### Before you commit +### Before You Commit $ mix dogma $ mix credo +Fix coding style issues that are reported. + + $ mix test + $ mix docs + ## `~/.vimrc` Use `~/.vimrc` or equivalent to ensure the "correct" indentation is used: ``` " " elixir and such autocmd BufRead,BufNewFile *.ex set shiftwidth=2 tabstop=2 expandtab autocmd BufRead,BufNewFile *.ex set shiftwidth=2 tabstop=2 expandtab autocmd BufRead,BufNewFile *.exs set shiftwidth=2 tabstop=2 expandtab ``` ## l10n Add supported locales to `larus/config/config.exs`. Extract strings: $ mix gettext.extract Merge in new translated strings: $ mix gettext.merge priv/gettext/ Create a new locale: $ mix gettext.merge priv/gettext/ --locale de diff --git a/larus/doc/404.html b/larus/doc/404.html new file mode 100644 index 0000000..07153d3 --- /dev/null +++ b/larus/doc/404.html @@ -0,0 +1,90 @@ + + +
+ + + + +Sorry, but the page you were trying to get to, does not exist. You +may want to try searching this site using the sidebar or using our +API Reference page to find what +you were looking for.
+ + +Provides only one single method definition blank?/1
Returns true
if data is considered blank/empty
t :: term
+
+Returns true
if data is considered blank/empty.
Tools around checking and handling undefined or blank data.
+ +Returns true
if data is considered blank/empty
Returns the provided data
if valid of the default
value if not
Returns true
if data is not considered blank/empty
Returns true
if data is considered blank/empty.
Returns the provided data
if valid of the default
value if not.
Returns true
if data is not considered blank/empty.
Larus.Endpoint
+ +Returns all sockets configured in this endpoint
+Callback implementation for c:Plug.call/2
Returns the endpoint configuration for key
Reloads the configuration given the application environment changes
+Callback implementation for c:Plug.init/1
Generates the path information when routing to this endpoint
+Starts the endpoint supervision tree
+Generates a route to a static file in priv/static
Generates the static URL without any path information
+Generates the endpoint base URL but as a URI
struct
Generates the endpoint base URL without any path information
+Instruments the given function
+Returns all sockets configured in this endpoint.
+ +Callback implementation for c:Plug.call/2
.
Returns the endpoint configuration for key
Returns default
if the key does not exist.
Reloads the configuration given the application environment changes.
+ +Callback implementation for c:Plug.init/1
.
Generates the path information when routing to this endpoint.
+ +Starts the endpoint supervision tree.
+ +Generates a route to a static file in priv/static
.
Generates the static URL without any path information.
+It uses the configuration under :static_url
to generate
+such. It fallsback to :url
if :static_url
is not set.
Generates the endpoint base URL but as a URI
struct.
It uses the configuration under :url
to generate such.
+Useful for manipulating the url data and passing to
+URL helpers.
Generates the endpoint base URL without any path information.
+It uses the configuration under :url
to generate such.
Instruments the given function.
+event
is the event identifier (usually an atom) that specifies which
+instrumenting function to call in the instrumenter modules. runtime
is
+metadata to be associated with the event at runtime (e.g., the query being
+issued if the event to instrument is a DB query).
instrument :render_view, %{view: "index.html"}, fn ->
+ render conn, "index.html"
+end
+
+ Conveniences for translating and building error messages.
+ +Generates tag for inlined form input errors
+Translates an error message using gettext
+Generates tag for inlined form input errors.
+ +Translates an error message using gettext.
+ +Views on errors
+ +Returns true whenever the list of templates changes in the filesystem
+The resource name, as an atom, for this view
+Returns the template root alongside all templates
+Renders the given template locally
+Callback invoked when no template is found. +By default it raises but can be customized +to render a particular template
+Returns true whenever the list of templates changes in the filesystem.
+ +The resource name, as an atom, for this view
+ +Returns the template root alongside all templates.
+ +Renders the given template locally.
+ +Callback invoked when no template is found. +By default it raises but can be customized +to render a particular template.
+ +A module providing Internationalization with a gettext-based API.
+By using Gettext, +your module gains a set of macros for translations, for example:
+import Larus.Gettext
+# Simple translation + gettext “Here is the string to translate”
+# Plural translation + ngettext “Here is the string to translate”,
+ "Here are the strings to translate",
+ 3
+# Domain-based translation + dgettext “errors”, “Here is the error message to translate”
+See the Gettext Docs for detailed usage.
+ +A layout view.
+ +Returns true whenever the list of templates changes in the filesystem
+The resource name, as an atom, for this view
+Returns the template root alongside all templates
+Renders the given template locally
+Callback invoked when no template is found. +By default it raises but can be customized +to render a particular template
+Returns true whenever the list of templates changes in the filesystem.
+ +The resource name, as an atom, for this view
+ +Returns the template root alongside all templates.
+ +Renders the given template locally.
+ +Callback invoked when no template is found. +By default it raises but can be customized +to render a particular template.
+ +The Larus page view
+ +Returns true whenever the list of templates changes in the filesystem
+The resource name, as an atom, for this view
+Returns the template root alongside all templates
+Renders the given template locally
+Callback invoked when no template is found. +By default it raises but can be customized +to render a particular template
+Returns true whenever the list of templates changes in the filesystem.
+ +The resource name, as an atom, for this view
+ +Returns the template root alongside all templates.
+ +Renders the given template locally.
+ +Callback invoked when no template is found. +By default it raises but can be customized +to render a particular template.
+ +Larus.Repo
+ +Callback implementation for c:Ecto.Repo.all/2
Callback implementation for c:Ecto.Repo.config/0
Callback implementation for c:Ecto.Repo.delete/2
Callback implementation for c:Ecto.Repo.delete!/2
Callback implementation for c:Ecto.Repo.delete_all/2
Callback implementation for c:Ecto.Repo.get/3
Callback implementation for c:Ecto.Repo.get!/3
Callback implementation for c:Ecto.Repo.get_by/3
Callback implementation for c:Ecto.Repo.get_by!/3
Callback implementation for c:Ecto.Repo.insert/2
Callback implementation for c:Ecto.Repo.insert!/2
Callback implementation for c:Ecto.Repo.insert_or_update/2
Callback implementation for c:Ecto.Repo.insert_or_update!/2
Callback implementation for c:Ecto.Repo.log/1
Callback implementation for c:Ecto.Repo.one/2
Callback implementation for c:Ecto.Repo.one!/2
Callback implementation for c:Ecto.Repo.preload/2
Callback implementation for c:Ecto.Repo.rollback/1
Callback implementation for c:Ecto.Repo.stop/2
Callback implementation for c:Ecto.Repo.transaction/2
Callback implementation for c:Ecto.Repo.update/2
Callback implementation for c:Ecto.Repo.update!/2
Callback implementation for c:Ecto.Repo.update_all/3
Callback implementation for c:Ecto.Repo.all/2
.
Callback implementation for c:Ecto.Repo.config/0
.
Callback implementation for c:Ecto.Repo.delete/2
.
Callback implementation for c:Ecto.Repo.delete!/2
.
Callback implementation for c:Ecto.Repo.delete_all/2
.
Callback implementation for c:Ecto.Repo.get/3
.
Callback implementation for c:Ecto.Repo.get!/3
.
Callback implementation for c:Ecto.Repo.get_by/3
.
Callback implementation for c:Ecto.Repo.get_by!/3
.
Callback implementation for c:Ecto.Repo.insert/2
.
Callback implementation for c:Ecto.Repo.insert!/2
.
Callback implementation for c:Ecto.Repo.insert_or_update/2
.
Callback implementation for c:Ecto.Repo.insert_or_update!/2
.
Callback implementation for c:Ecto.Repo.log/1
.
Callback implementation for c:Ecto.Repo.one/2
.
Callback implementation for c:Ecto.Repo.one!/2
.
Callback implementation for c:Ecto.Repo.preload/2
.
rollback(term) :: no_return
+
+ Callback implementation for c:Ecto.Repo.rollback/1
.
Callback implementation for c:Ecto.Repo.stop/2
.
Callback implementation for c:Ecto.Repo.transaction/2
.
Callback implementation for c:Ecto.Repo.update/2
.
Callback implementation for c:Ecto.Repo.update!/2
.
Callback implementation for c:Ecto.Repo.update_all/3
.
Module with named helpers generated from Larus.Router.
+ +Generates the path information including any necessary prefix
+Generates path to a static asset given its file path
+Generates url to a static asset given its file path
+Generates the connection/endpoint base URL without any path information
+Generates the path information including any necessary prefix.
+ +Generates path to a static asset given its file path.
+ +Generates url to a static asset given its file path.
+ +Generates the connection/endpoint base URL without any path information.
+ +Larus.Router
+ +Callback invoked by Plug on every request
+Callback required by Plug that initializes the router +for serving web requests
+Callback invoked by Plug on every request.
+ +Callback required by Plug that initializes the router +for serving web requests.
+ +Larus.UserSocket
+ +Callback implementation for c:Phoenix.Socket.connect/2
Callback implementation for c:Phoenix.Socket.id/1
Callback implementation for c:Phoenix.Socket.connect/2
.
Callback implementation for c:Phoenix.Socket.id/1
.
A module that keeps using definitions for controllers, +views and so on.
+This can be used in your application as:
+use Larus.Web, :controller
+use Larus.Web, :view
+The definitions below will be executed for every view, +controller, etc, so keep them short and clean, focused +on imports, uses and aliases.
+Do NOT define functions inside the quoted expressions +below.
+ +When used, dispatch to the appropriate controller/view/etc
+When used, dispatch to the appropriate controller/view/etc.
+ +Application
+ +Callback implementation for c::application.start/2
.
Tools around checking and handling undefined or blank data
+Application
+Larus.Endpoint
+Conveniences for translating and building error messages
+Views on errors
+A module providing Internationalization with a gettext-based API
+A layout view
+Larus.PageController
+The Larus page view
+Larus.Repo
+Larus.Router
+Module with named helpers generated from Larus.Router
+Larus.UserSocket
+A module that keeps using definitions for controllers, +views and so on
+Provides only one single method definition blank?/1