diff --git a/user_manual/android_app.rst b/user_manual/android_app.rst new file mode 100644 index 0000000000..de2b2d57b6 --- /dev/null +++ b/user_manual/android_app.rst @@ -0,0 +1,115 @@ +============================== +Using the ownCloud Android App +============================== + +Accessing your files on your ownCloud server via the Web interface is easy and +convenient, as you can use any Web browser on any operating system without +installing special client software. However, the ownCloud Android app offers +some advantages over the Web interface: + +* A simplified interface that fits nicely on a tablet or smartphone +* Automatic synchronization of your files +* Instant uploads of photos or videos recorded on your Android device +* Easily add files from your device to ownCloud +* Two-factor authentication + +Getting the ownCloud Android App +-------------------------------- + +One way to get your ownCloud Android app is to log into your ownCloud server +from your Android device using a Web browser such as Chrome, Firefox, or +Dolphin. The first time you log in to a new ownCloud account you'll see a screen +with a download link to the ownCloud app in the `Google Play store +`_. + +.. figure:: images/android-first-screen.jpg + +You will also find these links on your Personal page in the Web interface, + +You can also get it from the `Amazon App store +`_, and get source code and +more information from the `ownCloud download page +`_. + +Connecting to Your ownCloud Server +---------------------------------- + +The first time you run your ownCloud Android app it opens to a configuration +screen. Enter your server URL, login name, password, and click the Connect +button. (Click the eyeball to the right of your password to expose your +password.) + +.. figure:: images/android-new-account.png + +For best security your ownCloud server should be SSL-enabled, so that you can +connect via ``https``. The ownCloud app will test your connection as soon as +you enter it and tell you if you entered it correctly. If your server has a +self-signed SSL certificate you'll get a scary warning how it is not to be +trusted. Click the OK button to accept the certificate and complete your account +setup. + +.. figure:: images/android-ssl-cert.png + +Managing Files +-------------- + +Now you should see the Files page of your ownCloud account. Click the overflow +button at the top right (that's the one with three vertical dots, and that is +really what it is called) to open a user menu. ``Refresh account`` refreshes the +page view. ``Settings`` take you to your settings menu. ``Sort`` gives you the +option to sort your files by date, or alphabetically. + +.. figure:: images/android-files-page.png + +The little file folder icon to the left of the overflow button opens a dialog to +create a new folder. The arrow button opens a file upload dialog, and you can +either upload content from other Android apps such as Google Drive, the Gallery, +your music player, or from your Android filesystem. When you add a new file +you will see a confirmation on the top left when it has uploaded successfully, +and it is immediately synchronized with the server. + +.. figure:: images/android-upload.png + +All files (that you have permission to access) on your ownCloud server are +displayed in your Android app, but are not downloaded until you download them. +Downloaded files are marked with a green arrow. + +.. figure:: images/android-file-list.png + +Download and preview a file with a short press on the filename. When the file +is in preview mode, a short press on the overflow button opens a menu with +options for sharing, opening with an app, removing, sending, and displaying file +details. + +.. figure:: images/android-file.png + + +A long press on the filename does not download it, but opens a dialog with +options for sharing, downloading, renaming, moving, removing, sending, and +viewing file details. + + +.. figure:: images/android-file-options.png + + +Settings +-------- + +The Settings screen offers a number of useful options. In the Accounts +section you can configure multiple ownCloud accounts. + +The Security section sets up strong two-factor authentication by allowing you +to add a PIN (personal identification number) to access your account. + +The Instant Uploads section creates a directory, :file:`/InstantUpload`, and +any photos or videos created with your Android device's camera are instantly +uploaded to this directory. You also have the option to choose any other +existing directory. Another nice option is Upload Pictures/Video via WiFi Only, +to conserve your Internet data usage. + +.. figure:: images/android-settings.png + +The bottom section of the Settings screen has links to help and the +app's version number. + +.. figure:: images/android-help.png diff --git a/user_manual/conf.py b/user_manual/conf.py new file mode 100644 index 0000000000..b9c571143b --- /dev/null +++ b/user_manual/conf.py @@ -0,0 +1,294 @@ +# -*- coding: utf-8 -*- +# +# ownCloud Documentation documentation build configuration file, created by +# sphinx-quickstart on Mon Oct 22 23:16:40 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os, inspect + +# 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('.')) + +#path to this script +scriptpath = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe()))) + +# -- 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.todo'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = [scriptpath+'/ocdoc/_shared_assets/templates'] + +# 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'ownCloud Android App Manual' +copyright = u'2013-2015, The ownCloud developers' + +# 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 = '@VERSION_MAJOR@.@VERSION_MINOR@' +# The full version, including alpha/beta/rc tags. +release = '@VERSION@' + +# 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','scripts/*'] + +# 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 +2 +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# 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 = [scriptpath+'/ocdoc/_shared_assets/themes'] + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +#html_theme = 'bootstrap' +html_theme = 'default' +# 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 = "Android App Manual" + +# 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". +html_static_path = [scriptpath+'/ocdoc/_shared_assets/static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ownCloudAndroidAppManual' + + +# -- 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]). +latex_documents = [ + ('index', 'ownCloudAndroidAppManual.tex', u'ownCloud Android App Manual', + u'The ownCloud developers', '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 +# (source start file, name, description, authors, manual section). +man_pages = [ + ('owncloud.1', 'owncloud', u'Android synchronisation and file management +utility.', + [u'The ownCloud developers'], 1), + ('owncloudcmd.1', 'owncloudcmd', u'ownCloud Android app.', + [u'The ownCloud developers'], 1), +] + +# If true, show URL addresses after external links. +man_show_urls = True + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'ownCloudClientManual', u'ownCloud Android App Manual', + u'The ownCloud developers', 'ownCloud', 'The ownCloud Android App Manual.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'ownCloud Android App Manual' +epub_author = u'The ownCloud developers' +epub_publisher = u'The ownCloud developers' +epub_copyright = u'2013-2015, The ownCloud developers' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + +# Include todos? +todo_include_todos = True diff --git a/user_manual/images/android-downloads.png b/user_manual/images/android-downloads.png new file mode 100644 index 0000000000..e0bb545487 Binary files /dev/null and b/user_manual/images/android-downloads.png differ diff --git a/user_manual/images/android-file-list.png b/user_manual/images/android-file-list.png new file mode 100644 index 0000000000..e479b9f0df Binary files /dev/null and b/user_manual/images/android-file-list.png differ diff --git a/user_manual/images/android-file-options.png b/user_manual/images/android-file-options.png new file mode 100644 index 0000000000..12867a316c Binary files /dev/null and b/user_manual/images/android-file-options.png differ diff --git a/user_manual/images/android-file.png b/user_manual/images/android-file.png new file mode 100644 index 0000000000..89ffd28bfc Binary files /dev/null and b/user_manual/images/android-file.png differ diff --git a/user_manual/images/android-files-page.png b/user_manual/images/android-files-page.png new file mode 100644 index 0000000000..1c7fc4ddad Binary files /dev/null and b/user_manual/images/android-files-page.png differ diff --git a/user_manual/images/android-first-screen.jpg b/user_manual/images/android-first-screen.jpg new file mode 100644 index 0000000000..f4c5132ad9 Binary files /dev/null and b/user_manual/images/android-first-screen.jpg differ diff --git a/user_manual/images/android-help.png b/user_manual/images/android-help.png new file mode 100644 index 0000000000..56a7464f5f Binary files /dev/null and b/user_manual/images/android-help.png differ diff --git a/user_manual/images/android-new-account.png b/user_manual/images/android-new-account.png new file mode 100644 index 0000000000..ffbe12e594 Binary files /dev/null and b/user_manual/images/android-new-account.png differ diff --git a/user_manual/images/android-settings.png b/user_manual/images/android-settings.png new file mode 100644 index 0000000000..7a160845bb Binary files /dev/null and b/user_manual/images/android-settings.png differ diff --git a/user_manual/images/android-ssl-cert.png b/user_manual/images/android-ssl-cert.png new file mode 100644 index 0000000000..9286fe6278 Binary files /dev/null and b/user_manual/images/android-ssl-cert.png differ diff --git a/user_manual/images/android-upload.png b/user_manual/images/android-upload.png new file mode 100644 index 0000000000..6ee1b95201 Binary files /dev/null and b/user_manual/images/android-upload.png differ diff --git a/user_manual/index.rst b/user_manual/index.rst new file mode 100644 index 0000000000..cf15912511 --- /dev/null +++ b/user_manual/index.rst @@ -0,0 +1,9 @@ +.. _contents: + +ownCloud Android App Manual +============================== + +.. toctree:: + :maxdepth: 2 + + android_app diff --git a/user_manual/make.bat b/user_manual/make.bat new file mode 100644 index 0000000000..3fbb57f5d6 --- /dev/null +++ b/user_manual/make.bat @@ -0,0 +1,199 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :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. pdf to make a PDF file with rst2pdf + 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. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pdf" ( + %SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The PDF file is in %BUILDDIR%/pdf. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\OwncloudDocumentation.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\OwncloudDocumentation.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end