Archive

Archive for the ‘Documentation’ Category

New Online Documentation Release: R17

December 4, 2012 Leave a comment

New Online Documentation Release: R17

A new version (R17) of the product documentation was released!

This new version includes:

Additions:

    • New articles:
      • About Producers
      • Automatic Traces Producer
      • ASP.NET Web Site Producer V2

Updates:

  • Entire “Generating” chapter was updated to match how producers are named and organized in the Modeler,
  • Extra “See also” links on most of producer pages

As well as miscellaneous corrections as usual Smile

Interested in some extra articles?
Comment this post and let us what you’d like to see in the next release!

Categories: Documentation Tags:

New Online Documentation Release: R16

November 13, 2012 2 comments

A new version (R16) of the product documentation was released!

This new version includes:

Additions:

  • New articles:
    • MySQL Producer
    • PostgreSQL Producer
    • Importers: Configration parameters
    • Importing from MySQL
    • Importing from PostgreSQL
    • Importing from SQLite
    • Working with an existing database

Updates:

  • CodeFluent Entities
  • Introducing CodeFluent Entities
  • Migration and interoperability
  • Importing an existing database or model
  • Importing from Microsoft SQL Server
  • Importing from Microsoft SQL Server CE
  • Importing from Microsoft Access
  • Importing from Oracle Database
  • Importing from OLEDB
  • Importing from ADO.NET Entity Framework
  • Importing from Enterprise Architect
  • Importing from UML (XMI)

As well as miscellaneous corrections as usual Smile

Interested in some extra articles?
Comment this post and let us know what you’d like to see in the next release!

Categories: Documentation Tags:

New Online Documentation Release: R15

November 23, 2011 Leave a comment

A new version (R15) of the product documentation was released!

This new version includes:

Additions:

Updates:

  • Blob Cache

As well as miscellaneous corrections

Interested in some extra articles? Comment this post and tell us what you’d like to see in the next release!

PS: if you receive 404 errors or if the TOC don’t show when browsing this new documentation version, please reset your browser cache.

New Online Documentation Release: R12

September 20, 2011 Leave a comment

A new version (R12) of the product documentation was released!

This new version includes:

Additions:

  • New technical articles:
    • Generating Mobile-Enabled WCF Services Using CodeFluent Entities
    • Consuming Generated WCF Services in Android
    • Consuming Generated WCF Services in Windows Phone
    • Consuming Generated WCF Services in iOS
    • Creating A WPF Smart Client With Authentication Using CodeFluent Entities
    • Windows Workflow Foundation 4 and CodeFluent Entities
  • New tutorial:
    • Using the WPF Smart Client Producer
  • New article:
    • Hosting WCF Services

Updates:

  • Generating Text Files
  • Developing A Smart Client
  • Developing .NET Applications With Oracle Database
  • Importers articles
  • Developing Silverlight applications

As well as miscellaneous corrections and a new look :)

Interested in some extra articles? Comment this post and tell us what you’d like to see in the next release!

PS: if you receive 404 errors or if the TOC don’t show when browsing this new documentation version, please reset your browser cache.

New Online Documentation Release: R11


A new version (R11) of the product documentation was released!

This new version includes:

Interested in some extra articles? Comment this post and tell us what you’d like to see in the next release!

Generating Documentation

April 26, 2011 Leave a comment

CodeFluent Entities provides a documentation sub-producer which allows you to:

  • Decorate all members with XML comments (usable by Visual Studio IntelliSense and help tools),
  • Generate XML, batch and configuration files to create a .CHM documentation using Sandcastle.

To benefit from it, you first need to add an instance of the sub-producer. To do so, select the Business Object Model Producer instance of your project, right-click on it and select “Add New SubProducer”. Then in the “Add New SubProducer” dialog, select “Documentation” in the tree view and configure it:

DocumentationProducer

Note: the only required property is the “Sandcastle Target Directory “which needs to be specified so the producer knows where to generate its output files. If producing Sandcastle files, you need to have Sandcastle installed before generating and ensure the Sandcastle path is correct so you’ll be able to use the generated files right away.

