[publican-list] Branding not applied when using --embedtoc with Publican 3.1.5

Mon May 27 22:55:55 UTC 2013

Hi, sorry for the delay in responding, I was on holidays.

On 05/21/2013 07:25 AM, James Pooton wrote:
> Thanks!  Getting closer, but still missing some resources after these new
> steps.  I decided to start fresh:
>
> - Updated to publican-3.1.5-3.fc18.noarch
> - Updated to patched FC18 builds of wkhtmltopdf packages
> - Created a new "web site" via:
>
> $ mkdir /videonext/webdocs
> $ cd /videonext/webdocs
> $ publican create_site --site_config webdocs.cfg --db_file webdocs.db
> --toc_path html/docs
>
> - Added the following to webdocs.cfg:
>
> title: "SKM Documentation"
> host: http://publican.vnf.lan
> def_lang: en-US
> web_style: 2
>
> - Tried to build Publican's "common" brand via:
>
> $ cd /usr/share/publican/Common_Content/common   (is this where it lives?)

No, you need to get the source :(

git clone git://git.fedorahosted.org/publican.git publican.git
cd publican.git/publican/datadir/Common_Content/common

I've opened a bug to address this pretty gross oversight.

https://bugzilla.redhat.com/show_bug.cgi?id=967664

> $ sudo publican build --formats=xml --langs=all --publish
>
> This error'd with:
>
> "Invalid build request: no PO files exist for language ar-SA at
> /usr/bin/publican line 921."
>
> So I limited it to english which worked:
>
> $ sudo publican build --formats=xml --langs=en-US --publish
> $ publican install_brand --web --path=/videonext/webdocs/html/docs

You need to put it in a brand dir, not in the doc root.

$ mkdir /videonext/webdocs/html/docs/common
$ publican install_brand --web --path=/videonext/webdocs/html/docs/common

> - Repeated the same with our brand:
>
> $ cd /videonext/doc-3.7.0/brands/publican-videoNEXT
> $ publican build --formats=xml --langs=en-US --publish
> $ publican install_brand --web --path=/videonext/webdocs/html/docs

$ mkdir /videonext/webdocs/html/docs/videoNEXT
$ publican install_brand --web --path=/videonext/webdocs/html/docs/videoNEXT

> - Updated the web site:
>
> $ publican update_site --site_config /videonext/webdocs/webdocs.cfg
>
> - Built and added our "home page" article and a sample book template (that
> uses videoNEXT brand):
>
> $ cd /videonext/doc-3.7.0/documents/Home_Page
> $ publican clean
> $ publican build --publish --formats=html-single --embedtoc --langs=en-US
> $ publican install_book --site_config /videonext/webdocs/webdocs.cfg --lang
> en-US
> $ publican update_site --site_config /videonext/webdocs/webdocs.cfg
>
> $ cd /videonext/doc-3.7.0/templates/videoNEXT_Template
> $ publican clean
> $ publican build --publish --formats html,pdf,epub --embedtoc --langs=all
> $ publican install_book --site_config /videonext/webdocs/webdocs.cfg --lang
> en-US
> $ publican update_site --site_config /videonext/webdocs/webdocs.cfg
>
>
> At this point the web site home page is "visible" (and style 2 is nicer ;)
> ), although there are still a variety of 404's keeping it from being usable:
>
> /videoNEXT/en-US/images/title_logo.svg
> /videoNEXT/en-US/images/image_left.png
> /videoNEXT/en-US/images/image_right.png
> /videoNEXT/en-US/css/menu.css
> /common/en-US/css/menu.css
> /en-US/carousel.html
> /en-US/toc.html
> /common.css
> /overrides.css
> /lang.css
> ...
>
> I'm assuming the "install_brand --web" steps aren't working for me and
> should be responsible for bringing in the /common/* and /videoNEXT/* brand
> items.  However, when I run those commands, brand-named subdirectories are
> never created under my web doc root.
>
> Sorry this is got so long, but I'm hoping there is some error in what I'm
> doing. Any hints or pointers as to where the process is failing me would be
> greatly appreciated.
>
> Thanks...
>
>
> On Thu, May 16, 2013 at 7:27 PM, Jeff Fearn <jfearn at redhat.com> wrote:
>
>> On 05/17/2013 11:08 AM, James Pooton wrote:
>>
>>> On Thu, May 16, 2013 at 4:55 PM, Jeff Fearn <jfearn at redhat.com> wrote:
>>>
>>>>
>>>>
>>>> --embedtoc basically means "build this to use in a publican web site".
>>>> The
>>>> website contains the missing content. It's done this way so that you can
>>>> change the style on a web site without having to rebuild every book or
>>>> replace a mass of files.
>>>>
>>>> http://jfearn.fedorapeople.****org/en-US/Publican/3.0/html/**
>>>> Users_Guide/sect-Users_Guide-****Website.html
>>>>
>>>> <http://jfearn.fedorapeople.**org/en-US/Publican/3.0/html/**
>>>> Users_Guide/sect-Users_Guide-**Website.html<http://jfearn.fedorapeople.org/en-US/Publican/3.0/html/Users_Guide/sect-Users_Guide-Website.html>
>>>>>
>>>>
>>>
>>>
>>> That's actually the page I was working through. :)  I guess my question is
>>> this.  That doc states:
>>>
>>> "The Publican-generated home page is the localizable page to which
>>> visitors
>>> are directed by the site JavaScript and which **provides the style** for
>>> the website structure."
>>>
>>> So I created a home page article per the directions, adding "web_type:
>>> home" and "brand: videoNEXT" to its publican.cfg.  However, when building
>>> it for install, instructions ask for the following:
>>>
>>> publican build --publish --formats html-single --embedtoc --langs all
>>>
>>> Which results in HTML without any brand/style content applied, apparently
>>> because of the --embedtoc.(?)  So installing this into the website doesn't
>>> seem to bring with our brand/style information.  I'm sure I'm missing
>>> something simple here, but what part of the process supplies the
>>> brand/style css and (common_content) images to the web doc root?  I was
>>> assuming it came with the home page article, or is it supposed to be
>>> manually gathered?
>>>
>>> To be clear, after going through the process of create_site, adding a home
>>> page article, and one other book. (both added to the web site). I can see
>>> the "content" from the home page and book doc when browsing, but there are
>>> lots of 404s as you'll see below:
>>>
>>> /common/en-US/css/menu.css
>>> /videoNEXT/en-US/css/menu.css
>>> /en-US/labels.js
>>> /footer.html
>>> /videoNEXT/en-US/images/image_**left.png
>>> /videoNEXT/en-US/images/image_**right.png
>>> /en-US/images/web_logo.png
>>> /common.css
>>> /overrides.css
>>> /lang.css
>>>
>>
>> Gah! Looks like some steps are missing for changes introduced in 3.1.
>>
>> RPM sites:
>>
>> $ yum install publican-web publican-$brand-web
>> $ publican update_site
>>
>>
>> For manual sites:
>>
>> $ cd $brandsrc_dir (yes including the common brand in the publican source
>>> _<)
>> $ publican build --formats=xml --langs=all --publish    # brands don't use
>> embedtoc
>> $ publican install_brand --web --path=$path_to_site_root_dir
>> # repeat for all brands
>> $ publican update_site --site_config $path_to_site_cfg
>>
>> You might want to try setting web_style in your site cfg to 2 and run
>> update_site for a different look. This is also not in the PUG but is
>> documented in 'publican help_config'.
>>
>> $ publican help_config | grep -A3 web_style
>>          web_style:
>>                  Splash pages should be generated to be compatible with
>> this web style. Valid values are 1 and 2.
>>                  Default: 1
>>                  Constraint: [1-2]
>>
>> Which is actually a pretty sad description given '2' is an entirely
>> different web layout :-(
>>
>> Cheers, Jeff
>>
>> .
>> --
>> Jeff Fearn <jfearn at redhat.com>
>> Senior Software Engineer
>> Infrastructure Engineering & Development (AEU)
>> Red Hat Asia Pacific Pty Ltd
>> GPG: 0x0357E8F0
>>
>> ______________________________**_________________
>> publican-list mailing list
>> publican-list at redhat.com
>> https://www.redhat.com/**mailman/listinfo/publican-list<https://www.redhat.com/mailman/listinfo/publican-list>
>> Wiki: https://fedorahosted.org/**publican<https://fedorahosted.org/publican>
>>
>
>
>
>
>
> _______________________________________________
> publican-list mailing list
> publican-list at redhat.com
> https://www.redhat.com/mailman/listinfo/publican-list
> Wiki: https://fedorahosted.org/publican
>

-- 
Jeff Fearn <jfearn at redhat.com>
Senior Software Engineer
Infrastructure Engineering & Development (AEU)
Red Hat Asia Pacific Pty Ltd
GPG: 0x0357E8F0