This SOP is dedicated to the process of updating L4 content based on different types of changes that can be caused by multiple reasons. In addition, this SOP outlines the formatting rules and assets requirements. It also explains the process of the content import to WordPress.
L4 products gsheet is a very important document, as information in the gsheet is uploaded directly to the website. Therefore, formatting of the gsheet must be done carefully and accurately, it is not acceptable to make any formatting mistakes. If formatting is not done correctly, the script that transforms the gsheet into website pages will not recognize the content, or will display the content in the wrong way.
All the product pages on the Website must follow certain formatting rules.
In the editing popup check the field “Text” to make sure it contains only the word(s) where the link is supposed to be applied to, and there are no extra spaces/commas/colons/letters of other words.
If the “Text” field is not correct, then edit it and click “Apply”. If the change was made, check the content of the cell and edit to add the symbols or letters that were removed outside of the link.
Links inside of the cells need to be applied only to the words that are to be links on the website. If the Link is not attached properly then once the product is uploaded on the website the link will also be visibly attached to the wrong text or symbols.
Applying the link to extra spaces or letter might cause an error during the import process.
Images that are used on the website can be prepared or revised along with the rest of the content for the website. Images are prepared by the Marketing Designer and usually take quite some time, therefore any task for images revisions or preparations needs to be sent to Marketing Designer in advance, at the same time as Content Editors work on content revisions or creation.
All the detailed requirements for images format, contents and file names must be prepared by the Content Editor and included in the task description sent to the Marketing Designer.
There are a few requirements for the images assets preparation and revision.
NOTE: For any new type of images (new product form or range, new elements on the images, new Product Specifications images, etc.) it is advisable totest uploading the images in the Dev environment to ensure that the final image displays on the website well
The file server contains only the images in English. Spanish and French have unique images which are created automatically as copies of English images during the import process. The file names in ES/FR are created through Dictionaries translations of EN file names.
The process of updating English content is different, depending on whether there is new products creation involved, or existing products content needs to be revised. Most of the cases content updates are related to changing existing products content, and the process of updating existing products is much simpler.
The overall rules of L4 content creation follows the general guidelines of creation of any type of content that needs to be posted online.
NOTE: both of the above changes will add a significant amount of time to the already lengthy process of creation and upload of the new content to the website.
NOTE: Test assignments should not be included in the main content gsheets. Main content gsheets access should never be shared externally with any potential copywriter. Only the final copywriter selected for the project can be shared access to the content gsheet of the range that is being worked on.
NOTE: When providing access to content gsheets make sure to lock any cells or tabs that are not for editing. Copywriter should NEVER change, copy/paste or edit the existing content in the content gsheets. Any mistakes or unnecessary changes of the content are unacceptable. Marketing Person takes full responsibility for the integrity of the content gsheets before and after access is provided to the copywriter(s).
Content revisions imply that existing products content needs to be updated due to following possible reasons:
Based on possible reasons there are the following types of revisions:
The detailed process of updating the gsheet according to each revision type is described below.
Product Name revision is the biggest change in the product page content and requires a series of changes in the EN content gsheet and other documents.
Once the new product name is identified based on conducted Keyword Research, the following steps need to be taken:
To change the URL of a product, add one more row under the “LINK” row, and add the new URL in the new row under the old URL. Do not make any changes to the old URL. The result should look like this:
Once the new URL is set, when running the import process the script will print all the required redirects in the log. Content Editor must then set the redirect according to all listed changed URLs in the Redirections plugin. Detailed process of setting new redirections using the Redirections plugin is described in “Handling Redirections” SOP.
The types of changes required for Attribute might include the following:
Pre-defined or default Attribute Types can be manually changed by manually assigning another attribute type to an attribute name in the gsheet, following the format:
Attribute Name: Attribute Type
For example, “Packaging: Simple”, “Dosage: Text”, “Dosage: Selector”, “Composition: Composition”.
Attribute Types must be changed according to the need of each specific field’s values. For example, if there are too many values for the Dosage field (6 or more), or if each of the values is too long. This is decided based on what will look good on the website. Or if there is only one value and it is long, then Dosage needs to be manually adjusted to Text.
Indication pages links are the links to pages which sort the products by their indicated use. There are several types of Indications based on the product range:
This code is added to a separate cell right under the title of the section.
For example, the page of “Acetylsalicylic Acid Tablets” needs to be connected to 2 indication pages, which are Therapeutic Classes - Analgesics and Anti-inflammatory. In this case, the format in the gsheet will be the following:
Indication: Therapeutic Class
analgesics: Analgesic
anti-inflammatory: Anti-inflammatory
If there are multiple indications that apply to one product (for example, Veterinary range products have both Therapeutic Class pages and Target Species pages connected), then the next Indication name should be added to the next cell separately.
For example, the page of “Atropine Sulfate Injection” needs to be connected to 1 Therapeutic Class page, which is Alimentary Tract and Metabolism, and 2 Target Species pages, which are Cats and Dogs. In this case, the format in the gsheet will be the following:
Indication: Therapeutic Class
digestive-metabolic-drugs-for-dogs-cows-horses: Alimentary Tract and Metabolism
Indication: Target Species
veterinary-medicine-for-cats: Cat veterinary-medicine-for-dogs: Dog
There are several types of changes associated with Indication pages connected to a product:
Before assigning different Sections Order, Content Editor must make sure to compute the new Desktop and Mobile order for the selected products, and identify only the value(s) that will differ from the default. For example, if only Mobile order of a specific section needs to be different, then only Mobile order needs to be set in the gsheet. At the same time, it is important to understand that changing the setting of one section on the page will likely require changes of other sections in the same page, as they might become in conflict with each other.
Once the new order is identified and other sections order is considered, the following revision can be made in the gsheet:
In the example above, on “Bee Pollen Capsules” product page the default values of Uses section are overwritten: instead of Uses section being on the Left it is set to be on the right in Desktop, and instead of having Desktop order 50, it is set to be 80 for this page.
As this change has affected other sections, Ingredients section Desktop order has also been changed from default, and set to 50 for this product:
Changing or adding more text to a paragraph is generally easy as it is simple text edition in the corresponding cell. However, it is important to note that some sections have very specific formatting that needs to be followed strictly. Below is the list of sections and their formatting requirements.
The above sections are using subtitles in the text, which are H3 in the page structure. To indicate which text needs to be a subtitle (H3) to the script, the character “#” is used in the beginning of the subtitle in the gsheet. So the format of a subtitle is the following:#Subtitle Name
For example, in Uses each question (usually at least 3 questions in the content of the section) will start with # character. For example:#What is Acetylsalicylic Acid used for?
The same subtitle structure is followed for sections using “Accordion” Paragraph Type, such as “FAQs” and “Composition” sections, and any other section that needs to have subtitles as H3:
Many sections in the gsheet use bullet points. The bullet points should be the standard bullet points that can be added to the gsheet by copying the symbol “•”. This symbol will be used by the script to transform into the relevant html structure (<ul><li> structure) which will be displayed on the website.
NOTE: Bullet points symbol in the gsheet
must NOT
contain any extra formatting, e.g. no boldness, italic, links attached to the symbol “•” itself. If this situation occurs, the html will not be applied correctly and will result in an error message during the import process.
“Product Specifications” section applies mostly to the Medical Devices range. Depending on the amount of content and whether this section needs to have additional images for each specification, it can use one of the 3 Paragraph Types, and will have specific formatting rules.
“Product Specifications” with Paragraph Type “All Visible”
“Product Specifications” with Paragraph Type “All Visible” is marked in the gsheet as “Simple (no specs)” in the row “MED DEVICES LAYOUT DESIGN”. This paragraph type is used for the “Product Specifications” section when there are not many specifications, and not much text explaining each specification.
When “Product Specifications” section has Paragraph Type “All Visible”, each specification needs to be an H3 subtitle, marked in the ghsheet with “#” symbol. Each specification with H3 subtitle needs to start in a new cell. For example:
In the example above, “Components” and “Material” are 2 different specifications of “EVA Infusion Bag”, therefore these subtitles start with “#” symbol and are split into 2 different cells
It is not mandatory to split each subtitle into its own cell, however, it is more convenient for Medical Devices range as it allows you to see each specification easily, considering the same gsheet has products with different paragraph types.
Another possible case when using paragraph type “All Visible” for Medical Devices, is when each specification has more than one option. In this case, the content describes each option, and each option is highlighted in the content in bold.
In the above example, specification “Type” is a subtitle H3, and contains 2 options in the content which are highlighted in bold: “Distal Male Luer Lock Connector” and “Octagonal Distal Male Luer Lock Connector”.
“Product Specifications” with Paragraph Type “Accordion”
“Product Specifications” with Paragraph Type “Accordion” is marked in the gsheet as “Multi Specs (no img)” layout design. The formatting rules of this section with this paragraph type are similar to “All Visible” paragraph type. Each specification will have a subtitle H3 that starts with symbol “#”, and each specification will start from a new cell. Inside each specification, every options will be highlighted in bold.
It is clear to see from the example above that the formatting looks the same as for “All Visible” paragraph type. The only difference is how the content will be displayed on the website, as “Accordion” paragraph type will hide the content under second and further specifications under the title. This paragraph type is used when there is a lot of content for each specification or when there are a lot of specifications options, to avoid the page becoming too long.
“Product Specifications” with Paragraph Type “Specification”
“Product Specifications” with Paragraph Type “Specification” is marked in the gsheet as “Multi Specs (with img)” layout design. This paragraph type is used when it is needed to add images to each product specification.
The structure of content for “Specification” paragraph type implies that each specification has multiple options, and each option needs to have an image for better visual representation of the specification. Each specification becomes a “Group” of options, and each option becomes its own subtitle H3.
“Groups” are displayed on the website as buttons:
In the example above, “Type” and “Needle Holder” are specification groups. “Pen Type” and “Single Wing” are options inside the “Type” group, and each one of them has an image.
In the gsheet, the above structure is reflected with the help of “Group: Type” and “Group: Needle Holder” inside the “Product Specifications” section. As the “Type” group comes first, it is placed in its own cell right under the “Product Specifications” section title. The subtitle H3 “Pen Type” and “Single Wing” will be placed in their own cells.
Images which belong to each of the options are added to the gsheet in the form of subsequent 2 cells containing the filename and image Alt tag.
Image filename contains the filename according to the filename of the image saved in Drive. If the filename in the gsheet doesn’t match with the filename in Drive, the image won’t be displayed on the website.
Alt tag must contain the word “Alt:” with the colon prior to the alt text, otherwise the Alt tag will not be recognized by the script. Alt tags are extremely important for SEO, each image must contain an Alt tag.
In some cases the images are not needed for every group, so the cells for images are left blank, keeping the rest of the format the same.
To add a new external or internal link inside of the paragraph, select the text to which the link will apply to and click “Insert Link (Ctrl+K)” icon:
Inside of the link popup enter the URL, and click Apply.
While above process is very simple, it is important to note that there have been a lot of cases of wrongly applied links. Wrongly applied links are not acceptable, Content Editor must be aware of the requirement to apply the links correctly and check to make sure that the link is applied to the correct characters.
If the link is not applied to the correct characters (for example, the link is applied to spaces or parts of other words instead of only the needed word, etc.), this will result in the link displaying in the wrong way on the website, and potential errors during the import process.
To check which characters the link is applied to, click on the link inside the cell and in the link popup press “Edit Link” icon.
In the editing popup check the field “Text” to make sure it contains only the word(s) where the link is supposed to be applied to, and there are no extra spaces/commas/colons/letters of other words.
Links inside of the cells need to be applied only to the words that are to be links on the website.
Active Ingredients subsection is simple text which only needs to be separated from the rest of the text inside the “What is…” section by a separate line and making the word “Active Ingredients” bold. To make this text bold the html tag
is added to the content.
The format of this subsection is the following:
<strong>Active Ingredients:</strong> XX
For example, for the product “Acetylsalicylic Acid Tablets” Active Ingredients subsection will be the following: <strong>Active Ingredients:</strong> Acetylsalicylic Acid
For any other revisions in the gsheet follow the format of other products and other cells. The Content Editor must always be mindful of the format. It is not acceptable to brainlessly edit the text in the gsheet without understanding basic English grammar and punctuation rules, as well as formatting requirements described in this SOP.
It is also not acceptable to mistakenly edit or delete any content. Copywriters must not overwrite the existing gsheet when adding new content. The gsheet must be locked from editing from everyone except the Editors. People who do not know how to use gsheets should not have editing rights.
French/Spanish Dictionaries are updated automatically once the import process is started, once the import script has been launched it will check for any new untranslated content and add as new rows to the Dictionaries, in the very bottom. New translations will be added with the date and time of when the script is run. The import will end with an error every time there are newly added translations in the Dictionaries, for the Content Editor to be able to review and revise them.
When content revisions of EN are not major, for example only several products' content has been updated, Content Editor must review every single new row in the Dictionaries. Translations to ES/FR must be consistent with formatting rules, old content in the live website, and must be correct and make sense.
Note: If the Content Editor does not know the languages, it does not mean that ES/FR translations can be ignored or overlooked. Even without the knowledge of Spanish and French it is possible to see the wrong or inconsistent translations.
This section consists of 2 parts which describe the types of revisions that need to be done for every Dictionary update. Both of these types of revisions are mandatory:
Therefore, the Content Editor must look at the translations in 2 different ways: filtering and sorting the content based on formulas and patterns of ChatGPT, and filtering and sorting translations based on content type, as some content types have priority over the others. Both ways are equally important.
It is important to note that ChatGPT translation has certain limitations. ChatGPT translates the content following the general prompt that applies to all Dictionaries of all ranges.
When checking new translations in the Dictionaries Content Editor must consider the following:
When content revisions of EN are major, Content Editor does not have to check every single new row, however, he/she needs to understand the above patterns of ChatGPT behavior and check specifically for those patterns and any other noticeable pattern.
To identify the issues and revise the content in bulk Content Editor must use the following tools:
NOTE: in the end, regardless of the amount of new translations, all the possible ChatGPT issues described in this section MUST be checked and revised. The content in ES/FR uploaded to the website must be clean, correct and follow the established format.
In addition to cleaning up the translations based on ChatGPT limitations, as described previously Content Editors must make sure that translations of most important field types are checked and revised. The format and accuracy of the content must be maintained for ES/FR translations as much as they are maintained for EN content.
The Field Types and mandatory field types revisions have been described in the Dictionaries Overview section of “L4 Gsheet Management SOP”.
NOTE: in the end, regardless of the amount of new translations, all the possible ChatGPT issues described in this section MUST be checked and revised. The content in ES/FR uploaded to the website must be clean, correct and follow the established format.
The import process of the L4 content to the website is automated. Once the EN content revisions are completed, Content Editor or Marketing Manager can start the import process, which is initiated through the separate document:
Z:\Shared drives\Website Projects\AC - advacarepharma.com\Version 4 (2022)\Design Phase\5. Content
→ Build Website
Open the gsheet from the path above, click “Build Website” on top of the screen, and then “Start Import”. The builder will request authorization, click “OK”. Once the script starts running, a new tab will be created in the gsheet with the log of the import. The tab name follows the format of “date_time”, based on the GST timezone.
The script will run the following sequence of the steps:
Once the import process is completed, the Content Editor must review the updated content on the website (in all 3 languages) to make sure that everything is updated correctly. If something is not correct or there is a mistake, make the required changes in the content and run the import process again.
The gsheets used for uploading EN product information on the website are saved in the Drive in each range folder:
Z:\Shared drives\Website Projects\AC - advacarepharma.com\Version 4 (2022)\Design Phase\5. Content
Header column refers to the first column in the gsheet, which contains the titles of each row.
Header column is the most important part of the gsheet, which allows the script to understand what information to put where on the page, or in other words, each header in the gsheet correlates with the relevant fields in WordPress.
Therefore,
the names of rows in the header column should never be edited.
If the header column is edited then the script will not connect the information in the cells with the correct WordPress fields.
The list of headers:
Attributes are specific characteristics or features of a product that provide additional information about its qualities, specifications, or properties. Product attributes help describe and differentiate one product from another, allowing customers to make informed purchasing decisions. For Pharmaceutical products, the most common attributes are Dosage and Packaging.
Attributes are displayed on top of each product page under the Product Description in the same order as how they are placed in the gsheet.
Attribute Types are types of the field that includes options of each Attribute. For example, in the image above the “Dosage” attribute has 5 options, or 5 values, which are displayed in the form of buttons. At the same time, “Packaging” attribute is displayed in the form of a dropdown.
The website has 5 different Attribute Types:
Some Attribute Types are predefined according to the structure of attribute values. The predefined Attribute Types means that by default a certain attribute with a certain name will have a certain attribute type. For example, “Dosage” attribute has default attribute type “Simple”, because most of the products’ dosages have multiple values with short text, which should be displayed in the form of buttons.
Below is the list of default attribute types:
Sometimes the product specifications have interdependencies, when only some options of one specification can be combined with some options of another specification. In other words, when not all combinations of options under different specifications exist.
Supplements range has some interdependencies between the product forms and compositions, when a certain composition can only fit into a tablet form, and another composition can be suitable for both tablet and capsule forms.
Medical Devices range has a lot of different attributes due to the complexity of the product specifications of Medical Devices, and many of them have interdependencies.
For example, Rapid Test Kits (such as Covid-19 Test Kits) might have different Types and the Specimen will depend on the Type selected. Covid-19 Antibody test kit has Whole Blood/Serum/Plasma specimen, and Covid-19 Antigen test kit has Nasopharyngeal or Saliva specimen.
For such cases, the website must not let the user combine the specifications which should not be combined. To let the website display the specifications correctly, attributes are combined in “Groups”.
“Groups” functionality means that every option of one specification is assigned with a relevant group, which then is applied to the options of another specification to indicate that they need to be dependent.
To assign a group for each option of the first specification the following code is used in the gsheet:
[Group Name] => [Option Details]
For example, to assign a group to Covid-19 Antibody option of Type specification, the group “Antibody” will be added to the option:
Antibody => COVID-19 Antibody Test Kit
Where “Anitbody” is the name of the group, and “COVID-19 Antibody Test Kit” is the text of the option.
Similarly, second option of Type specification, “Covid-19 Antigen Test Kit” is assigned with the group “Antigen”:Antigen => COVID-19 Antigen Test Kit
After the groups are assigned to the first specification, the same groups need to be assigned to all other attributes of the product to combine the specifications options that work with these groups.
There are 2 ways to assign the defined groups to subsequent specifications:
NOTE: if there is at least one attribute that has groups assigned, then all the other attributes under the same product MUST have the groups assigned as well. If there are groups assigned to one attribute but not the rest, then the website will display all options of the rest attributes in gray as not matching with any group. The user in this case will not be able to choose all product specifications.
On the website Attribute Groups and interdependencies functionality works by graying out the options not available when a certain specification is selected:
Sections are the content blocks located under the Attributes.
Paragraph Type is the visual representation of the content block, how the block of text is displayed on the website.
There are 4 different Paragraph Types in WordPress:
All the sections on the website follow the design of one of the Paragraph Types. The decision of which Paragraph Type to use for each section depends on the content of each section.
There are 15 different content blocks by title. These content blocks are used in different ranges.
Theme Klb4 v1.2.2 was with by Lauro W. Guedes
Building with Grav flat-file CMS and based on Quark Theme