METHOD AND APPARATUS TO AUTHOR AND MANAGE PAGES OF A WEBSITE
Systems and methods provide a mechanism to create and maintain web pages and other types of output pages. The system and methods use an author markup language (AML) to define output pages. Additionally, a Component Markup Language (CML) may be used to define components that may be referenced by the AML. The AML and CML may be translated to an intermediate format, which may then be further processed at runtime to combine dynamic data with the intermediate format to produce the output page.
The present application is a continuation application of U.S. patent application Ser. No. 11/145,510, filed on Jun. 3, 2005, now U.S. Pat. No. 9,378,293, which claims priority to provisional U.S. Patent Application No. 60/576,978, filed on Jun. 3, 2004, the disclosures of each are hereby incorporated by reference in their entirety.
FIELDThe embodiments relate generally to web page creation and more particularly to systems and methods for authoring web pages according to a predefined schema.
BACKGROUNDSince its inception, the World-Wide Web (“Web”) has continuously grown to include literally billions of pages of information. Web pages typically comprise HTML (HyperText Markup Language) text with tags indicating how the text is to be displayed on a computer screen, typically through a web browser such as Internet Explorer, Netscape Navigator, or Mozilla Firefox.
The process of authoring HTML can be cumbersome, with a typical document requiring many tags in order to specify the desired output. Additionally, there are typically many tags to choose from. Further, errors in formatting the HTML can be hard to detect, because there is typically no validation performed for HTML.
XML (eXtensible Markup Language) and XSL (eXtensible Style Language) have been used to assist in defining web pages. However, it is still difficult to validate XML and XSL files without actually attempting to render the XML and XSL on a display screen. As a result, problems with HTML, XML and XSL are typically found later in the design process rather than earlier when it may be easier and more economical to fix them.
Additionally, an entity may desire to maintain a consistent look and feel across a set of many web pages, while also requiring the ability to insert dynamic content, that is, content that may change from one request for a page to the next request for the same page. For example, a company may desire to provide a consistent set of graphics (e.g. a company logo) across a set of the company's web pages. Each of the company's web pages typically must contain code to display the set of graphics. Later, if the company desires to change the look and feel of the website, many pages will typically need to be edited to reflect the change.
SUMMARYThe various shortcomings, disadvantages and problems above are addressed by the present invention, which will be understood by reading and studying the following specification.
Systems and methods provide a mechanism to create and maintain web pages and other types of output pages. The system and methods use an author markup language (AML) to define output pages. Additionally, a Component Markup Language (CML) may be used to define components that may be referenced by the AML. The AML and CML may be translated to an intermediate format, which may then be further processed at runtime to combine dynamic data with the intermediate format to produce the output page.
A further aspect of the systems and methods includes providing a markup language to define how text in AML and CML files may be translated.
A still further aspect of the systems and methods includes providing a markup language to define how dynamic data may be included in AML and CML files.
The present invention describes systems, methods, and computer-readable media of varying scope. In addition to the aspects and advantages of the present invention described in this summary, further aspects and advantages of the invention will become apparent by reference to the drawings and by reading the detailed description that follows.
In the following detailed description of exemplary embodiments of the invention, reference is made to the accompanying drawings which form a part hereof, and in which is shown by way of illustration specific exemplary embodiments in which the invention may be practiced. These embodiments are described in sufficient detail to enable those skilled in the art to practice the invention, and it is to be understood that other embodiments may be utilized and that logical, mechanical, electrical and other changes may be made without departing from the scope of the present invention.
Some portions of the detailed descriptions which follow are presented in terms of algorithms and symbolic representations of operations on data bits within a computer memory. These algorithmic descriptions and representations are the ways used by those skilled in the data processing arts to most effectively convey the substance of their work to others skilled in the art. An algorithm is here, and generally, conceived to be a self-consistent sequence of steps leading to a desired result. The steps are those requiring physical manipulations of physical quantities. Usually, though not necessarily, these quantities take the form of electrical or magnetic signals capable of being stored, transferred, combined, compared, and otherwise manipulated. It has proven convenient at times, principally for reasons of common usage, to refer to these signals as bits, values, elements, symbols, characters, terms, numbers, or the like. It should be borne in mind, however, that all of these and similar terms are to be associated with the appropriate physical quantities and are merely convenient labels applied to these quantities. Unless specifically stated otherwise as apparent from the following discussions, terms such as “processing” or “computing” or “calculating” or “determining” or “displaying” or the like, refer to the action and processes of a computer system, or similar computing device, that manipulates and transforms data represented as physical (e.g., electronic) quantities within the computer system's registers and memories into other data similarly represented as physical quantities within the computer system memories or registers or other such information storage, transmission or display devices.
In the Figures, the same reference number is used throughout to refer to an identical component which appears in multiple Figures. Signals and connections may be referred to by the same reference number or label, and the actual meaning will be clear from its use in the context of the description.
The description of the various embodiments is to be construed as exemplary only and does not describe every possible instance of the invention. Numerous alternatives could be implemented, using combinations of current or future technologies, which would still fall within the scope of the claims. The following detailed description is, therefore, not to be taken in a limiting sense, and the scope of the present invention is defined only by the appended claims.
Editor 102 comprises an editor that provides a user interface for reading, creating, updating and saving page markup language data 104. In some embodiments, editor 102 comprises the xmlspy editor, available from Altova, Inc. of Beverly, Mass. It is desirable in some embodiments to save files created by the editor in UTF-8 format. In general, page authors use the editor to create or edit author markup language (AML) and or a page markup language (PML) data that defines the contents of pages 104. In addition, a page designer may use the editor to browse for available components and validate the page document based on an author schema that defines the correct vocabulary for AML. Editor 102 may be used to validate the AML data according to a schema defining the AML vocabulary and grammar. In some embodiments, the AML schema is defined using XML. In some embodiments, PML may be used for sections of pages that are “one-offs” and do not refer to reusable components defined using CML 106.
Pages 104 comprise data that may be translated one or more times and displayed as output pages 122 on various types of devices such as computer systems running web browsers, email clients or other applications that display page output. Further, the pages 104 may be displayed on devices such as cell phones and PDAs. As noted above, in some embodiments, a page 104 is defined using AML or PML. AML in some embodiments is a superset of PML, and uses PML elements to define pages. In some embodiments, AML may also make references or calls to components, which are further described below. Further, AML in some embodiments provide control structures such as iteration (looping) and conditional execution that may not be available in the underlying PML. Additionally, in some embodiments, AML includes inline documentation that may be used to aid a user in designing a page 104 using AML.
Component markup language 106 defines the contents of components that may be used or referenced by an author when designing a page 104. Components may comprise pre-defined layouts that may be used on multiple pages in order to provide for consistency in page design and in order to reduce page design time by eliminating the need for each page designer to provide code for components that are used more than once. Additionally the use of components allows changes to be made across a large number of pages that refer to the component by making a change to the component itself, thereby potentially reducing the need to edit multiple AML pages 104.
A component may be referred to by its component name, and may include a set of zero or more parameters that determine the behavior of the component. In addition, a component may include a description of the functionality or behavior of the component in order to aid designer in using the component. Components designed using CML may call other components. Additionally, components may be hierarchical, i.e. a component may derive attributes and methods from a base component. Like AML, CML may be built upon PML. In some embodiments, an XML schema may be used to define the CML vocabulary and grammar.
Like AML, CML may also be validated. In some embodiments, this validation includes checking the vocabulary of the CML used to define a component and to determine that the component is “well formed”, that is, does the component comply with the syntax defined by the schema.
As noted above, both AML and CML may use PML as a building block for the respective markup language. In some embodiments, PML provides control elements such as iteration and conditional logic. In some embodiments, PML may be defined using an XML schema. In these embodiments, PML includes a subset of HTML rendering tags and text tags that may be supported for translation purposes. For example, in some embodiments, text that is translatable text has a unique attribute ‘strld’. In addition, some embodiments may map certain PML attributes to HTML attributes. For example, PML attributes styleld and styleName correspond to HTML attributes id and class, respectively. Additionally, PML attributes styleld and styleName correspond to HTML attributes id and class, respectively.
PML portions of the AML and CML languages may be validated using the PML schema.
Table 1 below provides a list of PML elements that may be used to define AML and CML constructs:
Translator 108 reads AML pages 104 and CML 106 to produce intermediate output PML 110. In some embodiments, translator 110 comprises software that replaces component calls with the instances of the components. In addition, translator 108 may also set the parameters using values from component callers. The resulting intermediate output PML 110 file is a PML document that does not have any component references.
Translator 114 reads intermediate output PML 110 to produce page XSL 116. In some embodiments, translator 114 reads a set of one or more XSL files in PML transform library 112 that transforms intermediate output PML 110 into HTML and XSL equivalent in page XSL 116. For example, elements for markup of content can be transformed into HTML, while programming constructs such as conditionals and iterations can be mapped to XSL elements. In some embodiments, the XSL script in page XSL 116 may include XSL code that processes dynamic data. In some embodiments, page XSL 116 may be deployed to a server to be used at runtime.
Translator 120 reads page XSL 116 and results doc 118 to produce output page 122. In some embodiments, results doc 118 comprises dynamic content. Dynamic content includes content that cannot be defined at build time, rather it is provided at run-time. Examples of such dynamic content include personalization data (e.g. name, address, demographic data etc.) regarding a page requestor, account balances, and other data that either differs from user to user or changes over time. The dynamic content may include parameters upon which components CML 106 and AML pages 104 use as a basis for dynamic logic defined in the AML or CML.
In some embodiments, output page 122 may be HTML that may be displayed on a web browser or in an HTML compatible electronic mail message. In alternative embodiments, translator 120 may produce an output page in a format that may be displayed on a PDA, cell phone or other device. The embodiments of the invention are not limited to a particular format for output page 122.
In some embodiments, an SML (String Markup Language) file 126 is used to control how translations are accomplished. The SML file may contain the rules and tags that define which text is translated and which text is not. In some embodiments, the SML file conforms to an XML schema. In some embodiments, an SML file 126 exists for each AML 104 or CML 106 file. In alternative embodiments, a single SML file 126 may be applied to one or more AML or CML files.
In some embodiments, dynamic PML transform library 164 comprises a set of one or more XSL files that may be read by translator 120 to transforms dynamic content PML 162 along with page XSL 116 to output page 122. In some embodiments, dynamic PML transform library 164 is a subset of PML transform library 112.
It should be noted that various embodiments may include various combinations of some or all of the elements described above in
Business logic 206 comprises software that may be used to perform functions such as updating account information, moving funds from one account to another, or paying funds from an account to a payee.
UI controller 208 serves as an entry point for a page request received from a web browser 214 through web server 212. UI controller 208 executes business logic functions 206, and in some embodiments calls XP controller 132, which coordinates the construction of dynamic results 136 and results document 118. XSL engine 120 may then read the results document 118 and page XSL file 116 to produce the output page 122. As noted above, output page 122 may be an HTML formatted file, which is then passed to the web server 212 to relay to the requesting web browser 214.
In some embodiments, web server 212 is the Apache web server. However, the embodiments of the invention are not limited to any particular web server, and those of skill in the art will appreciate that any suitable web server may be used.
In some embodiments, system 200 may include one or more batch email programs 210, an email server 216, and email clients 218. In these embodiments, dynamic content read by XP controller 132 may create output that may be used by a batch email program to generate emails with dynamic content in the same manner that dynamic content may be generated for web server 212. The emails containing the dynamic content may be processed by an email server 216 for reading by email clients 218. As noted above, output page 122 may be an HTML formatted file, which may be inserted into or formatted as an electronic mail message for processing by email server 216.
In some embodiments, email server 216 comprises the qmail email server. Those of skill in the art will appreciate that any suitable email server may be substituted for the qmail server.
In the discussion above, web servers and email servers receive output of authored AML data 104 that may include dynamic content. Those of skill in the art will appreciate that other applications and servers could be adapted to use the systems and methods described herein to include authored AML data 104 and dynamic content.
The method begins by reading a page markup language file (block 302). Typically the page markup language file will be authored and conform to an author markup language. As noted above, the AML/PML file may include references to one or more components.
Next, the system reads component markup language data (block 304). Typically the component markup language data will conform to a component markup language.
The system then translates the page markup language data and the component markup language data into an intermediate output, referred to as first output page markup language data (block 306). In some embodiments, the translation replaces references to components with instances of the component (e.g. the PML for the component) and process any parameters associated with the component.
Next, the system translates the intermediate output to page XSL data (block 308). In some embodiments, an XSL translator may be used to perform all or part of the translation. In some embodiments, the page XSL data may be deployed, that is, made available for general use as part of a web or other type of service.
Next, the system reads dynamic content and translates the page XSL data, along with the dynamic content into an output page (block 310). In some embodiments, the dynamic content may comprise a results doc that is formed by translating raw data according to an RML (Results Markup Language) specification. The output page may be formatted in various ways in varying embodiments. For example, the output page may be an HTML page for a web browser, an email message for an email server/client, or other output page for a device such as a PDA, cell phone.
It should be noted that the various AML, PML, CML and RML files may be validated (block 320) at various points in the above process. As noted above, AML may be validated while editing, or at various points before or after the translations discussed above. In addition, references in AML files to components defined in CML files, or results defined in RML files may be validated to insure that the AML data refers to valid components and results.
Additionally, validation may take place independently of the above described process. For example, a separate validation tool that validates various combinations of AML, PML, CML and RML may be applied at any time by an AML author. Further, the validation tool may be applied when the AML, PML, CML or RML is submitted to a code repository.
It should be noted that inventive concepts may exist in subsets of the actions discussed above with reference to
The following is sample AML code may be used to produce page 300:
The above AML document will finally be converted into the following excerpted XSL script that outputs XHTML with some XSL code that deals with any dynamic data present:
The exemplary computer system 500 includes a processor 502 (e.g., a central processing unit (CPU) a graphics processing unit (GPU) or both), a main memory 504 and a static memory 506, which communicate with each other via a bus 508. The computer system 500 may further include a video display unit 510 (e.g., a liquid crystal display (LCD) or a cathode ray tube (CRT)). The computer system 500 also includes an alphanumeric input device 512 (e.g., a keyboard), a cursor control device 514 (e.g., a mouse), a disk drive unit 516, a signal generation device 518 (e.g., a speaker) and a network interface device 520.
The disk drive unit 516 includes a machine-readable medium 522 on which is stored one or more sets of instructions (e.g., software 524) embodying any one or more of the methodologies or functions described herein. The software 524 may also reside, completely or at least partially, within the main memory 504 and/or within the processor 502 during execution thereof by the computer system 500, the main memory 504 and the processor 502 also constituting machine-readable media.
The software 524 may further be transmitted or received over a network 526 via the network interface device 520. The network 526may be any type of wired or wireless network and the network interface 520 may vary based on the type of network. In some embodiments, the network comprises a LAN (local area network). In alternative embodiments, the network may be a wide area network, a corporate network, or an intranet linking multiple networks. In further alternative embodiments, the network may comprise the Internet.
While the machine-readable medium 522 is shown in an exemplary embodiment to be a single medium, the term “machine-readable medium” should be taken to include a single medium or multiple media (e.g., a centralized or distributed database, and/or associated caches and servers) that store the one or more sets of instructions. The term “machine-readable medium” shall also be taken to include any medium that is capable of storing, encoding or carrying a set of instructions for execution by the machine and that cause the machine to perform any one or more of the methodologies of the present invention. The term “machine-readable medium” shall accordingly be taken to include, but not be limited to, solid-state memories and optical and magnetic media.
ConclusionThus, a method and a system to author pages, and an architecture, for a website have been described. Although the present invention has been described with reference to specific example embodiments, it will be evident that various modifications and changes may be made to these embodiments without departing from the broader spirit and scope of the invention. Accordingly, the specification and drawings are to be regarded in an illustrative rather than a restrictive sense. Many other embodiments will be apparent to those of skill in the art upon reviewing the above description. Therefore, it is manifestly intended that this invention be limited only by the following claims and equivalents thereof.
The Abstract is provided to comply with 37 C.F.R. §1.72(b) to allow the reader to quickly ascertain the nature and gist of the technical disclosure. The Abstract is submitted with the understanding that it will not be used to interpret or limit the scope or meaning of the claims.
Claims
1. A method, comprising:
- receiving a page markup language (PML) file, the PML file referencing a predefined layout that is reusable on multiple pages;
- generating an intermediate output file by translating the PML file;
- translating, at least in part using a transform library, the intermediate output file into an eXtensible Style Language (XSL) document; and
- translating, at least in part using dynamic content that is provided at a run-time, the XSL document into an output page.
2. The method of claim 1, wherein the output page is in a HyperText Markup Language (HTML) format.
3. The method of claim 1, wherein the XSL document comprises code that processes the dynamic content that cannot be defined at a build-time.
4. The method of claim 1, further comprising: defining, via a schema, a vocabulary or grammar of the PML.
5. The method of claim 4, wherein the schema comprises an XML schema.
6. The method of claim 1, wherein the generating of the intermediate output file further comprises translating component markup language (CML) data.
7. The method of claim 6, wherein the CML data contains a plurality of components defined using CML.
8. The method of claim 7, wherein the components are configured to be referenced or called via author markup language (AML).
9. The method of claim 7, wherein the components comprise pre-defined layouts.
10. The method of claim 1, further comprising: validating the PML file before the generating of the intermediate output file.
11. A system, comprising:
- a non-transitory memory; and
- one or more hardware processors coupled to the non-transitory memory and configured to read instructions from the non-transitory memory to cause the system to perform operations comprising: receiving a page markup language (PML) file, the PML file referencing a predefined layout that is reusable on multiple pages; generating an intermediate output file by translating the PML file; translating, at least in part using a transform library, the intermediate output file into an eXtensible Style Language (XSL) document; and translating, at least in part using dynamic content that is not defined at a build-time and is provided at a run-time, the XSL document into an output page that is in a HyperText Markup Language (HTML) format.
12. The system of claim 11, further comprising: defining, via a schema, a vocabulary or grammar of the PML.
13. The system of claim 11, wherein the generating of the intermediate output file further comprises translating component markup language (CML) data.
14. The system of claim 13, wherein the CML data contains a plurality of components defined using CML.
15. The system of claim 14, wherein the components are configured to be referenced or called via author markup language (AML).
16. The system of claim 14, wherein the components comprise pre-defined layouts.
17. The system of claim 11, further comprising: validating the PML file before the generating of the intermediate output file.
18. A non-transitory machine-readable medium having stored thereon machine-readable instructions executable to cause a machine to perform operations comprising:
- receiving a page markup language (PML) file, the PML file referencing a predefined layout that is reusable on multiple pages;
- receiving component markup language (CML) data;
- validating the PML file and the CML data;
- generating, after the validating, an intermediate output file by translating the PML file and the CML data;
- translating, at least in part using a transform library, the intermediate output file into an eXtensible Style Language (XSL) document; and
- translating, at least in part using dynamic content that is not defined at a build-time and is received at a run-time, the XSL document into an output page that is in a HyperText Markup Language (HTML) format.
19. The non-transitory machine-readable medium of claim 18, further comprising: defining, via a schema, a vocabulary or grammar of the PML and the CML.
20. The non-transitory machine-readable medium of claim 18, wherein:
- the CML data contains a plurality of components defined using CML;
- the components are configured to be referenced or called via author markup language (AML); and
- the components comprise pre-defined layouts.
Type: Application
Filed: Jun 13, 2016
Publication Date: Dec 15, 2016
Inventors: Peter Zhe Chu (San Jose, CA), Kenneth Chao-kang Chu (Saratoga, CA), Rajal Rasik Shah (Fremont, CA), Jun Zhang (Pleasanton, CA), Jeffrey David Meyer (Sunnyvale, CA), Ilya Alexandrovich Izrailevsky (Foster City, CA), Benjamin Gregg Listwon (Palo Alto, CA), Patrick Andre Blanc (Sunnyvale, CA)
Application Number: 15/180,156
