Skip to content

Commit dd83c6b

Browse files
committed
Added complete reference
1 parent c29b458 commit dd83c6b

File tree

5 files changed

+4188
-10
lines changed

5 files changed

+4188
-10
lines changed

phpcr-shell/configuration.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Configuration
44
Initialization and reloading
55
----------------------------
66

7-
The configuration files can be initialized and reloaded at any time using:
7+
The configuration files can be initialized and reloaded at any time using the
8+
:ref:`phpcr_shell_command_shellconfiginit` and :ref:`phpcr_shell_command_shellconfigreload`
9+
commands:
810

911
.. code-block:: bash
1012
@@ -24,6 +26,19 @@ PHPCRSH supports aliases. Aliases are shortcuts for commands.
2426
Aliases are stored in the file ``$HOME/.phpcrsh/aliases.yml``, which is created
2527
automatically when launching the PHPCR Shell.
2628

29+
You can list the current aliases with the :ref:`phpcr_shell_command_shellaliaslist` command.
30+
31+
For example:
32+
33+
.. code-block:: bash
34+
35+
PHPCRSH> ls
36+
PHPCRSH> pwd
37+
PHPCRSH> refresh
38+
PHPCRSH> save
39+
40+
Are all examples of aliases.
41+
2742
Below is the distribution version of this file at time of writing:
2843

2944
.. code-block:: yaml

phpcr-shell/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ PHPCR-Shell
88
connecting
99
interacting
1010
configuration
11+
reference

phpcr-shell/installation.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ You can now run PHPCRSH from anywhere:
3131
Install as an embedded application
3232
----------------------------------
3333

34-
If you are using a Symfony2 application and the `DoctrinePHPCRBundle <https://github.com/doctrine/DoctrinePHPCRBundle/>`_
35-
then you can easily integrate the PHPCR-Shell.
34+
If you are using a Symfony2 application and a version of `DoctrinePHPCRBundle
35+
<https://github.com/doctrine/DoctrinePHPCRBundle/>`_ greater than 1.2 then you
36+
can easily integrate the PHPCR-Shell.
3637

3738
Simply add the shell to your ``composer.json`` file
3839

phpcr-shell/interacting.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,14 @@ both navigate the content hierarchy and execute queries.
1010
commands, for example "ls" instead of "node:list", "rm" instead of "node:remove" etc.
1111
See the chapter on :ref:`phpcrsh_configuration_aliases` for more information.
1212

13+
This chapter aims to highlight some but not all of the features of the shell. For a full
14+
list of features use the ``list`` command.
15+
1316
The current path
1417
----------------
1518

16-
You can navigate the content heriarchy using the `shell:path:change` (or `cd` for short). The
17-
`pwd` command is the alias for `shell:path:show` and displays the current working path:
19+
You can navigate the content heriarchy using the :ref:`phpcr_shell_command_shellpathchange` (or `cd` for short). The
20+
`pwd` command is the alias for :ref:`phpcr_shell_command_shellpathshow` and displays the current working path:
1821

1922
.. code-block:: bash
2023
@@ -27,7 +30,7 @@ You can navigate the content heriarchy using the `shell:path:change` (or `cd` fo
2730
Listing node contents
2831
---------------------
2932

30-
You can list the contents of a node with the `node:list` command (or `ls`):
33+
You can list the contents of a node with the :ref:`phpcr_shell_command_nodelist` command (or `ls`):
3134

3235
.. code-block:: bash
3336
@@ -135,16 +138,16 @@ Saving and refreshing the session
135138
---------------------------------
136139

137140
Changes made to nodes in the session are not persisted immediately (with the exception
138-
of ``node:copy`` which is a workspace command).
141+
of :ref:`phpcr_shell_command_nodecopy` which is a workspace command).
139142

140-
To persist changes to the repository you must call ``session:save`` (or ``save``).
143+
To persist changes to the repository you must call :ref:`phpcr_shell_command_sessionsave` (or ``save``).
141144

142-
You can also refresh (or reset) the session by calling ``session:refresh`` (or ``refresh``).
145+
You can also refresh (or reset) the session by calling :ref:`phpcr_shell_command_sessionrefresh` (or ``refresh``).
143146

144147
Queries
145148
-------
146149

147-
PHPCRSH supports the powerfull JCR-SQL2 query language:
150+
PHPCRSH supports the JCR-SQL2 query language:
148151

149152
.. code-block:: bash
150153

0 commit comments

Comments
 (0)