Since decorating all members of all your generated classes all the time can be quite an overkill during developments, it is disabled by default in the Business Object Model producer, so you need to enable it as well. Double-click on your Business Object Model producer instance to open its configuration and set “Generate Xml Documentation” to “True”:

GenerateDocumentation

In the XML this looks like something like that:

<cf:producer typeName="CodeFluent.Producers.CodeDom.CodeDomProducer, CodeFluent.Producers.CodeDom">
  <cf:configuration targetDirectory="..\Sample" outputName="{0}.dll" generateDocumentation="true">
    <subProducer typeName="CodeFluent.Producers.Documentation.DocumentationProducer, CodeFluent.Producers.Documentation"
                 targetDirectory="..\Doc" sourceDirectory="%CF_TEMPLATES_PATH%\Documentation" />
  </cf:configuration>
</cf:producer>

Build over your project and you’ll see that all your members have XML remarks on them! Moreover, in the Sandcastle Target Directory you specified, you’ll see a set of files allowing you to generate a .CHM file documenting the generated objet model Smile

New Online Documentation Release: R10

March 17, 2011 Leave a comment

A new version (R10) of CodeFluent Entities’ documentation was released: http://www.codefluententities.com/documentation/

Extra technical articles were added:

Increased documentation on Search methods, and Array Parameters since CFQL now supports SQL Server 2008’s Table-Valued Types.

The CodeFluent Entities “Pattern” concept was renamed as “Aspect” to avoid confusion.

Documentation on producers was polished and new producer documentation articles were introduced, such as:

Talking about Azure, developers can now configure their application to use Windows Azure Blob Storage to store their blobs instead of storing them in database, and this was documented in a new article as well: Windows Azure Blob Storage.

Categories: Documentation

New CodeFluent Entities Discover WebSite

November 12, 2010 Leave a comment

We just published a new web site to discover and learn CodeFluent Entities: http://2011.codefluententities.com/

Don’t hesitate to share this link with your friends, colleagues, and anybody that whishes to become a .NET application developer with a very short learning curve! This web site will be merged in the next version of our product website in about 3 months.

We hope that this new site will guide you through the discovery of CodeFluent Entities and will help you understand the product in a short timeframe.

Please share your feedbacks!

Omid.

Categories: Documentation, News

New Documentation Version Online!

November 5, 2010 Leave a comment

A new version of the CodeFluent Entities Online Documentation was just released!

The technical documentation is divided into several sections:

  • The Introducing CodeFluent Entities section, as the name suggests, is a basic overview introducing the product,
  • The Development Tools section provides information on each of the tools provided with CodeFluent Entities,
  • The Architect Guide section contains detailed information of all CodeFluent Entities concepts (Entities, Properties, Rules, Producers, etc.) you’ll need to design your application,
  • The Developer Guide section provides practical information, so developers can implement specific features such as localization, paging, sorting and many more!
  • The Reference Guide section contains an exhaustive list of elements and their attributes available in the product,
  • The Tutorials section contains step by step examples to create applications using CodeFluent Entities,
  • The Technical Articles section contains technical articles related to the product,
  • The White Papers section contains official SoftFluent white papers.

In this new release, most of the new content is “getting started” articles to help you kick off application developments using CodeFluent Entities.

Here’s a list of the major new articles in each of their respective documentation section:

  • In the Tutorials section
    • Using the Core Edition
      • Developing Desktop Applications
      • Developing ASP.NET Applications
      • Developing Silverlight Applications
      • Integrating Microsoft Office
    • Using the Modeler Edition
      • Developing Desktop Applications
      • Developing ASP.NET Applications

Hope this helps,

CodeFluent R&D Team

Categories: Documentation

Generate a documentation of your model using CodeFluent API

August 13, 2009 Leave a comment

As a CodeFluent Entities architect, you may wonder how you could generate a human readable document of your model without having to write it manually. The answer is to use the CodeFluent template engine. This article gives you some basic understanding of how to write a template to generate a Rich Text File document (containing formatting, logo, etc) and also provide a ready to use template that you can customize according to your own needs.

