Thread: Documentation improvement suggestions

Documentation improvement suggestions

From
Tilo Schwarz
Date:
Hi,

yesterday I made my first schema :-) following the instruction in
sql-createschema.html (all PostgreSQL 7.3.1 Documentation). Then I wanted to
create some objects in my new schema, but I coudn't find a hint how to make
my new schema "active". It sais, that:

[...]
Named objects are accessed either by "qualifying" their names with the schema
name as a prefix, or by setting a search path that includes the desired
schema(s).
[...]

but I had to go to sql-createtable.html and from there to functions-misc.html
until I got it...

So I suggest adding a sentence like:

If you want to create new objects in the created schema without "qualifying"
their names, you have to make the schema the current schema (the one at the
front of the search path; see CURRENT_SCHEMA()).

Second suggestion:

I would love an additional "up" button in the header of the HTML docs. If I am
at some leaf in the "documentation tree" (e.g. via a link) and want to go up
more than once, I have to do:

- press <end> key to move down the page
- klick "up"
- press <end> key to move down the page
- klick "up"
...

because the browsers show the top of the page after pressing "up".

Regards,

    Tilo


Re: Documentation improvement suggestions

From
Bruce Momjian
Date:
OK, docs improved.  This will appear in 7.3.X and 7.4.

---------------------------------------------------------------------------

Tilo Schwarz wrote:
> Hi,
>
> yesterday I made my first schema :-) following the instruction in
> sql-createschema.html (all PostgreSQL 7.3.1 Documentation). Then I wanted to
> create some objects in my new schema, but I coudn't find a hint how to make
> my new schema "active". It sais, that:
>
> [...]
> Named objects are accessed either by "qualifying" their names with the schema
> name as a prefix, or by setting a search path that includes the desired
> schema(s).
> [...]
>
> but I had to go to sql-createtable.html and from there to functions-misc.html
> until I got it...
>
> So I suggest adding a sentence like:
>
> If you want to create new objects in the created schema without "qualifying"
> their names, you have to make the schema the current schema (the one at the
> front of the search path; see CURRENT_SCHEMA()).
>
> Second suggestion:
>
> I would love an additional "up" button in the header of the HTML docs. If I am
> at some leaf in the "documentation tree" (e.g. via a link) and want to go up
> more than once, I have to do:
>
> - press <end> key to move down the page
> - klick "up"
> - press <end> key to move down the page
> - klick "up"
> ...
>
> because the browsers show the top of the page after pressing "up".
>
> Regards,
>
>     Tilo
>
>
> ---------------------------(end of broadcast)---------------------------
> TIP 2: you can get off all lists at once with the unregister command
>     (send "unregister YourEmailAddressHere" to majordomo@postgresql.org)
>

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
Index: doc/src/sgml/ref/create_schema.sgml
===================================================================
RCS file: /cvsroot/pgsql-server/doc/src/sgml/ref/create_schema.sgml,v
retrieving revision 1.3
diff -c -c -r1.3 create_schema.sgml
*** doc/src/sgml/ref/create_schema.sgml    21 Sep 2002 18:32:54 -0000    1.3
--- doc/src/sgml/ref/create_schema.sgml    3 Feb 2003 15:55:59 -0000
***************
*** 115,121 ****
     whose names may duplicate those of other objects existing in other
     schemas.  Named objects are accessed either by <quote>qualifying</>
     their names with the schema name as a prefix, or by setting a search
!    path that includes the desired schema(s).
    </para>

    <para>
--- 115,123 ----
     whose names may duplicate those of other objects existing in other
     schemas.  Named objects are accessed either by <quote>qualifying</>
     their names with the schema name as a prefix, or by setting a search
!    path that includes the desired schema(s).  Unqualified objects are
!    created in the current schema (the one at the front of the search path;
!    see <literal>CURRENT_SCHEMA()</>).
    </para>

    <para>