Bloom.Book.HtmlDom.SetBookSetting C# (CSharp) Method

SetBookSetting() public method

public SetBookSetting ( string key, string writingSystemId, string form ) : void
key string
writingSystemId string
form string
return void
        public void SetBookSetting(string key, string writingSystemId, string form)
        {
            var dataDiv = GetOrCreateDataDiv(RawDom);

            // Some old books may have values for this key with no language. Because GetBookSetting is coded to
            // find these, they may take precendence over the one we are setting. To prevent this, once a book
            // is updated using the new system, any obsolete no-language versions will be removed.
            XmlElement obsoleteNode =
                dataDiv.SelectSingleNode(String.Format("div[@data-book='{0}' and not(@lang)]", key)) as XmlElement;
            if(obsoleteNode != null)
                dataDiv.RemoveChild(obsoleteNode);

            XmlElement node =
                dataDiv.SelectSingleNode(String.Format("div[@data-book='{0}' and @lang='{1}']", key,
                    writingSystemId)) as XmlElement;

            if(string.IsNullOrEmpty(form))
            {
                if(null != node)
                    dataDiv.RemoveChild(node);
                return;
            }

            if(null == node)
            {
                node = RawDom.CreateElement("div");
                node.SetAttribute("data-book", key);
                node.SetAttribute("lang", writingSystemId);
            }
            SetElementFromUserStringPreservingLineBreaks(node, form);
            dataDiv.AppendChild(node);
        }

Usage Example

Example #1
0
        /// <summary>
        /// Call this when we have a new set of metadata to use. It
        /// 1) sets the bloomDataDiv with the data,
        /// 2) causes any template fields in the book to get the new values
        /// 3) updates the license image on disk
        /// </summary>
        public static void SetMetadata(Metadata metadata, HtmlDom dom, string bookFolderPath, BookData bookData,
                                       bool useOriginalCopyright)
        {
            dom.SetBookSetting("copyright", "*", ConvertNewLinesToHtmlBreaks(metadata.CopyrightNotice));
            dom.SetBookSetting("licenseUrl", "*", metadata.License.Url);
            // This is for backwards compatibility. The book may have  licenseUrl in 'en' created by an earlier version of Bloom.
            // For backwards compatibility, GetMetaData will read that if it doesn't find a '*' license first. So now that we're
            // setting a licenseUrl for '*', we must make sure the 'en' one is gone, because if we're setting a non-CC license,
            // the new URL will be empty and the '*' one will go away, possibly exposing the 'en' one to be used by mistake.
            // See BL-3166.
            dom.SetBookSetting("licenseUrl", "en", null);
            string languageUsedForDescription;

            //This part is unfortunate... the license description, which is always localized, doesn't belong in the datadiv; it
            //could instead just be generated when we update the page. However, for backwards compatibility (prior to 3.6),
            //we localize it and place it in the datadiv.
            dom.RemoveBookSetting("licenseDescription");
            var description = metadata.License.GetDescription(bookData.GetLanguagePrioritiesForLocalizedTextOnPage(), out languageUsedForDescription);

            dom.SetBookSetting("licenseDescription", languageUsedForDescription, ConvertNewLinesToHtmlBreaks(description));

            // Book may have old licenseNotes, typically in 'en'. This can certainly show up again if licenseNotes in '*' is removed,
            // and maybe anyway. Safest to remove it altogether if we are setting it using the new scheme.
            dom.RemoveBookSetting("licenseNotes");
            dom.SetBookSetting("licenseNotes", "*", ConvertNewLinesToHtmlBreaks(metadata.License.RightsStatement));

            // we could do away with licenseImage in the bloomDataDiv, since the name is always the same, but we keep it for backward compatibility
            if (metadata.License is CreativeCommonsLicense)
            {
                dom.SetBookSetting("licenseImage", "*", "license.png");
            }
            else
            {
                //CC licenses are the only ones we know how to show an image for
                dom.RemoveBookSetting("licenseImage");
            }

            UpdateDomFromDataDiv(dom, bookFolderPath, bookData, useOriginalCopyright);
        }
All Usage Examples Of Bloom.Book.HtmlDom::SetBookSetting