All projects developed with CodeFluent Entities are based on models. A model is always composed of a set of entities. These entities contain properties, methods, rules, etc. In order to provide to people outside of the development team, an explanation of the CodeFluent model in a formatted document could be appreciated. To generate this document, a developer can use the template associated with this article. Nevertheless, the CodeFluent Entities model must be enriched with the desired documentation using CodeFluent Entities Messages with a dedicated attribute. This attribute is available at entity, property and method levels. Here’s a simplified sample model:

<cf:entity name="Customer">
  <cf:message class="_doc">Simple customer</cf:message>
  <cf:property name="Id">
    <cf:message class="_doc">Technical identifier</cf:message>
  </cf:property>
  <cf:property name="Phone">
    <cf:message class="_doc">Phone number of the customer</cf:message>
  </cf:property>
  <cf:method name="LoadByPhoneNumber" body="load(Phone) where Phone = @Phone">
    <cf:message class="_doc">Load customer by phone number</cf:message>
  </cf:method>
</cf:entity>

By the way, after generation, the properties and methods of the generated business object layer (BOM) will contain new tags in standard .NET format as illustrated hereafter:

Entity level

/// Customer entity
public partial class Customer

Property level

/// Phone number of the customer
public string Phone
{
  get { return this._phone; }
  set
  {
    this._phone = value;
    this.EntityState = CodeFluent.Runtime.CodeFluentEntityState.Modified;
    this.OnPropertyChanged(new System.ComponentModel.PropertyChangedEventArgs(“Phone”));
  }
}

Method level

/// Load customer by phone number
public static System.Data.IDataReader PageDataLoadByPhoneNumber(CodeFluent.Runtime.PageOptions pageOptions, string phone)

Using CodeFluent Entities’ template engine, we developed a template to generate a full documentation. Note that the CodeFluent Entities Template Producer supports text files format such as RTF files. To describe our example, we created a RTF file named [Template]Model documentation.rtf with Microsoft Word. We then edited our template and added some code using CodeFluent Entities API.

Let’s quickly describe the template inside:

  • First, retrieve all entities of the model:
    CultureInfo currentCulture = new CultureInfo(1033);
    Message messageGlobal = entity.GetMessage(“_doc”, currentCulture);
  • And do the same for methods and properties:
    CultureInfo culture = new CultureInfo(1033);
    IList properties = new List();
    IList methods = new List();
    
    foreach (Property property in entity.Properties)
    {
      Message messageProperty = property.GetMessage(“_doc”, currentCulture);
      if (messageProperty != null)
        properties.Add(property);
    }
    
    foreach (Method method in entity.Methods)
    {
      Message messageMethods = method.GetMessage(“_doc”, currentCulture);
      if (messageMethods != null)
        methods.Add(method);
    }

You can notice that we use the english culture (1033) but you can localize your documentation using “cultureName” attribute inside your model. For example, if you want to translate your comment into french, proceed as follows:

<cf:message class="_doc" cultureName="fr">Entité client</cf:message>

Then, you can get the message value:

[%foreach (Property property in properties) { Message currentMessage = property.GetMessage("_doc", currentCulture);%] [%= currentMessage.Value %] [%}%]

Let’s have a look at the generated RTF document:

How to use the provided template?

Put your template file into a directory of your choice and use the “template producer” in your project in order to produce the output documentation file:

<cf:producer name="Template Producer" typeName="CodeFluent.Producers.CodeDom.TemplateProducer, CodeFluent.Producers.CodeDom">
  <configuration sourceDirectory="Templates\Doc"
         targetDirectory=".\Generated\"
         outputEncoding="iso-8859-1"/>
</cf:producer>

We hope that from now on, all your CodeFluent Entities projects will be fully documented .

This article is only a little overview of CodeFluent Entities templating mechanisms and the CodeFluent API features. You will find the sample code and the generated documentation inside the following zip code. You can find the corresponding materials here.

Antoine Diekmann – SoftFluent

Categories: Documentation, Templates
Follow

Get every new post delivered to your Inbox.

Join 49 other followers