COMPANY

BLOGS

  • user warning: Unknown column 'u.signature_format' in 'field list' query: SELECT c.cid as cid, c.pid, c.nid, c.subject, c.comment, c.format, c.timestamp, c.name, c.mail, c.homepage, u.uid, u.name AS registered_name, u.signature, u.signature_format, u.picture, u.data, c.thread, c.status FROM comments c INNER JOIN users u ON c.uid = u.uid WHERE c.nid = 13679 AND c.status = 0 ORDER BY c.cid LIMIT 0, 50 in /var/www/www.4d.com/docs/modules/comment/comment.module on line 991.
  • warning: file_get_contents(http://www.telize.com/geoip/23.22.136.56) [function.file-get-contents]: failed to open stream: HTTP request failed! HTTP/1.1 404 Not Found in /var/www/www.4d.com/docs/includes/common.inc(1762) : eval()'d code on line 4.

Your own personal doc

13.04.2010
by Doc Team
tabs

4D Doc Center is constantly changing so as to better meet the needs of 4D developers.  Already, several new functions are available so that you can customize page display and access to information: you can choose the number of columns displayed, the display of the syntax, the text contrast and you can add your own tags. However, in order to take advantage of all these functions, you will first need to identify yourself.

 

 

First step: logging in

You need to be logged in for the documentation system to be able to store your preferences. To connect to the system, just click on "Log in" at the top right corner of the Web page. Then enter your e-mail address and password on the identification page. If you already have an account with 4D, you can just use your usual identifying information. 
Once you have logged in, your user name is displayed at the top right of the page.

 


Custom functions are shown as buttons and additional icons displayed at the bottom of the page. Any settings that you make in 4D Doc Center will be applied whenever you log in with your account, regardless of the machine you use.

 

Make yourself at home

Viewing the table of contents for a large manual can be tedious at times. Getting to the part that concerns you can sometimes require excessive scrolling. Similarly, you may want to modify the display order for certain information so that items that you use the most often appear at the top of the list.

To address these issues, you can customize the display of home pages.  You just need to go to the home page of a manual and click on the Page settings button.

A dialog box appears so that you can set several different types of parameters.
 

 

  • Number of columns: Depending on the size of your workspace, you can choose to display either one, two, three, four or five columns. This makes it possible to see all the chapters of the manual at once.

 

  • Position of list (what’s new, alphabetical): If you use these lists on a regular basis, you may want to place them at the top of the home page for easier access.

 

  • Reading direction: When the page is displayed in columns, the reading direction of the columns can be vertical (from top to bottom then left to right) or horizontal (from left to right then top to bottom). You can choose the one that seems the most natural to you.
 
These settings will apply to all the manuals of 4D Doc Center.
 

Syntax, as you like it

What is the best way to display the command syntax, by parameter name or type? Well, that depends on who you ask. 4D Doc Center lets you configure the display of the command list for a theme so you can display the information that you consider to be the most pertinent. You just click on the Page settings button for the command theme page. A dialog box appears so you can choose the information to be displayed for each command:
- Do not display syntax (default option)
- Display parameter names
- Display parameter types
- Display command numbers
This setting will be applied to all the manuals of 4D Doc Center.
 

 

For some, the darker, the better

4D Doc Center uses a style sheet common to all the 4D sites. This CSS sets the text color as gray by default. Some people may find this a little too light for their tastes so we’ve made it possible to change the text contrast  for 4D Doc Center. Just go to any command page and click on the Page settings button. A dialog box will appear so that you can choose the text color:
- Standard: gray (default)      
- Darker: darker gray
- Black: 100% black
 
 
This setting will be applied to all the manuals of 4D Doc Center.
 

Tag your own way

Finding the information you’re looking for when there are thousands of different pages isn’t always easy. Using tags can be a real help since they allow you to browse according to concepts without having to stick to the original organization of the documentation.  Of course, it’s also a question of how relevant the tags are.
From the start, 4D Doc Center has provided a set of predefined tags that are enhanced on a regular basis. Clicking on a tag in an article will display a list of all the articles that have the same tag associated with them. You can also carry out a search by tags by entering “kw:tagname” or “tag:tagname” in the search area.

But now you can go even further: you can set your own tags at any time and associate them with any page.  This way, you can use tags according to your own logic and your own personal criteria. For example, you might want to associate a tag such as “check back later” for certain commands. To add a tag, you just click on the button on the page concerned and enter the tag in the dialog box that appears. 

Once created, the custom tag appears in the "Tags" area of the page, along with any other tags that may have been specified. You can also access the contextual list of your tags by clicking on the button, which indicates the presence of custom tags. A window appears listing all your tags and providing links to the articles with which they have been associated.

 

RSS 0 comment(s) to this post