Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space EXPORT and version 2.0
Sv translation
languageen

Teamstudio Export can generate a static HTML site from an archive. By default, the HTML site displays all of the non-hidden views in the original application, and all of the fields found on the exported documents.  Some Notes applications contain a significant number of views and fields that are used by application logic.  Often, these views and fields do not provide useful information to the end user and impede the end user's ability to locate relevant information.

Teamstudio Export supports configuration settings within the exported HTML site that can be used to:

  • control which views are displayed
  • control which fields are displayed, including the order of display, and optionally provide field labels

 

Info
titleThe config.js file

Configuration settings for an HTML site are located inside the site's HTML folder (the .tse folder), at config/config.js. Documentation for configuring view and field display, along with examples can be found in the default config.js file generated when a site is created

The configuration file

The configuration file (config.js) is essentially a JavaScript / JSON configuration file, similar to properties files used by many modern web technologies.  To allow an HTML site to be self-contained and browsed locally without the use of a web server, the JavaScript object that represents the configuration properties is registered with the application by passing it to a function ('tmsData') that is called when config.js is loaded by the browser.  The default config.js file contains comments documenting this function, along with example settings that can be uncommented and modified as appropriate.

A basic understanding of JavaScript syntax and JSON is helpful when editing this file.

Note that the web application must be reloaded in the browser for changes to the config.js file to take effect.

Filtering views

The configuration allows control of which views are displayed by:

  • explicitly listing the views to display
  • providing a JavaScript function that accepts an array of available view names and returns an array of views to show
  • disabling the default hiding of views that start with '('  

Note: Views that start with '(' are filtered by default in Export 2.0 and later.


Code Block
languagejs
titleA simple config.js filtering views
window.tmsData('config.js', { 
   views: { filter: [ 'all', 'by date', 'by author'] }
});


See the default config.js file for detailed examples of view filters.

Filtering fields

The configuration allows control of which fields are displayed for a particular form by:

  • explicitly listing the fields to display, in display order
  • explicitly listing fields to display along with the labels to display for the fields
  • providing a JavaScript function that accepts an array of field names and returns an array of fields to show in one of the above formats

 

Code Block
languagejs
titleA simple config.js filtering fields
window.tmsData('config.js', { 
   	forms: 	
		{
		'Main Topic':
  			{
    			'fields': [
      				{name: 'Created', label: 'Date of publication'},
      				{name: 'Subject', label: 'Topic'}
    			]
  			}
		}
});

 

See the default config.js file for detailed examples of field filters.

Temporarily disabling filtering in the UI

To aid in developing view and field filters, the filters on both the main list of views and on a document can be toggled off and on by Shift-Double-Clicking the main Export header bar.  This feature can be helpful to see the full list of fields available when modifying filters, without needing to save the config.js and reload the application.

 

 

 

 

 

Sv translation
languageja

Teamstudio Exportはアーカイブから静的なHTMLサイトを生成することを可能にしています。デフォルトでは、HTMLサイトはオリジナルアプリケーションの全ての非表示でないビューとエクスポートされた文書にある全てのフィールドを表示します。いくつかのNotesアプリケーションには、アプリケーション ロジックで使用される多数のビューとフィールドが含まれています。時折これらのビューおよびフィールドは、エンドユーザーに有用な情報を提供せず、さらには関連情報を見つけることを妨げてしまいます。

Teamstudio ExportはエクスポートされたHTMLサイトに対して以下の設定をサポートしています:

  • どのビューが表示されるかを制御する
  • どのフィールドが表示されているか、表示の順番などを制御し、オプションでフィールドラベルを設定する

 

Info
titleThe config.js file

HTMLサイトの設定は、サイトのHTMLフォルダ(.tseフォルダ)atconfig/config.js内にあります。ビューとフィールドを表示させるためのドキュメンテーションとサンプルは、サイトの作成時に生成されるデフォルトのconfig.jsにあります。

設定ファイル

設定ファイル(config.js)は本質的には、多くの最新のWeb技術で使用されているプロパティファイルと似た形式でJavaScript/JSONによる設定ファイルになります。Webサーバーを使用せずにHTMLサイトを自前でブラウズができるようにするために、設定プロパティを表すJavaScriptオブジェクトは、config.jsが読み込まれる時に呼ばれる関数(“tmsData”)を通すことでアプリケーションに登録されます。デフォルトのconfig,jsファイルには、この関数について記述した説明とコメントを外して利用できるコードの設定例が含まれています。

JavaScriptに関する構文とJSONの基本的な理解はこのファイルを編集する際に役立ちます。

Config.jsファイルの変更を有効にするには、Webアプリケーションをブラウザに再ロードする必要があります。

ビューのフィルタリング

この設定は、どのビューを表示するかを制御することができます:

  • 明示的に表示するビューの指定
  • 使用可能なビュー名の配列を受け取り、表示するビューの配列を返すJavaScript関数の提供
  • ()で始まるビューのデフォルトの非表示を無効化

注意: 「(」で始まるビューのフィルタリングは、エクスポート2.0以降の標準機能です。

 

Code Block
languagejs
titleA simple config.js filtering views
window.tmsData('config.js', { 
   views: { filter: [ 'all', 'by date', 'by author'] }
});


ビューのフィルタリングの詳細な例については、標準のconfig.jsファイルを参照してください。

フィールドのフィルタリング

この設定では、特定のフォームに対してどのフィールドを表示するか制御することができます:

  • 明示的に順番通りに表示するフィールドの指定

  • フィールドに表示するラベルと共に、表示するフィールドを明示的に一覧表示する

  • フィールド名の配列を受け取り、上記のいずれかの形式で表示するフィールドの配列を返すJavaScript関数の提供

 

Code Block
languagejs
titleA simple config.js filtering fields
window.tmsData('config.js', { 
   	forms: 	
		{
		'Main Topic':
  			{
    			'fields': [
      				{name: 'Created', label: 'Date of publication'},
      				{name: 'Subject', label: 'Topic'}
    			]
  			}
		}
});

 

フィールドのフィルタリングの詳細な例については、標準のconfig.jsファイルを参照してください。

UIでのフィルタリングの一時的な無効化

ビューとフィールドのフィルターの開発を支援するために、ビューのメインリストと文書上の両方のフィルターにおいて、メインのエクスポートヘッダーバーでShiftキーを押しながらダブルクリックすると、オン/オフのトグル設定が可能です。この機能はconfig.jsの保存やアプリケーションを再ロードせずに、フィルターを変更するときに使用できる全てのフィールドの一覧をリスト表示させるのに役立ちます。