From d8d8f881f2f7afea85d8771498f2131e9c248bfb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vo=C5=99=C3=AD=C5=A1ek?= Date: Sat, 15 Jul 2023 12:02:39 +0200 Subject: [PATCH] Rename docs files from rst to md (#2083) for GH-2080, rename in separate commit for better git tracking --- README.md | 66 ++++--- docs/Makefile | 177 ------------------ docs/README.md | 19 -- docs/{accordion.rst => accordion.md} | 0 docs/{advanced.rst => advanced.md} | 0 docs/{app.rst => app.md} | 0 docs/{autocomplete.rst => autocomplete.md} | 0 docs/{breadcrumb.rst => breadcrumb.md} | 0 docs/{button.rst => button.md} | 0 docs/{callbacks.rst => callbacks.md} | 0 docs/{components.rst => components.md} | 0 docs/conf.py | 120 +----------- docs/{console.rst => console.md} | 0 docs/{core.rst => core.md} | 0 docs/{crud.rst => crud.md} | 0 docs/{data.rst => data.md} | 0 docs/{dataexecutor.rst => dataexecutor.md} | 0 docs/{filestructure.rst => filestructure.md} | 0 docs/{fileupload.rst => fileupload.md} | 0 docs/{form-control.rst => form-control.md} | 0 docs/{form.rst => form.md} | 0 docs/{grid.rst => grid.md} | 0 docs/{header.rst => header.md} | 0 docs/{helloworld.rst => helloworld.md} | 0 docs/{icon.rst => icon.md} | 0 docs/{image.rst => image.md} | 0 docs/{index.rst => index.md} | 0 docs/{js.rst => js.md} | 0 docs/{label.rst => label.md} | 0 docs/{lister.rst => lister.md} | 0 docs/{loremipsum.rst => loremipsum.md} | 0 docs/{menu.rst => menu.md} | 0 docs/{message.rst => message.md} | 0 docs/{misc.rst => misc.md} | 0 docs/{multiline.rst => multiline.md} | 0 docs/{overview.rst => overview.md} | 0 docs/{paginator.rst => paginator.md} | 0 docs/{popup.rst => popup.md} | 0 docs/{progressbar.rst => progressbar.md} | 0 docs/{quickstart.rst => quickstart.md} | 0 docs/{render.rst => render.md} | 0 docs/requirements.txt | 6 +- docs/{rightpanel.rst => rightpanel.md} | 0 docs/{seed.rst => seed.md} | 0 docs/{session.rst => session.md} | 0 docs/{sticky.rst => sticky.md} | 0 docs/{table.rst => table.md} | 0 docs/{tablecolumn.rst => tablecolumn.md} | 0 docs/{tabs.rst => tabs.md} | 0 docs/{template.rst => template.md} | 0 docs/{text.rst => text.md} | 0 ...tem-selector.rst => tree-item-selector.md} | 0 ...-presentation.rst => type-presentation.md} | 0 docs/{view.rst => view.md} | 0 docs/{virtualpage.rst => virtualpage.md} | 0 docs/{wizard.rst => wizard.md} | 0 js/README.md | 47 +++-- 57 files changed, 60 insertions(+), 375 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/README.md rename docs/{accordion.rst => accordion.md} (100%) rename docs/{advanced.rst => advanced.md} (100%) rename docs/{app.rst => app.md} (100%) rename docs/{autocomplete.rst => autocomplete.md} (100%) rename docs/{breadcrumb.rst => breadcrumb.md} (100%) rename docs/{button.rst => button.md} (100%) rename docs/{callbacks.rst => callbacks.md} (100%) rename docs/{components.rst => components.md} (100%) rename docs/{console.rst => console.md} (100%) rename docs/{core.rst => core.md} (100%) rename docs/{crud.rst => crud.md} (100%) rename docs/{data.rst => data.md} (100%) rename docs/{dataexecutor.rst => dataexecutor.md} (100%) rename docs/{filestructure.rst => filestructure.md} (100%) rename docs/{fileupload.rst => fileupload.md} (100%) rename docs/{form-control.rst => form-control.md} (100%) rename docs/{form.rst => form.md} (100%) rename docs/{grid.rst => grid.md} (100%) rename docs/{header.rst => header.md} (100%) rename docs/{helloworld.rst => helloworld.md} (100%) rename docs/{icon.rst => icon.md} (100%) rename docs/{image.rst => image.md} (100%) rename docs/{index.rst => index.md} (100%) rename docs/{js.rst => js.md} (100%) rename docs/{label.rst => label.md} (100%) rename docs/{lister.rst => lister.md} (100%) rename docs/{loremipsum.rst => loremipsum.md} (100%) rename docs/{menu.rst => menu.md} (100%) rename docs/{message.rst => message.md} (100%) rename docs/{misc.rst => misc.md} (100%) rename docs/{multiline.rst => multiline.md} (100%) rename docs/{overview.rst => overview.md} (100%) rename docs/{paginator.rst => paginator.md} (100%) rename docs/{popup.rst => popup.md} (100%) rename docs/{progressbar.rst => progressbar.md} (100%) rename docs/{quickstart.rst => quickstart.md} (100%) rename docs/{render.rst => render.md} (100%) rename docs/{rightpanel.rst => rightpanel.md} (100%) rename docs/{seed.rst => seed.md} (100%) rename docs/{session.rst => session.md} (100%) rename docs/{sticky.rst => sticky.md} (100%) rename docs/{table.rst => table.md} (100%) rename docs/{tablecolumn.rst => tablecolumn.md} (100%) rename docs/{tabs.rst => tabs.md} (100%) rename docs/{template.rst => template.md} (100%) rename docs/{text.rst => text.md} (100%) rename docs/{tree-item-selector.rst => tree-item-selector.md} (100%) rename docs/{type-presentation.rst => type-presentation.md} (100%) rename docs/{view.rst => view.md} (100%) rename docs/{virtualpage.rst => virtualpage.md} (100%) rename docs/{wizard.rst => wizard.md} (100%) diff --git a/README.md b/README.md index 5bd361177e..483ccb850b 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Download from www.agiletoolkit.org or Install ATK UI with `composer require atk4 Create "index.php" file with: -``` php +```php 'hello world']); $app->initLayout([\Atk4\Ui\Layout\Admin::class]); $app->db = \Atk4\Data\Persistence::connect('mysql://user:pass@localhost/atk'); @@ -91,7 +91,7 @@ $app->db = \Atk4\Data\Persistence::connect('mysql://user:pass@localhost/atk'); ATK Data allows you to set up relations between models: -``` php +```php class User extends Model { protected function init(): void @@ -107,7 +107,7 @@ class User extends Model Conventional Crud works only with a single model, but with add-on you can take advantage this relationship information: https://github.com/atk4/mastercrud -``` php +```php use \Atk4\Mastercrud\MasterCrud; // set up $app here @@ -116,7 +116,6 @@ $masterCrud = MasterCrud::addTo($app) ->setModel(new User($app->db), [ 'Purchases' => [], ]); - ``` ### Agile UI can be styled @@ -129,7 +128,7 @@ It's easy to create your own application styling. Here are some example UI: As of version 2.0 - Agile Toolkit offers support for User Actions. Those are easy to define in your Data Model declaration: -``` php +```php $this->addUserAction('archive', function (Model $m) { $m->set('is_archived', true); $this->saveAndUnload(); @@ -147,7 +146,7 @@ Agile UI has some unique features: One of the fundamental features of ATK is Callback - ability to dynamically generate a route then have JS part of the component invoke it. Thanks to this approach, code can be fluid, simple and readable: -``` php +```php $tabs = \Atk4\Ui\Tabs::addTo($app); \Atk4\Ui\Message::addTo($tabs->addTab('Intro'), ['Other tabs are loaded dynamically!']); @@ -176,11 +175,11 @@ Another component implementation using a very friendly PHP syntax: You get most benefit when you use various ATK UI Components together. Try the following demo: https://ui.agiletoolkit.org/demos/interactive/wizard.php. The demo implements: -- Multi-step wizard with ability to navigate forward and backward -- Form with validation -- Data memorization in the session -- Table with column formatter, Messages -- Real-time output console +- Multi-step wizard with ability to navigate forward and backward +- Form with validation +- Data memorization in the session +- Table with column formatter, Messages +- Real-time output console With ATK it [takes about 50 lines of PHP code only](https://github.com/atk4/ui/blob/develop/demos/interactive/wizard.php) to build it all. @@ -188,7 +187,7 @@ With ATK it [takes about 50 lines of PHP code only](https://github.com/atk4/ui/b It's really easy to put together a complex Admin system. Add this code to a new PHP file (tweak it with your database details, table and fields): -``` php +```php /dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DSQL.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DSQL.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/DSQL" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DSQL" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index c8a81185ba..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,19 +0,0 @@ -How to build this documentation - -``` -sudo apt-get install python-sphinx python-setuptools -sudo easy_install pip - -sudo pip install sphinx_rtd_theme -sudo pip install sphinxcontrib-phpdomain - -make html -``` - -next open `html/index.html` in your browser - -``` -open html/index.html -``` - - diff --git a/docs/accordion.rst b/docs/accordion.md similarity index 100% rename from docs/accordion.rst rename to docs/accordion.md diff --git a/docs/advanced.rst b/docs/advanced.md similarity index 100% rename from docs/advanced.rst rename to docs/advanced.md diff --git a/docs/app.rst b/docs/app.md similarity index 100% rename from docs/app.rst rename to docs/app.md diff --git a/docs/autocomplete.rst b/docs/autocomplete.md similarity index 100% rename from docs/autocomplete.rst rename to docs/autocomplete.md diff --git a/docs/breadcrumb.rst b/docs/breadcrumb.md similarity index 100% rename from docs/breadcrumb.rst rename to docs/breadcrumb.md diff --git a/docs/button.rst b/docs/button.md similarity index 100% rename from docs/button.rst rename to docs/button.md diff --git a/docs/callbacks.rst b/docs/callbacks.md similarity index 100% rename from docs/callbacks.rst rename to docs/callbacks.md diff --git a/docs/components.rst b/docs/components.md similarity index 100% rename from docs/components.rst rename to docs/components.md diff --git a/docs/conf.py b/docs/conf.py index 0e217a0e56..8daae9523b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,3 @@ -# -*- coding: utf-8 -*- -# Agile UI documentation build configuration file - import sys import os import sphinx_rtd_theme @@ -11,20 +8,6 @@ lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1) primary_domain = 'php' - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', @@ -33,49 +16,18 @@ 'sphinxcontrib.phpdomain', ] -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +source_suffix = '.md' -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. master_doc = 'index' # General information about the project. project = u'Agile UI' copyright = u'2016-2019, Agile Toolkit' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. version = 'v1.x' -# The full version, including alpha/beta/rc tags. -#release = '0.2.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. exclude_patterns = ['_build'] -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True @@ -98,37 +50,12 @@ # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False - # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'sphinx_rtd_theme' -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". @@ -183,49 +110,6 @@ # Output file base name for HTML help builder. htmlhelp_basename = 'AgileUIDoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -#latex_documents = [ - #('index', 'DSQL.tex', u'DSQL Documentation', - #u'Agile Toolkit', 'manual'), -#] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples @@ -238,7 +122,6 @@ # If true, show URL addresses after external links. #man_show_urls = False - # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples @@ -262,7 +145,6 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False - # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/console.rst b/docs/console.md similarity index 100% rename from docs/console.rst rename to docs/console.md diff --git a/docs/core.rst b/docs/core.md similarity index 100% rename from docs/core.rst rename to docs/core.md diff --git a/docs/crud.rst b/docs/crud.md similarity index 100% rename from docs/crud.rst rename to docs/crud.md diff --git a/docs/data.rst b/docs/data.md similarity index 100% rename from docs/data.rst rename to docs/data.md diff --git a/docs/dataexecutor.rst b/docs/dataexecutor.md similarity index 100% rename from docs/dataexecutor.rst rename to docs/dataexecutor.md diff --git a/docs/filestructure.rst b/docs/filestructure.md similarity index 100% rename from docs/filestructure.rst rename to docs/filestructure.md diff --git a/docs/fileupload.rst b/docs/fileupload.md similarity index 100% rename from docs/fileupload.rst rename to docs/fileupload.md diff --git a/docs/form-control.rst b/docs/form-control.md similarity index 100% rename from docs/form-control.rst rename to docs/form-control.md diff --git a/docs/form.rst b/docs/form.md similarity index 100% rename from docs/form.rst rename to docs/form.md diff --git a/docs/grid.rst b/docs/grid.md similarity index 100% rename from docs/grid.rst rename to docs/grid.md diff --git a/docs/header.rst b/docs/header.md similarity index 100% rename from docs/header.rst rename to docs/header.md diff --git a/docs/helloworld.rst b/docs/helloworld.md similarity index 100% rename from docs/helloworld.rst rename to docs/helloworld.md diff --git a/docs/icon.rst b/docs/icon.md similarity index 100% rename from docs/icon.rst rename to docs/icon.md diff --git a/docs/image.rst b/docs/image.md similarity index 100% rename from docs/image.rst rename to docs/image.md diff --git a/docs/index.rst b/docs/index.md similarity index 100% rename from docs/index.rst rename to docs/index.md diff --git a/docs/js.rst b/docs/js.md similarity index 100% rename from docs/js.rst rename to docs/js.md diff --git a/docs/label.rst b/docs/label.md similarity index 100% rename from docs/label.rst rename to docs/label.md diff --git a/docs/lister.rst b/docs/lister.md similarity index 100% rename from docs/lister.rst rename to docs/lister.md diff --git a/docs/loremipsum.rst b/docs/loremipsum.md similarity index 100% rename from docs/loremipsum.rst rename to docs/loremipsum.md diff --git a/docs/menu.rst b/docs/menu.md similarity index 100% rename from docs/menu.rst rename to docs/menu.md diff --git a/docs/message.rst b/docs/message.md similarity index 100% rename from docs/message.rst rename to docs/message.md diff --git a/docs/misc.rst b/docs/misc.md similarity index 100% rename from docs/misc.rst rename to docs/misc.md diff --git a/docs/multiline.rst b/docs/multiline.md similarity index 100% rename from docs/multiline.rst rename to docs/multiline.md diff --git a/docs/overview.rst b/docs/overview.md similarity index 100% rename from docs/overview.rst rename to docs/overview.md diff --git a/docs/paginator.rst b/docs/paginator.md similarity index 100% rename from docs/paginator.rst rename to docs/paginator.md diff --git a/docs/popup.rst b/docs/popup.md similarity index 100% rename from docs/popup.rst rename to docs/popup.md diff --git a/docs/progressbar.rst b/docs/progressbar.md similarity index 100% rename from docs/progressbar.rst rename to docs/progressbar.md diff --git a/docs/quickstart.rst b/docs/quickstart.md similarity index 100% rename from docs/quickstart.rst rename to docs/quickstart.md diff --git a/docs/render.rst b/docs/render.md similarity index 100% rename from docs/render.rst rename to docs/render.md diff --git a/docs/requirements.txt b/docs/requirements.txt index da80ee1204..6c83ae59fa 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,4 @@ -sphinx<1.7 -sphinxcontrib-phpdomain==0.1.4 +sphinx<5 +sphinx-rtd-theme +sphinxcontrib-phpdomain<=0.9 +jinja2<3.1 diff --git a/docs/rightpanel.rst b/docs/rightpanel.md similarity index 100% rename from docs/rightpanel.rst rename to docs/rightpanel.md diff --git a/docs/seed.rst b/docs/seed.md similarity index 100% rename from docs/seed.rst rename to docs/seed.md diff --git a/docs/session.rst b/docs/session.md similarity index 100% rename from docs/session.rst rename to docs/session.md diff --git a/docs/sticky.rst b/docs/sticky.md similarity index 100% rename from docs/sticky.rst rename to docs/sticky.md diff --git a/docs/table.rst b/docs/table.md similarity index 100% rename from docs/table.rst rename to docs/table.md diff --git a/docs/tablecolumn.rst b/docs/tablecolumn.md similarity index 100% rename from docs/tablecolumn.rst rename to docs/tablecolumn.md diff --git a/docs/tabs.rst b/docs/tabs.md similarity index 100% rename from docs/tabs.rst rename to docs/tabs.md diff --git a/docs/template.rst b/docs/template.md similarity index 100% rename from docs/template.rst rename to docs/template.md diff --git a/docs/text.rst b/docs/text.md similarity index 100% rename from docs/text.rst rename to docs/text.md diff --git a/docs/tree-item-selector.rst b/docs/tree-item-selector.md similarity index 100% rename from docs/tree-item-selector.rst rename to docs/tree-item-selector.md diff --git a/docs/type-presentation.rst b/docs/type-presentation.md similarity index 100% rename from docs/type-presentation.rst rename to docs/type-presentation.md diff --git a/docs/view.rst b/docs/view.md similarity index 100% rename from docs/view.rst rename to docs/view.md diff --git a/docs/virtualpage.rst b/docs/virtualpage.md similarity index 100% rename from docs/virtualpage.rst rename to docs/virtualpage.md diff --git a/docs/wizard.rst b/docs/wizard.md similarity index 100% rename from docs/wizard.rst rename to docs/wizard.md diff --git a/js/README.md b/js/README.md index 5e426a53e4..a82de01257 100644 --- a/js/README.md +++ b/js/README.md @@ -14,23 +14,22 @@ For example, if one of your script need to send an ajax request directly, withou to run and evaluate the server response from Atk4\Ui. ``` - $.getJSON("myajax.php", function (resp) { - atk.apiService.atkProcessExternalResponse(resp); - }); - +$.getJSON("myajax.php", function (resp) { + atk.apiService.atkProcessExternalResponse(resp); +}); ``` Another example would be the upload service for file uploading using one of your script. ``` - atk.uploadService.uploadFiles( - files, - elem, - { data: 'value' }, - url, - onComplete() {}, // the callback function when upload is complete. - onXhr() {} // the callback function when uploading files is in progress. - ); +atk.uploadService.uploadFiles( + files, + elem, + { data: 'value' }, + url, + onComplete() {}, // the callback function when upload is complete. + onXhr() {} // the callback function when uploading files is in progress. +); ``` ### jQuery plugin @@ -40,16 +39,16 @@ The atk global object may be used as a quick way of registering a jQuery plugin Let's create a new jQuery plugin that will change every selected dom element text color to green. ``` - atk.registerPlugin('greenify', function (el) { - $(el).css("color", "green"); - }) +atk.registerPlugin('greenify', function (el) { + $(el).css("color", "green"); +}); ``` The plugin can now by invoke using: ``` - // Change all link color text to green. - $('a').greenify(); +// Change all link color text to green. +$('a').greenify(); ``` ## Developing and building package. @@ -61,8 +60,8 @@ You may change this package to suit your own needs. First start by installing the package using npm install. ``` - cd atk4/ui/js - npm install +cd atk4/ui/js +npm install ``` ### Development @@ -70,7 +69,7 @@ First start by installing the package using npm install. For development and debugging, simply use the "dev" script supply in package.json file by running this command: ``` - npm run dev +npm run dev ``` This command will output the atkjs-ui.js file inside the ../public/js directory including the .map file need for debugging @@ -84,7 +83,7 @@ Bundle profile may be analyze using various tools. npm script are available for the JSON file for this. ``` - npm run profile +npm run profile ``` This command will create a profile JSON file `atkjs-bundle-profile.json` with bundle information inside the profile folder. You can use this file with your @@ -93,14 +92,14 @@ favorite bundle analyzer. Another npm script is available for analyzing the bundle using the webpack-bundle-analyzer tool. ``` - npm run analyze-profile +npm run analyze-profile ``` Note: In order to use this script, make sure that the webpack-bundle-analyzer package is install globally. ``` - npm install -g webpack-bundle-analyzer +npm install -g webpack-bundle-analyzer ``` ### Production @@ -108,7 +107,7 @@ globally. For production, simply use the "build" script supply in package.json. ``` - npm run build +npm run build ``` This command will output the atkjs-ui.min.js file in ../public/js directory.