Opened 13 years ago

Closed 12 years ago

#261 closed proposed feature (fixed)

Singular Manual -- remarks from participants of mini-workshop on Aug 31 2010 (Hannover)

Reported by: anne@… Owned by: somebody
Priority: minor Milestone: 3-1-2 and higher
Component: doc Version: 3-1-1
Keywords: Cc:

Description

The following points turned out to be confusing for novice users and were stated as feedback to the developers after the session:

1) documentation of type list does not state an example of how to access a list

entry (e.g. L[3]) or a sublist (e.g. L[2..4]). This should be included under the main topic list or under list operations.

2) Groebner Bases: the first entry in the index leads to decodeGB, here the

keyword should be changed to 'Groebner Bases, decodeGB' to allow the appendix section A.2 to appear as the first entry.

3) documentation of commands like dim which rely on input to be a standard bases:

an explanation of the warning 'is not a standard basis' and/or the possible consequences should be stated either as a separate WARNING or explained by means of an example

4) it was hard for many of the participants to find the right normalization

command due to the high number of entries with similar names in the index (in particular 'normaliz' and 'normalI').

5) several participants did not realize that the grey bar at the top of the main

web page was not just there as information, but also contained links. They looked for a link to the manual in the menu on the right hand side. I am not sure why this happened, but this occured to at least 7 or 8 of participants.

Change History (2)

comment:1 Changed 13 years ago by gorzel

Zu 1)

In http://www.singular.uni-kl.de/Manual/latest/sing_109.htm#SEC150 wird doch folgendes Beispiel gegeben:

    4.8.1 list declarations 
   
      list l=1,"str";
      l[1];
    ==> 1
      l[2];
    ==> str
      ring r;

Jedoch ist etwas wie L[2..4] keine sublist d.h. nicht vom Typ list. So etwas wird zwar im Handbuch im Texe als "list" bezeichnet, man sollte hier aber besser von "sequence of objects" sprechen.

Bsp.:

> list L= 1,"abc",2,3,4,5,6;
> L[2..4];    // this is not a list   
abc 2 3
> typeof(_);  // the type of the first object
string
> list sublist = L[2..4];   // assignment to a list
> sublist;
[1]:
   abc
[2]:
   2
[3]:
   3
> string s;
> int i,j;
> s,i,j= L[2..4];    // but the sequence can also be assigned to single objects
> s,i,j;
abc 2 3

zu 3.)

See attrib: http://www.singular.uni-kl.de/Manual/latest/sing_167.htm#SEC208

Koennte in 6.4 Miscellaneous oddities

http://www.singular.uni-kl.de/Manual/latest/sing_356.htm#SEC397

erklaert werden.

maxideal(n); jedoch sollte automatisch attrib selber gesetzt haben. Die Beispiele bei attrib waeren dahin zu aendern, dass man per Hand setzt:

> ring r=0,(x,y,z),dp;
> ideal I = x,y,z;   
> vdim(I);

Hier weiss Singular wirklich noch nicht, dass I eine std-basis ist.

5) Den Zugang zum online-manual finde auch ich unubersichtlich.

Vormals war auf der linken Seite eine Schaltflaeche und man kam direkt zur Tietelseite des Handbuchs ganz im Browser dargestellt.

Nun erreicht man bei Online Manual eine naechste Seite auf der drei graue Schlatflaächen sind, wobei das eigentliche Handbuch unter "Frontpage" zu finden ist. Dies erscheint dann klein, da links noch die Links sind. Das ist ueberfluessig, da man jederzeot duch einen Klick auf das Logo wieder zurueckgelangt.

Es verhaelt sich halt nicht so wie man mit dem Handbuch aus singular-share.tar gewohnt ist.

Vgl. Oben gibt es eine Schlatflaeche "Books" und links eine Schaltfläche "Publications".

Auch nicht sehr uebersichlich, zuviel geklicke: bei "Books" steht unten ein weiterer Link auf die anderen Artikel.

Einfach die Seite weiter fuehren, so dass man runter scrollen kann, und die Grafiken der beiden Bücher direkt einbauen.

comment:2 Changed 12 years ago by seelisch

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.